From 4998ed6de1d384bf0dba9fb3fd17094dbb11ebd9 Mon Sep 17 00:00:00 2001
From: atanasster <atanasster@gmail.com>
Date: Sat, 7 Mar 2020 19:56:49 -0500
Subject: [PATCH] feat: instrument options what to collect

---
 core/instrument/README.md                     | 96 +++++++++++++++++--
 core/instrument/package.json                  |  1 +
 .../instrument/src/babel/extract-component.ts | 18 ++--
 core/instrument/src/babel/follow-imports.ts   |  6 +-
 core/instrument/src/index.ts                  | 42 +++++---
 core/instrument/src/project/packageInfo.ts    | 31 +++---
 core/instrument/src/types.ts                  | 96 ++++++++++++++++++-
 .../instrument/test/extract-component.test.ts | 10 +-
 core/instrument/test/follow-imports.test.ts   |  9 +-
 core/specification/src/utility.ts             |  6 +-
 examples/storybook-5/.storybook/main.js       |  9 +-
 11 files changed, 269 insertions(+), 55 deletions(-)

diff --git a/core/instrument/README.md b/core/instrument/README.md
index 566c42e8a..8e8a82c9f 100644
--- a/core/instrument/README.md
+++ b/core/instrument/README.md
@@ -67,7 +67,7 @@ Name | Type | Description |
 
 *Defined in [core/instrument/src/types.ts](https://github.com/atanasster/component-controls/blob/ab703a5/core/instrument/src/types.ts)*
 
-### **defaultParserOptions**: ParserOptions
+### **defaultParserOptions**: *[ParserOptions](#parseroptions)*
 
 • **plugins**: *"typescript" | "jsx"[]* = ['jsx', 'typescript']
 
@@ -75,12 +75,23 @@ Name | Type | Description |
 
 ___
 
-### **defaultResolveOptions**: ResolverOptions
+### **defaultResolveOptions**: *[ResolverOptions](#resolveroptions)*
 
 • **extensions**: *string[]* = ['.js', '.jsx', '.ts', '.tsx', '.vue', '.mjs', '.es', '.es6']
 
 ___
 
+### **defaultComponentOptions**: *[ComponentOptions](#componentoptions)*
+
+• **storeSourceFile**: *boolean* = true;
+
+___
+
+### **defaultStoriesOptions**: *[StoriesOptions](#storiesoptions)*
+
+• **storeSourceFile**: *boolean* = true;
+
+___
 
 # Interfaces
 
@@ -92,13 +103,18 @@ Options that can control the parsing and instrumentation process
 
 ### Properties
  
-• **component**? : *[ComponentOptions](#componentoptions)*
+• **components**? : *[ComponentOptions](#componentoptions)*
+
+Options for extracting stories information.
+
+• **stories**? : *[StoriesOptions](#storiesoptions)*
 
 Options for extracting component information.
 
+
 • **parser**? : *[ParserOptions](#parseroptions)*
 
-Options to control the babel parser.
+Options to control babel parser.
 
 • **prettier**? : *[PrettierOptions](#prettieroptions) | false*
 
@@ -106,7 +122,7 @@ prettier options are used to prettify the code at the end of the process
 this is useful for "story" code, where the story is extracted from the full file
 passing a value of false as prettier option will disabled prettifying
 
-• **resolve**? : *[ResolverOptions](#resolveroptions)*
+• **resolver**? : *[ResolverOptions](#resolveroptions)*
 
 Options to control resolving filenames.
 
@@ -122,7 +138,37 @@ Options for extracting component information.
 
 • **resolveFile**? : *undefined | `(componentName: string, filePath: string) => string | undefined;`*
 
-Callback function toresolve the source file name of a component. 
+Callback function to resolve the source file name of a component. 
+Return false if this file should not be processed.
+
+
+• **storeSourceFile**? : *boolean*
+
+If set to false, will not save the component's source file.
+
+
+• **package**? : *[PackageInfoOptions](#packageinfooptions) | false*
+
+Otions for extracting repository information from the component's package,json file.
+
+___
+
+## StoriesOptions
+
+Options for extracting stories information.
+
+*Defined in [core/instrument/src/types.ts](https://github.com/atanasster/component-controls/blob/ab703a5/core/instrument/src/types.ts)*
+
+### Properties
+
+• **storeSourceFile**? : *boolean*
+
+If set to false, will not save the stories's source file, only the source of each individual story.
+
+
+• **package**? : *[PackageInfoOptions](#packageinfooptions) | false*
+
+Options for extracting repository information from the component's package,json file.
 
 ___
 
@@ -201,6 +247,7 @@ Defaults to true if sourceType === 'module'. Otherwise, false.
 
 Adds all parsed tokens to a tokens property on the File node.
 
+___
 
 # PrettierOptions
 
@@ -315,6 +362,7 @@ Whether or not to indent the code inside <script> and <style> tags in Vue files.
 
 Whether or not to indent the code inside <script> and <style> tags in Vue files.
 
+___
 
 # ResolvePrettierConfigOptions
 
@@ -342,7 +390,7 @@ the following EditorConfig properties are supported:
 • **useCache**? : *undefined | false | true*
 
 If set to `false`, all caching will be bypassed.
-
+___
 
 # ResolverOptions
 
@@ -396,3 +444,37 @@ algorithm does not preserve symlinks by default.
 • **readFileSync**? : *undefined | function*
 
 how to read files synchronously (defaults to fs.readFileSync)
+
+___
+
+## PackageInfoOptions
+
+Options for finding and extracting package.json informtation, applies both for components and stories.
+
+*Defined in [core/instrument/src/types.ts](https://github.com/atanasster/component-controls/blob/ab703a5/core/instrument/src/types.ts)*
+
+### Properties
+
+• **maxLevels**? : *number*
+
+ Max levels of folders to look up to find the `package.json` file.
+
+
+• **packageJsonName**? : *string*
+
+`package.json` alternative name
+
+
+• **storeBrowseLink**? : *boolean*
+
+Whether to save the link for browsing the file in the repository field.
+
+
+• **storeDocsLink**? : *boolean*
+
+Whether to save the link for project readme file in the repository field.
+
+
+• **storeIssuesLink**? : *boolean*
+
+Whether to save the link for filing issues with the project in the repository field.
\ No newline at end of file
diff --git a/core/instrument/package.json b/core/instrument/package.json
index 404fea909..a0c3b5a54 100644
--- a/core/instrument/package.json
+++ b/core/instrument/package.json
@@ -39,6 +39,7 @@
     "@mdx-js/loader": "^1.5.5",
     "@storybook/csf": "^0.0.1",
     "crypto": "^1.0.1",
+    "deepmerge": "^4.2.2",
     "hosted-git-info": "^3.0.4",
     "resolve": "^1.15.1",
     "prettier": "^1.19.1",
diff --git a/core/instrument/src/babel/extract-component.ts b/core/instrument/src/babel/extract-component.ts
index d194d0c02..0d79757f3 100644
--- a/core/instrument/src/babel/extract-component.ts
+++ b/core/instrument/src/babel/extract-component.ts
@@ -39,24 +39,28 @@ export const extractComponent = async (
   componentName: string,
   filePath: string,
   source?: string,
-  optiomns?: InstrumentOptions,
+  options?: InstrumentOptions,
   initialAST?: File,
 ): Promise<StoryComponent | undefined> => {
   const follow = followImports(
     componentName,
     filePath,
     source,
-    optiomns,
+    options,
     initialAST,
   );
+  const { components } = options || {};
   return follow
     ? {
         name: componentName,
         from: follow.from,
         request: follow.filePath,
         loc: follow.loc,
-        source: follow.source,
-        repository: await packageInfo(follow.originalFilePath),
+        source: components?.storeSourceFile ? follow.source : undefined,
+        repository: await packageInfo(
+          follow.originalFilePath,
+          options?.components?.package,
+        ),
       }
     : {
         name: componentName,
@@ -67,7 +71,7 @@ export const extractSotreComponent = async (
   store: StoriesStore,
   filePath: string,
   source: string,
-  optiomns?: InstrumentOptions,
+  options?: InstrumentOptions,
   initialAST?: File,
 ) => {
   const kinds = Object.keys(store.kinds);
@@ -80,7 +84,7 @@ export const extractSotreComponent = async (
         componentName,
         filePath,
         source,
-        optiomns,
+        options,
         initialAST,
       );
       if (component) {
@@ -97,7 +101,7 @@ export const extractSotreComponent = async (
         componentName,
         filePath,
         source,
-        optiomns,
+        options,
         initialAST,
       );
       if (component) {
diff --git a/core/instrument/src/babel/follow-imports.ts b/core/instrument/src/babel/follow-imports.ts
index 312733539..060e0efc8 100644
--- a/core/instrument/src/babel/follow-imports.ts
+++ b/core/instrument/src/babel/follow-imports.ts
@@ -30,11 +30,11 @@ export const followImports = (
   options?: InstrumentOptions,
   initialAST?: File,
 ): FollowImportType | undefined => {
-  const { parser: parserOptions, resolve: resolveOptions, component } =
+  const { parser: parserOptions, resolver: resolveOptions, components } =
     options || {};
   const fileName =
-    component && component.resolveFile
-      ? component.resolveFile(importName, filePath)
+    components && components.resolveFile
+      ? components.resolveFile(importName, filePath)
       : filePath;
   if (!fileName) {
     return undefined;
diff --git a/core/instrument/src/index.ts b/core/instrument/src/index.ts
index a76911880..1f552a35d 100644
--- a/core/instrument/src/index.ts
+++ b/core/instrument/src/index.ts
@@ -5,6 +5,7 @@ import { toId, storyNameFromExport } from '@storybook/csf';
 import traverse from '@babel/traverse';
 import generate from '@babel/generator';
 import prettier from 'prettier';
+import deepMerge from 'deepmerge';
 import parserBabel from 'prettier/parser-babylon';
 import {
   StoriesStore,
@@ -20,8 +21,14 @@ import { extractSotreComponent } from './babel/extract-component';
 import { packageInfo } from './project/packageInfo';
 import {
   InstrumentOptions,
+  ParserOptions,
   defaultParserOptions,
+  ResolveOptions,
   defaultResolveOptions,
+  ComponentOptions,
+  defaultComponentOptions,
+  StoriesOptions,
+  defaultStoriesOptions,
 } from './types';
 
 export * from './types';
@@ -44,23 +51,22 @@ const parseSource = async (
   options?: InstrumentOptions,
 ): Promise<StoriesStore> => {
   const {
-    parser: parserOptions,
-    prettier: prettierOptions,
-    resolve: resolveOptions,
-    component: componentOptions,
+    parser: parserOptions = {},
+    prettier: prettierOptions = {},
+    resolver: resolveOptions = {},
+    components: componentOptions = {},
+    stories: storiesOptions = {},
   } = options || {};
 
   const mergedOptions = {
-    parser: {
-      ...defaultParserOptions,
-      ...parserOptions,
-    },
-    resolve: {
-      ...defaultResolveOptions,
-      ...resolveOptions,
-    },
+    parser: deepMerge<ParserOptions>(defaultParserOptions, parserOptions),
+    resolve: deepMerge<ResolveOptions>(defaultResolveOptions, resolveOptions),
     prettier: prettierOptions,
-    component: componentOptions,
+    components: deepMerge<ComponentOptions>(
+      defaultComponentOptions,
+      componentOptions,
+    ),
+    stories: deepMerge<StoriesOptions>(defaultStoriesOptions, storiesOptions),
   };
 
   const prettify = async (c: string): Promise<string> => {
@@ -96,7 +102,9 @@ const parseSource = async (
   traverse(ast, traverseFn(store));
   if (Object.keys(store.kinds).length > 0) {
     const kind = store.kinds[Object.keys(store.kinds)[0]];
-    kind.source = originalSource;
+    if (mergedOptions.stories.storeSourceFile) {
+      kind.source = originalSource;
+    }
     store.stories = Object.keys(store.stories).reduce(
       (acc: { [key: string]: Story }, name) => {
         const story: Story = store.stories[name];
@@ -117,7 +125,11 @@ const parseSource = async (
   const kindsNames = Object.keys(store.kinds);
   for (let i = 0; i < kindsNames.length; i += 1) {
     const kind: StoriesKind = store.kinds[kindsNames[i]];
-    const repository = await packageInfo(filePath);
+
+    const repository = await packageInfo(
+      filePath,
+      mergedOptions.stories?.package,
+    );
     if (repository) {
       kind.repository = repository;
     }
diff --git a/core/instrument/src/project/packageInfo.ts b/core/instrument/src/project/packageInfo.ts
index a79361be0..36f5e856e 100644
--- a/core/instrument/src/project/packageInfo.ts
+++ b/core/instrument/src/project/packageInfo.ts
@@ -6,6 +6,7 @@ import hostedGitInfo from 'hosted-git-info';
 //@ts-ignore
 import parseRepositoryURL from '@hutson/parse-repository-url';
 import { Repository } from '@component-controls/specification';
+import { PackageInfoOptions } from '../types';
 
 const traverseFolder = (
   filePath: string,
@@ -27,14 +28,9 @@ const traverseFolder = (
   );
 };
 
-export interface FindPackageJsonOptions {
-  maxLevels?: number;
-  packageJsonName?: string;
-}
-
 const getPackageJson = async (
   filePath?: string,
-  opts?: FindPackageJsonOptions,
+  opts?: PackageInfoOptions | false,
 ): Promise<{
   fileName: string;
   packageJSON: { [key: string]: any };
@@ -43,6 +39,9 @@ const getPackageJson = async (
     if (!filePath) {
       return resolve(null);
     }
+    if (opts === false) {
+      return resolve(null);
+    }
     const fileName = traverseFolder(
       path.dirname(filePath),
       opts?.maxLevels || 10,
@@ -66,7 +65,7 @@ export interface PackageInfoReturnType {
 
 export const packageInfo = async (
   filePath?: string,
-  opts?: FindPackageJsonOptions,
+  opts?: PackageInfoOptions | false,
 ): Promise<Repository | undefined> => {
   if (filePath) {
     const { fileName, packageJSON } =
@@ -100,12 +99,18 @@ export const packageInfo = async (
             )
             .replace('{committish}', templates.committish || 'master');
         };
-
-        return {
-          browse: fillTemplate(templates.browsefiletemplate),
-          docs: fillTemplate(templates.docstemplate),
-          issues: fillTemplate(templates.bugstemplate),
-        };
+        const result: Repository = {};
+        const { storeBrowseLink, storeDocsLink, storeIssuesLink } = opts || {};
+        if (storeBrowseLink) {
+          result.browse = fillTemplate(templates.browsefiletemplate);
+        }
+        if (storeDocsLink) {
+          result.docs = fillTemplate(templates.docstemplate);
+        }
+        if (storeIssuesLink) {
+          result.issues = fillTemplate(templates.bugstemplate);
+        }
+        return result;
       }
     }
   }
diff --git a/core/instrument/src/types.ts b/core/instrument/src/types.ts
index 44e9a6b56..8f87dd69c 100644
--- a/core/instrument/src/types.ts
+++ b/core/instrument/src/types.ts
@@ -19,13 +19,92 @@ export const defaultParserOptions: ParserOptions = {
   plugins: ['jsx', 'typescript'],
 };
 
+export const defaultPackageOptions: PackageInfoOptions = {
+  maxLevels: 10,
+  packageJsonName: 'package.json',
+  storeBrowseLink: true,
+  storeDocsLink: true,
+  storeIssuesLink: true,
+};
+
+export const defaultComponentOptions: ComponentOptions = {
+  storeSourceFile: true,
+  package: defaultPackageOptions,
+};
+
+export const defaultStoriesOptions: StoriesOptions = {
+  storeSourceFile: true,
+  package: defaultPackageOptions,
+};
+
+/**
+ * options for finding and extracting package.json informtation
+ * applies both for components and stories
+ */
+export interface PackageInfoOptions {
+  /**
+   * max levels of folders to look up to find the package.json file
+   */
+  maxLevels?: number;
+  /**
+   * package.json alternative name
+   */
+  packageJsonName?: string;
+
+  /**
+   * Whether to save the link for browsing the file in the repository field
+   */
+  storeBrowseLink?: boolean;
+
+  /**
+   * Whether to save the link for project readme file in the repository field
+   */
+  storeDocsLink?: boolean;
+
+  /**
+   * Whether to save the link for filing issues with the project in the repository field
+   */
+
+  storeIssuesLink?: boolean;
+}
+
 export interface ComponentOptions {
+  /**
+   * Callback function to resolve the source file name of a component.
+   * Return false if this file should not be processed.
+   */
   resolveFile?: (componentName: string, filePath: string) => string | undefined;
+
+  /**
+   * If set to false, will not save the component's source file
+   */
+  storeSourceFile?: boolean;
+
+  /**
+   * options for extracting repository information from the component's package,json file
+   */
+  package?: PackageInfoOptions | false;
+}
+
+export interface StoriesOptions {
+  /**
+   * If set to false, will not save the stories's source file, only the source of each individual story
+   */
+  storeSourceFile?: boolean;
+
+  /**
+   * options for extracting repository information from the component's package,json file
+   */
+  package?: PackageInfoOptions | false;
 }
+
 /**
  * Options passed for instrumenting
  */
 export interface InstrumentOptions {
+  /**
+   * Options to control babel parser.
+   */
   parser?: ParserOptions;
   /**
    * prettier options are used to prettify the code at the end of the process
@@ -33,6 +112,19 @@ export interface InstrumentOptions {
    * fassing a value of false as prettier option will disabled prettifying
    */
   prettier?: PrettierOptions | false;
-  resolve?: ResolveOptions;
-  component?: ComponentOptions;
+
+  /**
+   * Options to control the `resolve` import resolving utilities.
+   */
+  resolver?: ResolveOptions;
+
+  /**
+   * Options for extracting components information.
+   */
+  components?: ComponentOptions;
+
+  /**
+   * Options for extracting stories information.
+   */
+  stories?: StoriesOptions;
 }
diff --git a/core/instrument/test/extract-component.test.ts b/core/instrument/test/extract-component.test.ts
index ea65bf24d..eec681791 100644
--- a/core/instrument/test/extract-component.test.ts
+++ b/core/instrument/test/extract-component.test.ts
@@ -6,8 +6,14 @@ describe('extract-component', () => {
   loadTestFiles(async (fileName: string) => {
     return await extractComponent('Button', fileName, undefined, {
       parser: defaultParserOptions,
-      resolve: defaultResolveOptions,
-      component: {
+      resolver: defaultResolveOptions,
+      components: {
+        storeSourceFile: true,
+        package: {
+          storeBrowseLink: true,
+          storeDocsLink: true,
+          storeIssuesLink: true,
+        },
         resolveFile: (componentName: string, filePath: string) => {
           if (filePath.includes('/theme-ui/dist')) {
             return `${
diff --git a/core/instrument/test/follow-imports.test.ts b/core/instrument/test/follow-imports.test.ts
index 1b57ffc03..56dccefef 100644
--- a/core/instrument/test/follow-imports.test.ts
+++ b/core/instrument/test/follow-imports.test.ts
@@ -1,12 +1,17 @@
 import { loadTestFiles } from './loadTestFiles';
-import { defaultParserOptions, defaultResolveOptions } from '../src/index';
+import {
+  defaultParserOptions,
+  defaultResolveOptions,
+  defaultComponentOptions,
+} from '../src/index';
 import { followImports } from '../src/babel/follow-imports';
 
 describe('follow-imports', () => {
   loadTestFiles(async (fileName: string) => {
     return followImports('Button', require.resolve(fileName), undefined, {
       parser: defaultParserOptions,
-      resolve: defaultResolveOptions,
+      resolver: defaultResolveOptions,
+      components: defaultComponentOptions,
     });
   }, 'follow-imports');
 });
diff --git a/core/specification/src/utility.ts b/core/specification/src/utility.ts
index 2e3676e25..aad8ea72f 100644
--- a/core/specification/src/utility.ts
+++ b/core/specification/src/utility.ts
@@ -26,15 +26,15 @@ export interface Repository {
   /**
    * link for browsing the file
    */
-  browse: string;
+  browse?: string;
 
   /**
    * link for project readme
    */
-  docs: string;
+  docs?: string;
 
   /**
    * link for filing issues with the project
    */
-  issues: string;
+  issues?: string;
 }
diff --git a/examples/storybook-5/.storybook/main.js b/examples/storybook-5/.storybook/main.js
index d5024e5a8..b4294c809 100644
--- a/examples/storybook-5/.storybook/main.js
+++ b/examples/storybook-5/.storybook/main.js
@@ -45,7 +45,14 @@ module.exports = {
             type: 'csf',
             prettier: {
               tabWidth: 4,
-            }
+            },
+            components: {
+              storeSourceFile: true, //false
+            },
+            stories: {
+              storeSourceFile: true, //false
+            },
+
           },
         },
         {