feat($cli): support '--cache' and '--no-cache' flag

Author: ulivz

packages/@vuepress/cli/index.js

@@ -43,20 +43,24 @@ exports.bootstrap = function ({
     .option('-p, --port <port>', 'use specified port (default: 8080)')
     .option('-h, --host <host>', 'use specified host (default: 0.0.0.0)')
     .option('-t, --temp <temp>', 'set the directory of the temporary file')
+    .option('-c, --cache <cache>', 'set the directory of cache')
+    .option('--no-cache', 'clean the cache before build')
     .option('--debug', 'start development server in debug mode')
-    .action((dir = '.', { host, port, debug, temp }) => {
-      wrapCommand(dev)(path.resolve(dir), { host, port, debug, plugins, theme, temp })
+    .action((dir = '.', { host, port, debug, temp, cache }) => {
+      wrapCommand(dev)(path.resolve(dir), { host, port, debug, temp, cache, plugins, theme })
     })
 
   program
     .command('build [targetDir]')
     .description('build dir as static site')
     .option('-d, --dest <outDir>', 'specify build output dir (default: .vuepress/dist)')
     .option('-t, --temp <temp>', 'set the directory of the temporary file')
+    .option('-c, --cache <cache>', 'set the directory of cache')
+    .option('--no-cache', 'clean the cache before build')
     .option('--debug', 'build in development mode for debugging')
-    .action((dir = '.', { debug, dest, temp }) => {
+    .action((dir = '.', { debug, dest, temp, cache }) => {
       const outDir = dest ? path.resolve(dest) : null
-      wrapCommand(build)(path.resolve(dir), { debug, outDir, plugins, theme, temp })
+      wrapCommand(build)(path.resolve(dir), { debug, outDir, plugins, theme, temp, cache })
     })
 
   program

packages/@vuepress/core/lib/build.js

@@ -14,8 +14,7 @@ module.exports = async function build (sourceDir, cliOptions = {}) {
   const { normalizeHeadTag, applyUserWebpackConfig } = require('./util/index')
 
   logger.wait('\nExtracting site metadata...')
-  const { theme, plugins, temp } = cliOptions
-  const options = await prepare(sourceDir, { theme, plugins, temp, isProd: true })
+  const options = await prepare(sourceDir, cliOptions, true /* isProd */)
   if (cliOptions.outDir) {
     options.outDir = cliOptions.outDir
   }

packages/@vuepress/core/lib/dev.js

@@ -18,13 +18,12 @@ module.exports = async function dev (sourceDir, cliOptions = {}) {
   const { frontmatterEmitter } = require('./webpack/markdownLoader')
 
   logger.wait('\nExtracting site metadata...')
-  const { theme, plugins, temp } = cliOptions
-  const options = await prepare(sourceDir, { theme, plugins, temp, isProd: false })
+  const options = await prepare(sourceDir, cliOptions, false /* isProd */)
 
   // setup watchers to update options and dynamically generated files
   const update = () => {
     options.pluginAPI.options.updated.syncApply()
-    prepare(sourceDir, { theme, plugins, temp, isProd: false }).catch(err => {
+    prepare(sourceDir, cliOptions, false /* isProd */).catch(err => {
       console.error(logger.error(chalk.red(err.stack), false))
     })
   }
@@ -58,7 +57,7 @@ module.exports = async function dev (sourceDir, cliOptions = {}) {
   frontmatterEmitter.on('update', update)
 
   // resolve webpack config
-  let config = createClientConfig(options, cliOptions)
+  let config = createClientConfig(options)
 
   config
     .plugin('html')

packages/@vuepress/core/lib/prepare/AppContext.js

@@ -19,12 +19,12 @@ module.exports = class AppContext {
    *  temp: string
    * }} options
    */
-  constructor (sourceDir, options) {
+  constructor (sourceDir, cliOptions = {}, isProd) {
     this.sourceDir = sourceDir
-    this._options = options
-    this.isProd = options.isProd
+    this.cliOptions = cliOptions
+    this.isProd = isProd
 
-    const { tempPath, writeTemp } = createTemp(options.temp)
+    const { tempPath, writeTemp } = createTemp(cliOptions.temp)
     this.tempPath = tempPath
     this.writeTemp = writeTemp
 
@@ -90,7 +90,7 @@ module.exports = class AppContext {
       .use(require('../internal-plugins/layoutComponents'))
       .use(require('../internal-plugins/pageComponents'))
       // user plugin
-      .useByPluginsConfig(this._options.plugins)
+      .useByPluginsConfig(this.cliOptions.plugins)
       .useByPluginsConfig(this.siteConfig.plugins)
       .useByPluginsConfig(this.themePlugins)
       // built-in plugins
@@ -192,7 +192,7 @@ module.exports = class AppContext {
    * @returns { Promise<void> }
    */
   async resolveTheme () {
-    const theme = this.siteConfig.theme || this._options.theme
+    const theme = this.siteConfig.theme || this.cliOptions.theme
     Object.assign(this, (await loadTheme(theme, this.sourceDir, this.vuepressDir)))
   }
 

packages/@vuepress/core/lib/prepare/index.js

@@ -1,12 +1,7 @@
 const AppContext = require('./AppContext')
 
-module.exports = async function prepare (sourceDir, {
-  isProd,
-  plugins,
-  theme,
-  temp
-}) {
-  const appContext = new AppContext(sourceDir, { plugins, theme, isProd, temp })
+module.exports = async function prepare (sourceDir, cliOptions, isProd) {
+  const appContext = new AppContext(sourceDir, cliOptions, isProd)
   await appContext.process()
   return appContext
 }

packages/@vuepress/core/lib/webpack/createBaseConfig.js

@@ -1,4 +1,5 @@
 const path = require('path')
+const { fs, logger, chalk } = require('@vuepress/shared-utils')
 
 module.exports = function createBaseConfig ({
   siteConfig,
@@ -7,8 +8,12 @@ module.exports = function createBaseConfig ({
   base: publicPath,
   themePath,
   markdown,
-  tempPath
-}, { debug } = {}, isServer) {
+  tempPath,
+  cliOptions: {
+    debug,
+    cache
+  }
+}, isServer) {
   const Config = require('webpack-chain')
   const { VueLoaderPlugin } = require('vue-loader')
   const CSSExtractPlugin = require('mini-css-extract-plugin')
@@ -61,7 +66,17 @@ module.exports = function createBaseConfig ({
   config.module
     .noParse(/^(vue|vue-router|vuex|vuex-router-sync)$/)
 
-  const cacheDirectory = path.resolve(__dirname, '../../node_modules/.cache/vuepress')
+  let cacheDirectory
+  if (cache && typeof cache === 'string') {
+    cacheDirectory = path.resolve(cache)
+  } else {
+    cacheDirectory = path.resolve(__dirname, '../../node_modules/.cache/vuepress')
+  }
+  logger.debug('Cache directory: ' + chalk.gray(cacheDirectory))
+  if (!cache) {
+    logger.tip('\nClean cache...\n')
+    fs.emptyDirSync(cacheDirectory)
+  }
   const cacheIdentifier = JSON.stringify({
     vuepress: require('../../package.json').version,
     'cache-loader': require('cache-loader').version,

packages/@vuepress/core/lib/webpack/createClientConfig.js

@@ -1,9 +1,9 @@
-module.exports = function createClientConfig (options, cliOptions) {
+module.exports = function createClientConfig (ctx) {
   const path = require('path')
   const WebpackBar = require('webpackbar')
   const createBaseConfig = require('./createBaseConfig')
 
-  const config = createBaseConfig(options, cliOptions)
+  const config = createBaseConfig(ctx)
 
   config
     .entry('app')
@@ -51,7 +51,7 @@ module.exports = function createClientConfig (options, cliOptions) {
       }])
   }
 
-  if (!cliOptions.debug) {
+  if (!ctx.cliOptions.debug) {
     config
       .plugin('bar')
       .use(WebpackBar, [{
@@ -61,11 +61,11 @@ module.exports = function createClientConfig (options, cliOptions) {
       }])
   }
 
-  if (options.siteConfig.chainWebpack) {
-    options.siteConfig.chainWebpack(config, false /* isServer */)
+  if (ctx.siteConfig.chainWebpack) {
+    ctx.siteConfig.chainWebpack(config, false /* isServer */)
   }
 
-  options.pluginAPI.options.chainWebpack.syncApply(config, false /* isServer */)
+  ctx.pluginAPI.options.chainWebpack.syncApply(config, false /* isServer */)
 
   return config
 }

packages/@vuepress/core/lib/webpack/createServerConfig.js

@@ -1,13 +1,13 @@
-module.exports = function createServerConfig (options, cliOptions) {
+module.exports = function createServerConfig (ctx) {
   const fs = require('fs')
   const path = require('path')
   const WebpackBar = require('webpackbar')
   const createBaseConfig = require('./createBaseConfig')
   const VueSSRServerPlugin = require('vue-server-renderer/server-plugin')
   const CopyPlugin = require('copy-webpack-plugin')
 
-  const config = createBaseConfig(options, cliOptions, true /* isServer */)
-  const { sourceDir, outDir } = options
+  const config = createBaseConfig(ctx, true /* isServer */)
+  const { sourceDir, outDir } = ctx
 
   config
     .target('node')
@@ -40,7 +40,7 @@ module.exports = function createServerConfig (options, cliOptions) {
       ]])
   }
 
-  if (!cliOptions.debug) {
+  if (!ctx.cliOptions.debug) {
     config
       .plugin('bar')
       .use(WebpackBar, [{
@@ -50,11 +50,11 @@ module.exports = function createServerConfig (options, cliOptions) {
       }])
   }
 
-  if (options.siteConfig.chainWebpack) {
-    options.siteConfig.chainWebpack(config, true /* isServer */)
+  if (ctx.siteConfig.chainWebpack) {
+    ctx.siteConfig.chainWebpack(config, true /* isServer */)
   }
 
-  options.pluginAPI.options.chainWebpack.syncApply(config, true /* isServer */)
+  ctx.pluginAPI.options.chainWebpack.syncApply(config, true /* isServer */)
 
   return config
 }