feat($plugin-register-components): custom name registration (close: #656

) (#1418)
vuejs · Mar 12, 2019 · 9c6a00b · 9c6a00b
1 parent 5c0e62f
commit 9c6a00b
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 6 deletions.
diff --git a/packages/@vuepress/plugin-register-components/index.js b/packages/@vuepress/plugin-register-components/index.js
@@ -1,16 +1,14 @@
 const { fs, path, globby, datatypes: { isString }} = require('@vuepress/shared-utils')
 
 function fileToComponentName (file) {
-  return file
-    .replace(/\/|\\/g, '-')
-    .replace(/\.vue$/, '')
+  return file.replace(/\/|\\/g, '-')
 }
 
 async function resolveComponents (componentDir) {
   if (!fs.existsSync(componentDir)) {
     return
   }
-  return (await globby(['**/*.vue'], { cwd: componentDir }))
+  return (await globby(['**/*.vue'], { cwd: componentDir })).map(file => file.slice(0, -4))
 }
 
 // Since this plugin can ben used by multiple times, we need to
@@ -22,15 +20,15 @@ module.exports = (options, context) => ({
   multiple: true,
 
   async enhanceAppFiles () {
-    const { componentsDir = [], components = [] } = options
+    const { componentsDir = [], components = [], getComponentName = fileToComponentName } = options
     const baseDirs = Array.isArray(componentsDir) ? componentsDir : [componentsDir]
 
     function importCode (name, absolutePath) {
       return `Vue.component(${JSON.stringify(name)}, () => import(${JSON.stringify(absolutePath)}))`
     }
 
     function genImport (baseDir, file) {
-      const name = fileToComponentName(file)
+      const name = getComponentName(file)
       const absolutePath = path.resolve(baseDir, file)
       const code = importCode(name, absolutePath)
       return code

diff --git a/packages/docs/docs/plugin/official/plugin-register-components.md b/packages/docs/docs/plugin/official/plugin-register-components.md
@@ -68,3 +68,10 @@ module.exports = {
   ]
 }
 ```
+
+### getComponentName
+
+- Type: `(file: string) => string`
+- Default: `file => file.replace(/\/|\\/g, '-')`
+
+Customize component names for files under `componentsDir`.
diff --git a/packages/docs/docs/zh/plugin/official/plugin-register-components.md b/packages/docs/docs/zh/plugin/official/plugin-register-components.md
@@ -68,3 +68,10 @@ module.exports = {
   ]
 }
 ```
+
+### getComponentName
+
+- 类型: `(file: string) => string`
+- 默认值: `file => file.replace(/\/|\\/g, '-')`
+
+自定义 `componentsDir` 中注册的组件的名称。