sku v13: remove persistentCache config option (#1013)

Co-authored-by: Adam Skoufis <askoufis@users.noreply.github.com>
seek-oss · Jul 10, 2024 · 0bc92a7 · 0bc92a7
1 parent a557612
commit 0bc92a7
Show file tree

Hide file tree

Showing 11 changed files with 31 additions and 37 deletions.
diff --git a/.changeset/stupid-seals-think.md b/.changeset/stupid-seals-think.md
@@ -0,0 +1,26 @@
+---
+'sku': major
+---
+
+Remove support for `persistentCache` configuration option
+
+**BREAKING CHANGE:**
+
+Disabling `persistentCache` was previously necessary when using [treat], which is no longer supported in `sku`. `persistentCache` is now always enabled and has been removed from the configuration options.
+
+[treat]: https://seek-oss.github.io/treat/
+
+**MIGRATION GUIDE:**
+
+Remove the `persistentCache` option from your sku config.
+
+```diff
+// sku.config.ts
+
+import { type SkuConfig } from 'sku';
+
+export default {
+- persistentCache: false,
+- persistentCache: true,
+} satisfies SkuConfig;
+```
diff --git a/docs/docs/configuration.md b/docs/docs/configuration.md
@@ -258,14 +258,6 @@ The file name of the library. The main bundle of the library will be output to `
 
 If `libraryFile` is not specified then `libraryName` will be used instead.
 
-## persistentCache
-
-type `boolean`
-
-Default: `true`
-
-Disables the use of webpack filesystem caching for `sku start` and `sku start-ssr`.
-
 ## polyfills
 
 type `Array<string>`

diff --git a/docs/docs/extra-features.md b/docs/docs/extra-features.md
@@ -62,12 +62,10 @@ export default {
 This cache stores generated webpack modules and chunks.
 It is only emitted during local development.
 Its purpose is to reduce the time it takes to start the local development server.
-`sku` enables this cache by default, but it can be disabled via the [`persistentCache` configuration].
 
 > This cache is stored in `node_modules/.cache/webpack` and can be safely deleted at any time.
 
 [webpack filesystem cache]: https://webpack.js.org/configuration/cache/#cachetype
-[`persistentCache` configuration]: ./docs/configuration#persistentcache
 
 ### [`babel-loader` cache]
 

diff --git a/fixtures/braid-design-system/sku.config.js b/fixtures/braid-design-system/sku.config.js
@@ -10,7 +10,6 @@ module.exports = {
   ],
   publicPath: '/',
   port: 8200,
-  persistentCache: false,
   dangerouslySetWebpackConfig: (config) => {
     if (config.name === 'render') {
       config.plugins.push(new ListExternalsWebpackPlugin());

diff --git a/fixtures/library-build/sku.config.js b/fixtures/library-build/sku.config.js
@@ -5,6 +5,5 @@ module.exports = {
   renderEntry: 'src/render.js',
   libraryName: 'MyLibrary',
   port: 8085,
-  persistentCache: false,
   dangerouslySetWebpackConfig: (config) => makeStableHashes(config),
 };
diff --git a/fixtures/library-file/sku.config.js b/fixtures/library-file/sku.config.js
@@ -6,6 +6,5 @@ module.exports = {
   libraryName: 'MyLibrary',
   libraryFile: 'my-library',
   port: 8086,
-  persistentCache: false,
   dangerouslySetWebpackConfig: (config) => makeStableHashes(config),
 };
diff --git a/packages/sku/config/webpack/cache.js b/packages/sku/config/webpack/cache.js
@@ -1,21 +1,15 @@
-const { persistentCache, paths } = require('../../context');
+const { paths } = require('../../context');
 const isCI = require('../../lib/isCI');
 
 const disableCacheOverride = Boolean(process.env.SKU_DISABLE_CACHE);
 
 module.exports = function getWebpackCacheSettings({ isDevServer }) {
   if (isDevServer && !isCI && !disableCacheOverride) {
-    if (persistentCache) {
-      return {
-        type: 'filesystem',
-        buildDependencies: {
-          config: paths.appSkuConfigPath ? [paths.appSkuConfigPath] : [],
-        },
-      };
-    }
-
     return {
-      type: 'memory',
+      type: 'filesystem',
+      buildDependencies: {
+        config: paths.appSkuConfigPath ? [paths.appSkuConfigPath] : [],
+      },
     };
   }
 

diff --git a/packages/sku/context/configSchema.js b/packages/sku/context/configSchema.js
@@ -198,9 +198,6 @@ module.exports = validator.compile({
     type: 'array',
     items: { type: 'string' },
   },
-  persistentCache: {
-    type: 'boolean',
-  },
   externalizeNodeModules: {
     type: 'boolean',
   },

diff --git a/packages/sku/context/defaultSkuConfig.js b/packages/sku/context/defaultSkuConfig.js
@@ -47,6 +47,5 @@ module.exports = {
   rootResolution: !isCompilePackage,
   languages: null,
   skipPackageCompatibilityCompilation: [],
-  persistentCache: true,
   externalizeNodeModules: false,
 };
diff --git a/packages/sku/context/index.js b/packages/sku/context/index.js
@@ -210,6 +210,5 @@ module.exports = {
   languages: normalizedLanguages,
   skipPackageCompatibilityCompilation:
     skuConfig.skipPackageCompatibilityCompilation,
-  persistentCache: skuConfig.persistentCache,
   externalizeNodeModules: skuConfig.externalizeNodeModules,
 };
diff --git a/packages/sku/sku-types.d.ts b/packages/sku/sku-types.d.ts
@@ -268,14 +268,6 @@ export interface SkuConfig {
    */
   orderImports?: boolean;
 
-  /**
-   * Disables the use of webpack filesystem caching for `sku start` and `sku start-ssr`.
-   *
-   * @default true
-   * @link https://seek-oss.github.io/sku/#/./docs/configuration?id=persistentcache
-   */
-  persistentCache?: boolean;
-
   /**
    * An array of polyfills to be included into all client entry points.
    *