sku 11.0.4 → 11.1.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # sku
 
+## 11.1.0
+
+### Minor Changes
+
+- Include node_modules in node builds ([#651](https://github.com/seek-oss/sku/pull/651))
+
+  Previously, sku would only compile code within your src folder, plus any compile packages, for builds targetting the node environment. While this results in faster builds, it can sometimes lead to incorrect versions of packages being resolved due to clashing version range requirements. All node_modules will now included in the compilation by default, ensuring the correct package version is always required.
+
+  The old behaviour can be re-enabled via the new `externalizeNodeModules` config.
+
 ## 11.0.4
 
 ### Patch Changes

package/config/webpack/webpack.config.js

@@ -39,6 +39,7 @@ const {
   cspExtraScriptSrcHosts,
   rootResolution,
   skipPackageCompatibilityCompilation,
+  externalizeNodeModules,
 } = config;
 
 // port is only required for dev builds
@@ -268,19 +269,21 @@ const makeWebpackConfig = ({
       // render will run within the same process
       target: `browserslist:${nodeTarget}`,
       externals: [
-        // Don't bundle or transpile non-compiled packages
-        nodeExternals({
-          allowlist: [
-            'classnames', // Workaround for https://github.com/JedWatson/classnames/issues/240
+        // Don't bundle or transpile non-compiled packages if externalizeNodeModules is enabled
+        externalizeNodeModules
+          ? nodeExternals({
+              allowlist: [
+                'classnames', // Workaround for https://github.com/JedWatson/classnames/issues/240
 
-            // webpack-node-externals compares the `import` or `require` expression to this list,
-            // not the package name, so we map each packageName to a pattern. This ensures it
-            // matches when importing a file within a package e.g. import { Text } from 'seek-style-guide/react'.
-            ...paths.compilePackages.map(
-              (packageName) => new RegExp(`^(${packageName})`),
-            ),
-          ],
-        }),
+                // webpack-node-externals compares the `import` or `require` expression to this list,
+                // not the package name, so we map each packageName to a pattern. This ensures it
+                // matches when importing a file within a package e.g. import { Text } from 'seek-style-guide/react'.
+                ...paths.compilePackages.map(
+                  (packageName) => new RegExp(`^(${packageName})`),
+                ),
+              ],
+            })
+          : {},
       ],
       output: {
         path: paths.target,

package/config/webpack/webpack.config.ssr.js

@@ -30,6 +30,7 @@ const {
   useDevServerMiddleware,
   rootResolution,
   skipPackageCompatibilityCompilation,
+  externalizeNodeModules,
 } = require('../../context');
 const { getVocabConfig } = require('../vocab/vocab');
 const statsConfig = require('./statsConfig');
@@ -225,17 +226,20 @@ const makeWebpackConfig = ({
         {
           __sku_alias__webpackStats: `commonjs ./${webpackStatsFilename}`,
         },
-        nodeExternals({
-          modulesDir: findUp.sync('node_modules'), // Allow usage within project subdirectories (required for tests)
-          allowlist: [
-            // webpack-node-externals compares the `import` or `require` expression to this list,
-            // not the package name, so we map each packageName to a pattern. This ensures it
-            // matches when importing a file within a package e.g. import { Text } from 'seek-style-guide/react'.
-            ...paths.compilePackages.map(
-              (packageName) => new RegExp(`^(${packageName})`),
-            ),
-          ],
-        }),
+        // Don't bundle or transpile non-compiled packages if externalizeNodeModules is enabled
+        externalizeNodeModules
+          ? nodeExternals({
+              modulesDir: findUp.sync('node_modules'), // Allow usage within project subdirectories (required for tests)
+              allowlist: [
+                // webpack-node-externals compares the `import` or `require` expression to this list,
+                // not the package name, so we map each packageName to a pattern. This ensures it
+                // matches when importing a file within a package e.g. import { Text } from 'seek-style-guide/react'.
+                ...paths.compilePackages.map(
+                  (packageName) => new RegExp(`^(${packageName})`),
+                ),
+              ],
+            })
+          : {},
       ],
       resolve: {
         alias: {

package/context/configSchema.js

@@ -190,4 +190,7 @@ module.exports = validator.compile({
   persistentCache: {
     type: 'boolean',
   },
+  externalizeNodeModules: {
+    type: 'boolean',
+  },
 });

package/context/defaultSkuConfig.js

@@ -45,4 +45,5 @@ module.exports = {
   languages: null,
   skipPackageCompatibilityCompilation: [],
   persistentCache: true,
+  externalizeNodeModules: false,
 };

package/context/index.js

@@ -171,4 +171,5 @@ module.exports = {
   skipPackageCompatibilityCompilation:
     skuConfig.skipPackageCompatibilityCompilation,
   persistentCache: skuConfig.persistentCache,
+  externalizeNodeModules: skuConfig.externalizeNodeModules,
 };

package/docs/docs/configuration.md

@@ -143,6 +143,14 @@ Default: `[]`
 
 An array of environments the app supports. Apps should have one environment for local development plus one for each environment they're deployed to. Use this value to drive app config (e.g. `analyticsEnabled` or `apiEndpoint`). See [static-rendering](./docs/static-rendering.md) for more info.
 
+## externalizeNodeModules
+
+type `boolean`
+
+Default: `false`
+
+By default, sku compiles all node_modules in builds that target node. Setting this option to `true` will instead externalize all node_modules, excluding `compilePackages`.
+
 ## skipPackageCompatibilityCompilation
 
 type `Array<string>`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sku",
-  "version": "11.0.4",
+  "version": "11.1.0",
   "description": "Front-end development toolkit, powered by Webpack, Babel, CSS Modules, Less and Jest",
   "main": "index.js",
   "bin": {