Merge pull request #13 from hipstersmoothie/more-debug

add docgen:docs debugging

Author: hipstersmoothie

readme.md

@@ -55,11 +55,15 @@ If you want to see how this plugins is including and excluding modules set the `
 - `DEBUG=docgen:*` - All logs
 - `DEBUG=docgen:include` - Included modules
 - `DEBUG=docgen:exclude` - Excluded modules
+- `DEBUG=docgen:docs` - Generated docs
 
 ```bash
 DEBUG=docgen:* npm run storybook
 ```
 
+> Another great way of debugging your generated docs is to use a `debugger` statement in your component source file.
+> If you turn off source maps you will be able to see the code that this package generates.
+
 ## Prior Art
 
 - [sn-client](https://github.com/SenseNet/sn-client/) - Inspired by this custom webpack plugin

src/plugin.ts

@@ -8,6 +8,7 @@ import match from "micromatch";
 
 const debugExclude = createDebug("docgen:exclude");
 const debugInclude = createDebug("docgen:include");
+const debugDocs = createDebug("docgen:docs");
 
 interface TypescriptOptions {
   /**
@@ -101,6 +102,8 @@ function processModule(
     ...loaderOptions,
   }).substring(webpackModule.userRequest.length);
 
+  debugDocs(docs);
+
   // eslint-disable-next-line no-underscore-dangle
   let source = webpackModule._source._value;
   source += `\n${docs}\n`;