Add test for Config.toString, add README note

neutrinojs · May 16, 2018 · 0107aef · 0107aef
1 parent 0823a1e
commit 0107aef
Show file tree

Hide file tree

Showing 2 changed files with 92 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1196,3 +1196,49 @@ config.toString();
 }
 */
 ```
+
+You can also call `toString` as a static method on `Config` in order to
+modify the configuration object prior to stringifying.
+
+```js
+const webpackConfig = config.toConfig();
+
+Config.toString({
+  ...config.toConfig(),
+  module: {
+    defaultRules: [
+      {
+        use: [
+          {
+            loader: 'banner-loader',
+            options: { prefix: 'banner-prefix.txt' },
+          },
+        ],
+      },
+    ],
+  },
+})
+
+/*
+{
+  plugins: [
+    /* config.plugin('foo') */
+    new TestPlugin()
+  ],
+  module: {
+    defaultRules: [
+      {
+        use: [
+          {
+            loader: 'banner-loader',
+            options: {
+              prefix: 'banner-prefix.txt'
+            }
+          }
+        ]
+      }
+    ]
+  }
+}
+*/
+```
diff --git a/test/Config.js b/test/Config.js
@@ -330,3 +330,49 @@ test('toString with custom prefix', t => {
   `.trim()
   );
 });
+
+test('static Config.toString', t => {
+  const config = new Config();
+
+  config.plugin('foo').use(class TestPlugin {});
+
+  t.is(
+    Config.toString({
+      ...config.toConfig(),
+      module: {
+        defaultRules: [
+          {
+            use: [
+              {
+                loader: 'banner-loader',
+                options: { prefix: 'banner-prefix.txt' },
+              },
+            ],
+          },
+        ],
+      },
+    }).trim(),
+    `
+{
+  plugins: [
+    /* config.plugin('foo') */
+    new TestPlugin()
+  ],
+  module: {
+    defaultRules: [
+      {
+        use: [
+          {
+            loader: 'banner-loader',
+            options: {
+              prefix: 'banner-prefix.txt'
+            }
+          }
+        ]
+      }
+    ]
+  }
+}
+  `.trim()
+  );
+});