feat: add an option to disable cache

saberland · Sep 29, 2019 · 6afe8fa · 6afe8fa
1 parent 21ac524
commit 6afe8fa
Show file tree

Hide file tree

Showing 8 changed files with 68 additions and 34 deletions.
diff --git a/packages/saber/lib/WebpackUtils.js b/packages/saber/lib/WebpackUtils.js
@@ -5,17 +5,26 @@ module.exports = class WebpackUtils {
     this.api = api
   }
 
+  get shouldCache() {
+    return this.api.config.build.cache !== false
+  }
+
   getCacheOptions(loader, obj) {
-    return {
-      cacheDirectory: this.api.resolveCache(path.join('cache', loader)),
-      cacheIdentifier: obj && JSON.stringify(obj)
-    }
+    return this.shouldCache
+      ? {
+          cacheDirectory: this.api.resolveCache(path.join('cache', loader)),
+          cacheIdentifier:
+            obj && JSON.stringify(typeof obj === 'function' ? obj() : obj)
+        }
+      : {}
   }
 
   addCacheSupport(rule, loader, obj) {
-    rule
-      .use('cache-loader')
-      .loader(require.resolve('cache-loader'))
-      .options(this.getCacheOptions(loader, obj))
+    if (this.shouldCache) {
+      rule
+        .use('cache-loader')
+        .loader(require.resolve('cache-loader'))
+        .options(this.getCacheOptions(loader, obj))
+    }
   }
 }
diff --git a/packages/saber/lib/cli-commands/build.js b/packages/saber/lib/cli-commands/build.js
@@ -4,11 +4,15 @@ module.exports = function(cli) {
   cli
     .command(
       'build [app-path]',
-      'Compile the application and generate static HTML files'
+      'Compile the application and generate static HTML files',
+      {
+        ignoreOptionDefaultValue: true
+      }
     )
     .alias('generate')
     .option('--skip-compilation', 'Skip the webpack compilation process')
     .option('--inspect-webpack', 'Inspect webpack config in your editor')
+    .option('--no-cache', 'Disable cache')
     .action((cwd = '.', options) => {
       setNodeEnv('production')
 
@@ -18,9 +22,15 @@ module.exports = function(cli) {
         )
       }
 
-      const { skipCompilation } = options
+      const { skipCompilation, cache } = options
       delete options.skipCompilation
-      return require('..')(Object.assign({ cwd, dev: false }, options))
+      delete options.cache
+
+      return require('..')(Object.assign({ cwd, dev: false }, options), {
+        build: {
+          cache
+        }
+      })
         .build({ skipCompilation })
         .catch(handleError)
     })

diff --git a/packages/saber/lib/cli-commands/dev.js b/packages/saber/lib/cli-commands/dev.js
@@ -10,10 +10,11 @@ module.exports = function(cli) {
     .option('--port <port>', 'Server port', { default: 3000 })
     .option('--host <host>', 'Server host', { default: '0.0.0.0' })
     .option('--inspect-webpack', 'Inspect webpack config in your editor')
+    .option('--no-cache', 'Disable cache')
     .action((cwd = '.', options) => {
       setNodeEnv('development')
 
-      const { host, port, lazy } = options
+      const { host, port, lazy, cache } = options
       delete options.host
       delete options.port
       delete options.lazy
@@ -23,7 +24,8 @@ module.exports = function(cli) {
           port
         },
         build: {
-          lazy
+          lazy,
+          cache
         }
       })
         .serve()

diff --git a/packages/saber/lib/utils/validateConfig.js b/packages/saber/lib/utils/validateConfig.js
@@ -67,15 +67,17 @@ module.exports = (config, { dev }) => {
       loaderOptions: 'object?',
       cssSourceMap: 'boolean?',
       lazy: 'boolean?',
-      outDir: 'string?'
+      outDir: 'string?',
+      cache: 'boolean?'
     },
     {
       publicUrl: '/',
       extractCSS: false,
       loaderOptions: {},
       cssSourceMap: false,
       lazy: false,
-      outDir: 'public'
+      outDir: 'public',
+      cache: true
     }
   )
 

diff --git a/packages/saber/lib/webpack/babel-loader.js b/packages/saber/lib/webpack/babel-loader.js
@@ -14,23 +14,25 @@ module.exports = babelLoader.custom(babel => {
       const custom = opts.customLoaderOptions
       const filename = path.join(custom.cwd, 'noop.js')
       const loader = Object.assign(
-        {
-          cacheCompression: false,
-          cacheDirectory: path.join(
-            custom.distDir,
-            'cache',
-            'saber-babel-loader'
-          ),
-          cacheIdentifier: JSON.stringify({
-            key: CACHE_KEY,
-            type: custom.type,
-            config: babel.loadPartialConfig({
-              filename,
-              cwd: custom.cwd,
-              sourceFileName: filename
-            }).options
-          })
-        },
+        custom.shouldCache
+          ? {
+              cacheCompression: false,
+              cacheDirectory: path.join(
+                custom.distDir,
+                'cache',
+                'saber-babel-loader'
+              ),
+              cacheIdentifier: JSON.stringify({
+                key: CACHE_KEY,
+                type: custom.type,
+                config: babel.loadPartialConfig({
+                  filename,
+                  cwd: custom.cwd,
+                  sourceFileName: filename
+                }).options
+              })
+            }
+          : {},
         opts
       )
       delete loader.customLoaderOptions

diff --git a/packages/saber/lib/webpack/webpack.config.js b/packages/saber/lib/webpack/webpack.config.js
@@ -69,6 +69,7 @@ module.exports = (api, { type }) => {
       customLoaderOptions: {
         distDir: api.resolveCache(),
         cwd: api.resolveCwd(),
+        shouldCache: api.webpackUtils.shouldCache,
         type
       }
     })

diff --git a/packages/saber/vue-renderer/lib/index.js b/packages/saber/vue-renderer/lib/index.js
@@ -52,14 +52,14 @@ class VueRenderer {
             transformAssetUrls: {},
             prettify: false
           },
-          api.webpackUtils.getCacheOptions('vue-loader', {
+          api.webpackUtils.getCacheOptions('vue-loader', () => ({
             // Increse `key` to invalid cache
             key: 0,
             type,
             'vue-loader': require('vue-loader/package.json').version,
             'vue-template-compiler': require('vue-template-compiler/package.json')
               .version
-          })
+          }))
         )
       )
 

diff --git a/website/pages/docs/saber-config.md b/website/pages/docs/saber-config.md
@@ -98,6 +98,14 @@ interface LoaderOptions {
 }
 ```
 
+### cache
+
+- Type: `boolean`
+- Default: `true`
+- CLI flag: `--no-cache`
+
+Set to `false` to disable webpack cache.
+
 ## plugins
 
 - Type: `Array<Plugin>`