add include and exclude options

Author: hipstersmoothie

package.json

@@ -24,11 +24,13 @@
   ],
   "dependencies": {
     "endent": "^2.0.1",
+    "micromatch": "^4.0.2",
     "react-docgen-typescript": "^1.16.6",
     "react-docgen-typescript-loader": "^3.7.2",
     "tslib": "^2.0.0"
   },
   "devDependencies": {
+    "@types/micromatch": "^4.0.1",
     "@types/node": "^14.0.12",
     "@types/webpack": "^4.41.17",
     "@typescript-eslint/eslint-plugin": "2.31.0",

readme.md

@@ -15,7 +15,7 @@ yarn add -D react-docgen-typescript-plugin
 
 ## Usage
 
-> NOTE: The TypeScript compiler options `allowSyntheticDefaultImports` and `esModuleInterop` will make 
+> NOTE: The TypeScript compiler options `allowSyntheticDefaultImports` and `esModuleInterop` will make
 > `react-docgen-typescript-plugin` a lot harder! Turn them off for faster build times.
 
 ```ts
@@ -43,6 +43,8 @@ This plugins support all parser options from [react-docgen-typescript](https://g
 | docgenCollectionName | string or null | Specify the docgen collection name to use. All docgen information will be collected into this global object. Set to `null` to disable.              | `STORYBOOK_REACT_CLASSES` |
 | setDisplayName       | boolean        | Set the components' display name. If you want to set display names yourself or are using another plugin to do this, you should disable this option. | `true`                    |
 | typePropName         | string         | Specify the name of the property for docgen info prop type.                                                                                         | `type`                    |
+| exclude              | glob[]         | Glob patterns to ignore and not generate docgen information for. (Great for ignoring large icon libraries)                                          | []                        |
+| include              | glob[]         | Glob patterns to generate docgen information for                                                                                                    | ['**/**.tsx']             |
 
 ## Prior Art
 

src/index.ts

@@ -3,6 +3,7 @@ import * as webpack from "webpack";
 import ts from "typescript";
 import * as docGen from "react-docgen-typescript";
 import generateDocgenCodeBlock from "react-docgen-typescript-loader/dist/generateDocgenCodeBlock";
+import match from "micromatch";
 
 interface TypescriptOptions {
   /**
@@ -51,10 +52,19 @@ interface LoaderOptions {
 
 export type PluginOptions = docGen.ParserOptions &
   LoaderOptions &
-  TypescriptOptions;
+  TypescriptOptions & {
+    /** Glob patterns to ignore */
+    exclude?: [];
+    /** Glob patterns to include. defaults to ts|tsx */
+    include?: [];
+  };
 
 interface Module {
   userRequest: string;
+  request: string;
+  built?: boolean;
+  rawRequest?: string;
+  external?: boolean;
   _source: {
     _value: string;
   };
@@ -125,6 +135,8 @@ export default class DocgenPlugin {
       setDisplayName = true,
       typePropName = "type",
       compilerOptions: userCompilerOptions,
+      exclude = [],
+      include = ["**/**.tsx"],
       ...docgenOptions
     } = this.options;
     let compilerOptions = {
@@ -142,25 +154,35 @@ export default class DocgenPlugin {
       compilerOptions = { ...compilerOptions, ...options };
     }
 
+    const isExcluded = (filename: string) =>
+      Boolean(filename && exclude.find((i) => match([filename], i).length));
+    const isIncluded = (filename: string) =>
+      Boolean(filename && include.find((i) => match([filename], i).length));
+
+    const parser =
+      (tsconfigPath && docGen.withCustomConfig(tsconfigPath, docgenOptions)) ||
+      docGen.withCompilerOptions(compilerOptions, docgenOptions);
+
     compiler.hooks.make.tap(this.name, (compilation) => {
       compilation.hooks.seal.tap(this.name, () => {
         const modulesToProcess: Module[] = [];
 
-        compilation.modules.forEach((module) => {
+        compilation.modules.forEach((module: Module) => {
           // Skip ignored / external modules
-          if (!module.built || module.external || !module.rawRequest) {
+          if (
+            !module.built ||
+            module.external ||
+            !module.rawRequest ||
+            isExcluded(module.request) ||
+            !isIncluded(module.request) ||
+            !pathRegex.test(module.request)
+          ) {
             return;
           }
 
-          if (pathRegex.test(module.request)) {
-            modulesToProcess.push(module);
-          }
+          modulesToProcess.push(module);
         });
 
-        const parser =
-          (tsconfigPath &&
-            docGen.withCustomConfig(tsconfigPath, docgenOptions)) ||
-          docGen.withCompilerOptions(compilerOptions, docgenOptions);
         const tsProgram = ts.createProgram(
           modulesToProcess.map((v) => v.userRequest),
           compilerOptions