add debug logs

Author: hipstersmoothie

package.json

@@ -23,13 +23,15 @@
     "dist"
   ],
   "dependencies": {
+    "debug": "^4.1.1",
     "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/debug": "^4.1.5",
     "@types/micromatch": "^4.0.1",
     "@types/node": "^14.0.12",
     "@types/webpack": "^4.41.17",

readme.md

@@ -46,6 +46,18 @@ This plugins support all parser options from [react-docgen-typescript](https://g
 | 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']             |
 
+## Debugging
+
+If you want to see how this plugins is including and excluding modules set the `DEBUG` environment variable.
+
+- `DEBUG=docgen:*` - All logs
+- `DEBUG=docgen:include` - Included modules
+- `DEBUG=docgen:exclude` - Excluded modules
+
+```bash
+DEBUG=docgen:* npm run storybook
+```
+
 ## Prior Art
 
 - [sn-client](https://github.com/SenseNet/sn-client/) - Inspired by this custom webpack plugin

src/index.ts

@@ -1,10 +1,14 @@
 import path from "path";
+import createDebug from "debug";
 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";
 
+const debugExclude = createDebug("docgen:exclude");
+const debugInclude = createDebug("docgen:include");
+
 interface TypescriptOptions {
   /**
    * Specify the location of the tsconfig.json to use. Can not be used with
@@ -142,8 +146,7 @@ export default class DocgenPlugin {
       include = ["**/**.tsx"],
       ...docgenOptions
     } = this.options;
-    
-    const pathRegex = RegExp(`\\${path.sep}src.+\\.tsx`);
+
     const isExcluded = matchGlob(exclude);
     const isIncluded = matchGlob(include);
 
@@ -171,18 +174,32 @@ export default class DocgenPlugin {
         const modulesToProcess: Module[] = [];
 
         compilation.modules.forEach((module: Module) => {
-          // Skip ignored / external modules
-          if (
-            !module.built ||
-            module.external ||
-            !module.rawRequest ||
-            isExcluded(module.request) ||
-            !isIncluded(module.request) ||
-            !pathRegex.test(module.request)
-          ) {
+          if (!module.built) {
+            debugExclude(`Ignoring un-built module: ${module.userRequest}`);
+            return;
+          }
+
+          if (module.external) {
+            debugExclude(`Ignoring external module: ${module.userRequest}`);
+            return;
+          }
+
+          if (!module.rawRequest) {
+            debugExclude(`Ignoring module without "rawRequest": ${module.userRequest}`);
+            return;
+          }
+
+          if (isExcluded(module.request)) {
+            debugExclude(`Module not matched in "exclude": ${module.userRequest}`);
+            return;
+          }
+
+          if (!isIncluded(module.request)) {
+            debugExclude(`Module not matched in "include": ${module.userRequest}`);
             return;
           }
 
+          debugInclude(module.userRequest);
           modulesToProcess.push(module);
         });