feat: support docsify init --plugins (#99)

tool3 · sy-records · jamesgeorge007 · web-flow · commit 8bb295c54e92 · 2021-06-11T12:12:51.000+08:00
* feat: adding plugins support * fix: fixing url * fix: removing temp docs * docs: adding documentation for init --plugins * fix: removing unused files * fix: removing .nojekyll top-level * chore: adding tests * fix: fixing docs links * refactor: cleaner matchSnapshot * fix: removing redundant spread * fix(init): adding jsdelivr and major version to plugins init * fix(e2e): recreating index snap with latest docsify version * Update docs/README.md Co-authored-by: 沈唁 <52o@qq52o.cn> * Update README.md Co-authored-by: 沈唁 <52o@qq52o.cn> * Update lib/template/index.html Co-authored-by: 沈唁 <52o@qq52o.cn> * Update lib/commands/init.js Co-authored-by: 沈唁 <52o@qq52o.cn> * chore: Optimize code to ensure equal indentation * chore: update snap * chore: update snap * chore: update zh.json * fix: the exception caused by the plugin name being a number #99 (comment) * Use MultiSelect * Update README * Update lib/commands/init.js Co-authored-by: James George <jamesgeorge998001@gmail.com> * Update msg * Fix missing msg * refactor: simplify code with async/await * chore: handle user interruptions * Update README Co-authored-by: 沈唁 <52o@qq52o.cn> Co-authored-by: James George <jamesgeorge998001@gmail.com>
diff --git a/README.md b/README.md
@@ -50,9 +50,9 @@ npm i docsify-cli -g
 Use `init` to generate your docs.
 
 ```shell
-docsify init <path> [--local false] [--theme vue]
+docsify init <path> [--local false] [--theme vue] [--plugins false]
 
-# docsify i <path> [-l false] [-t vue]
+# docsify i <path> [-l false] [-t vue] [--plugins false]
 ```
 
 `<path>` defaults to the current directory. Use relative paths like `./docs` (or `docs`).
@@ -67,6 +67,11 @@ docsify init <path> [--local false] [--theme vue]
   - Type: string
   - Default: `vue`
   - Description: Choose a theme, defaults to `vue`, other choices are `buble`, `dark` and `pure`.
+- `--plugins` option:
+  - Shorthand: `-p`
+  - Type: boolean
+  - Default: `false`
+  - Description: Provide a list of plugins to insert as `<script>` tags to `index.html`.
 
 ### `serve` command
 
@@ -106,7 +111,6 @@ docsify generate <path> [--sidebar _sidebar.md]
   - Description: Generate sidebar file, defaults to `_sidebar.md`.
 
 ## Contributing
-
 Please see the [Contributing Guidelines](./CONTRIBUTING.md)
 
 ## Contribution
diff --git a/docs/README.md b/docs/README.md
@@ -35,9 +35,9 @@ npm i docsify-cli -g
 Use `init` to generate your docs.
 
 ```shell
-docsify init <path> [--local false] [--theme vue]
+docsify init <path> [--local false] [--theme vue] [--plugins false]
 
-# docsify i <path> [--local false] [--theme vue]
+# docsify i <path> [--local false] [--theme vue] [--plugins false]
 ```
 
 `<path>` defaults to the current directory. Use relative paths like `./docs` (or `docs`).
@@ -52,6 +52,11 @@ docsify init <path> [--local false] [--theme vue]
   * Type: string
   * Default: `vue`
   * Description: Choose a theme, defaults to `vue`, other choices are `buble`, `dark` and `pure`.
+* `--plugins` option:
+  * Shorthand: `-p`
+  * Type: array
+  * Default: `[]`
+  * Description: Provide a list of plugins to insert as `<script>` tags to `index.html`.
 
 ### `serve` command
 
diff --git a/lib/cli.js b/lib/cli.js
@@ -41,9 +41,17 @@ require('yargs')
           nargs: 1,
           requiresArg: true,
           type: 'string'
+        },
+        plugins: {
+          alias: 'p',
+          default: false,
+          desc: chalk.gray(y18n.__('init.plugins')),
+          nargs: 0,
+          requiresArg: false,
+          type: 'boolean'
         }
       }),
