Merge pull request #49 from zhzz/fix-custom-options

fix: respect falsy custom options

Author: hipstersmoothie

src/__tests__/plugin.test.ts

@@ -1,6 +1,7 @@
 import webpack, { Configuration } from "webpack";
 import { createFsFromVolume, IFs, Volume } from "memfs";
 import ReactDocgenTypeScriptPlugin from "..";
+import { LoaderOptions } from "../types";
 
 // eslint-disable-next-line
 const joinPath = require("memory-fs/lib/join");
@@ -84,3 +85,34 @@ test("default options", async () => {
 
   expect(result).toContain("STORYBOOK_REACT_CLASSES");
 });
+
+describe("custom options", () => {
+  describe("loader options", () => {
+    const options: Record<
+      keyof LoaderOptions,
+      Array<LoaderOptions[keyof LoaderOptions]>
+    > = {
+      setDisplayName: [true, false, undefined],
+      typePropName: ["customValue", undefined],
+      docgenCollectionName: ["customValue", null, undefined],
+    };
+    const { defaultOptions } = ReactDocgenTypeScriptPlugin;
+
+    (Object.keys(options) as Array<keyof LoaderOptions>).forEach(
+      (optionName) => {
+        const values = options[optionName];
+
+        test.each(values)(`${optionName}: %p`, (value) => {
+          const plugin = new ReactDocgenTypeScriptPlugin({
+            [optionName]: value,
+          });
+          const { generateOptions: resultOptions } = plugin.getOptions();
+
+          expect(resultOptions[optionName]).toBe(
+            value === undefined ? defaultOptions[optionName] : value
+          );
+        });
+      }
+    );
+  });
+});

src/plugin.ts

@@ -135,6 +135,12 @@ function processModule(
 
 /** Inject typescript docgen information into modules at the end of a build */
 export default class DocgenPlugin implements webpack.WebpackPluginInstance {
+  public static defaultOptions = {
+    setDisplayName: true,
+    typePropName: "type",
+    docgenCollectionName: "STORYBOOK_REACT_CLASSES",
+  };
+
   private name = "React Docgen Typescript Plugin";
   private options: PluginOptions;
 
@@ -266,6 +272,7 @@ export default class DocgenPlugin implements webpack.WebpackPluginInstance {
       typePropName,
       ...docgenOptions
     } = this.options;
+    const { defaultOptions } = DocgenPlugin;
 
     let compilerOptions = {
       jsx: ts.JsxEmit.React,
@@ -286,9 +293,12 @@ export default class DocgenPlugin implements webpack.WebpackPluginInstance {
     return {
       docgenOptions,
       generateOptions: {
-        docgenCollectionName: docgenCollectionName || "STORYBOOK_REACT_CLASSES",
-        setDisplayName: setDisplayName || true,
-        typePropName: typePropName || "type",
+        docgenCollectionName:
+          docgenCollectionName === undefined
+            ? defaultOptions.docgenCollectionName
+            : docgenCollectionName,
+        setDisplayName: setDisplayName ?? defaultOptions.setDisplayName,
+        typePropName: typePropName ?? defaultOptions.typePropName,
       },
       compilerOptions,
     };