feat($core): alias - plugin API

Author: ulivz

packages/@vuepress/core/lib/plugin-api/constants.js

@@ -17,7 +17,8 @@ const PLUGIN_OPTION_META_MAP = {
   CLIENT_ROOT_MIXIN: { name: 'clientRootMixin', types: [String] },
   ADDITIONAL_PAGES: { name: 'additionalPages', types: [Function, Array] },
   GLOBAL_UI_COMPONENTS: { name: 'globalUIComponents', types: [String, Array] },
-  DEFINE: { name: 'define', types: [Function, Object] }
+  DEFINE: { name: 'define', types: [Function, Object] },
+  ALIAS: { name: 'alias', types: [Function, Object] }
 }
 
 const PLUGIN_OPTION_MAP = {}

packages/@vuepress/core/lib/plugin-api/index.js

@@ -156,7 +156,8 @@ module.exports = class PluginAPI {
     clientRootMixin,
     additionalPages,
     globalUIComponents,
-    define
+    define,
+    alias
   }) {
     const isInternalPlugin = pluginName.startsWith('@vuepress/internal-')
     if (shortcut) {
@@ -181,5 +182,6 @@ module.exports = class PluginAPI {
       .registerOption(PLUGIN_OPTION_MAP.ADDITIONAL_PAGES.key, additionalPages, pluginName)
       .registerOption(PLUGIN_OPTION_MAP.GLOBAL_UI_COMPONENTS.key, globalUIComponents, pluginName)
       .registerOption(PLUGIN_OPTION_MAP.DEFINE.key, define, pluginName)
+      .registerOption(PLUGIN_OPTION_MAP.ALIAS.key, alias, pluginName)
   }
 }

packages/@vuepress/core/lib/plugin-api/override/AliasOption.js

@@ -0,0 +1,23 @@
+'use strict'
+
+/**
+ * Module dependencies.
+ */
+
+const Option = require('../abstract/Option')
+
+/**
+ * define option.
+ */
+
+module.exports = class DefineOption extends Option {
+  apply (config) {
+    super.syncApply()
+    const aliases = this.appliedValues
+    aliases.forEach((alias) => {
+      Object.keys(alias).forEach(key => {
+        config.resolve.alias.set('key', alias[key])
+      })
+    })
+  }
+}

packages/@vuepress/core/lib/plugin-api/override/instantiateOption.js

@@ -2,6 +2,7 @@ const EnhanceAppFilesOption = require('./EnhanceAppFilesOption')
 const ClientDynamicModulesOption = require('./ClientDynamicModulesOption')
 const GlobalUIComponentsOption = require('./GlobalUIComponentsOption')
 const DefineOption = require('./DefineOption')
+const AliasOption = require('./AliasOption')
 const Option = require('../abstract/Option')
 const { PLUGIN_OPTION_MAP } = require('../constants')
 
@@ -19,6 +20,9 @@ module.exports = function instantiateOption (name) {
   case PLUGIN_OPTION_MAP.DEFINE.name:
     return new DefineOption(name)
 
+  case PLUGIN_OPTION_MAP.ALIAS.name:
+    return new AliasOption(name)
+
   default: return new Option(name)
   }
 }

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

@@ -295,6 +295,7 @@ module.exports = function createBaseConfig ({
     }])
 
   pluginAPI.options.define.apply(config)
+  pluginAPI.options.alias.apply(config)
 
   return config
 }