-    handler: argv => run.init(argv.path, argv.local, argv.theme)
+    handler: argv => run.init(argv.path, argv.local, argv.theme, argv.plugins)
   })
   .command({
     command: 'serve [path]',
diff --git a/lib/commands/init.js b/lib/commands/init.js
@@ -3,16 +3,18 @@
 const fs = require('fs')
 const cp = require('cp-file').sync
 const chalk = require('chalk')
+const {version} = require('../../package.json')
 const logger = require('../util/logger')
-const {prompt} = require('enquirer')
+const {prompt, MultiSelect} = require('enquirer')
 const {cwd, exists, pkg, pwd, read, resolve} = require('../util')
+const colors = require('ansi-colors')
 
 const replace = function (file, tpl, replace) {
   fs.writeFileSync(file, read(file).replace(tpl, replace), 'utf-8')
 }
 
 // eslint-disable-next-line
-module.exports = function (path = '', local, theme) {
+module.exports = async function (path = '', local, theme, plugins) {
   const msg =
     '\n' +
     chalk.green('Initialization succeeded!') +
@@ -25,32 +27,31 @@ module.exports = function (path = '', local, theme) {
   if (exists(cwdPath)) {
     logger.error(`${path || '.'} already exists.`)
 
-    prompt({
-      type: 'confirm',
-      name: 'rewrite',
-      symbols: {
-        separator: ''
-      },
-      message: 'Are you sure you want to rewrite it?'
-    })
-      .then(answers => {
-        if (answers.rewrite === false) {
-          return process.exit(0)
-        }
-
-        createFile(cwdPath, local, theme)
-        console.log(msg)
+    let answer = {}
+    try {
+      answer = await prompt({
+        type: 'confirm',
+        name: 'rewrite',
+        symbols: {
+          separator: ''
+        },
+        message: 'Are you sure you want to rewrite it?'
       })
-      .catch(console.error)
-
-    return false
+    } catch (err) {
+      err && logger.error(err)
+      process.exit(1)
+    }
+
+    if (!answer.rewrite) {
+      return
+    }
   }
 
-  createFile(cwdPath, local, theme)
+  await createFile(cwdPath, local, theme, plugins)
   console.log(msg)
 }
 
-function createFile(path, local, theme) {
+async function createFile(path, local, theme, plugins) {
   const target = file => resolve(path, file)
   const readme = exists(cwd('README.md')) || pwd('template/README.md')
   let main = pwd('template/index.html')
@@ -95,4 +96,60 @@ function createFile(path, local, theme) {
       .replace(/^git\+/g, '')
     replace(target(filename), 'repo: \'\'', `repo: '${repo}'`)
   }
+
+  // Return early if not opted for plugins
+  if (!plugins) {
+    return replace(target(filename), '\n  _plugins_', '')
+  }
+
+  const officialPlugins = [
+    'front-matter',
+    'search',
+    'disqus',
+    'emoji',
+    'external-script',
+    'ga',
+    'gitalk',
+    'matomo',
+    'zoom-image'
+  ]
+
+  const choices = officialPlugins.map(name => ({name, value: name}))
+  const prompt = new MultiSelect({
+    name: 'plugins',
+    message: 'Select plugins to be used',
+    hint: '(Use <space> to select, <return> to submit)',
+    default: '',
+    choices,
+    indicator(state, choice) {
+      if (choice.enabled) {
+        return colors.cyan(state.symbols.radio.on)
+      }
+
+      return colors.gray(state.symbols.radio.off)
+    }
+  })
+
+  prompt.on('cancel', () => replace(target(filename), '\n  _plugins_', ''))
+
+  let answers = []
+  try {
+    answers = await prompt.run()
+  } catch (err) {
+    if (err) {
+      logger.error(err)
+      process.exitCode = 1
+    }
+
+    return
+  }
+
+  replace(target(filename), '  _plugins_', '_plugin'.repeat(answers.length + 1))
+
+  answers.forEach(plugin => {
+    const url = `//cdn.jsdelivr.net/npm/docsify@${version[0]}/lib/plugins/${plugin}.min.js`
+    replace(target(filename), '_plugin', `  <script src="${url}"></script>\n`)
+  })
+
+  replace(target(filename), '\n_plugin', '')
 }
diff --git a/lib/template/index.html b/lib/template/index.html
@@ -18,5 +18,6 @@
   </script>
   <!-- Docsify v4 -->
   <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+  _plugins_
 </body>
 </html>
diff --git a/tools/locales/en.json b/tools/locales/en.json
@@ -6,6 +6,7 @@
   "start": "Server for SSR",
   "init.local": "Copy docsify files to local. To explicitly set --local to false you may use --no-local.",
   "init.theme": "Theme file to be used.",
+  "init.plugins": "A list of plugins to be used.",
   "serve": "Run local server to preview site.",
   "serve.open": "Open docs in default browser. To explicitly set --open to false you may use --no-open.",
   "serve.port": "Listen port.",
diff --git a/tools/locales/zh.json b/tools/locales/zh.json
@@ -6,13 +6,14 @@
   "init": "创建 docs",
   "init.local": "拷贝 docsify 到本地",
   "init.theme": "选择主题",
+  "init.plugins": "选择插件",
   "serve": "本地预览",
   "serve.open": "自动打开浏览器",
   "serve.port": "设置端口",
-  "serve.indexname": "Custom filename instead of index.html to serve by default",
-  "generate": "Docsify的生成器",
+  "serve.indexname": "自定义入口文件名，代替默认的 index.html",
+  "generate": "docsify 的生成器",
   "generate.sidebar": "生成侧边栏文件",
-  "livereload.port": "设置livereload端口",
+  "livereload.port": "设置 livereload 端口",
   "usage": "例子",
   "version": "当前版本号"
 }
