feat: add --overwrite flag to generator (#182)

Co-authored-by: Lu Fei <52o@qq52o.cn>

Author: trousev

README.md

@@ -99,9 +99,9 @@ docsify serve [path] [--open false] [--port 3000]
 Docsify's generators.
 
 ```shell
-docsify generate [path] [--sidebar _sidebar.md]
+docsify generate [path] [--sidebar _sidebar.md] [--overwrite]
 
-# docsify g [path] [-s _sidebar.md]
+# docsify g [path] [-s _sidebar.md] [-o]
 ```
 
 - `--sidebar` option:
@@ -110,6 +110,12 @@ docsify generate [path] [--sidebar _sidebar.md]
   - Default: `_sidebar.md`
   - Description: Generate sidebar file, defaults to `_sidebar.md`.
 
+- `--overwrite` option:
+  - Shorthand: `-o`
+  - Type: boolean
+  - Default: `false`
+  - Description: Allow overwrite generated files.
+
 ## Contributing
 Please see the [Contributing Guidelines](./CONTRIBUTING.md)
 

docs/README.md

@@ -84,9 +84,9 @@ docsify serve [path] [--open false] [--port 3000]
 Docsify's generators.
 
 ```shell
-docsify generate [path] [--sidebar _sidebar.md]
+docsify generate [path] [--sidebar _sidebar.md] [--overwrite]
 
-# docsify g [path] [-s _sidebar.md]
+# docsify g [path] [-s _sidebar.md] [-o]
 ```
 
 - `--sidebar` option:
@@ -95,6 +95,12 @@ docsify generate [path] [--sidebar _sidebar.md]
   - Default: `_sidebar.md`
   - Description: Generate sidebar file, defaults to `_sidebar.md`.
 
+- `--overwrite` option:
+  - Shorthand: `-o`
+  - Type: boolean
+  - Default: `false`
+  - Description: Allow overwrite generated files.
+
 ## License
 
 MIT

lib/cli.js

@@ -123,16 +123,23 @@ require('yargs')
     desc: chalk.gray(y18n.__('generate')),
     builder: yargs =>
       yargs.options({
+        overwrite: {
+          alias: 'o',
+          default: false,
+          desc: chalk.gray(y18n.__('generate.overwrite')),
+          nargs: 0,
+          type: 'boolean'
+        },
         sidebar: {
           alias: 's',
           default: '_sidebar.md',
-          desc: chalk.gray(y18n.__('gen.sidebar')),
+          desc: chalk.gray(y18n.__('generate.sidebar')),
           nargs: 1,
           requiresArg: true,
           type: 'string'
         }
       }),
-    handler: argv => run.generate(argv.path, argv.sidebar)
+    handler: argv => run.generate(argv.path, argv.sidebar, {overwrite: argv.overwrite})
   })
   .help()
   .option('help', {

lib/commands/generate.js

@@ -7,14 +7,14 @@ const path = require('path')
 const logger = require('../util/logger')
 const ignoreFiles = ['_navbar', '_coverpage', '_sidebar']
 
-module.exports = function (path, sidebar) {
+module.exports = function (path, sidebar, options) {
   const cwdPath = cwd(path || '.')
 
   if (exists(cwdPath)) {
     if (sidebar) {
       const sidebarPath = cwdPath + '/' + sidebar || '_sidebar.md'
 
-      if (!exists(sidebarPath)) {
+      if (!exists(sidebarPath) || options.overwrite) {
         genSidebar(cwdPath, sidebarPath)
         logger.success(`Successfully generated the sidebar file '${sidebar}'.`)
         return true

tools/locales/en.json

@@ -13,8 +13,8 @@
   "serve.indexname": "Custom filename instead of index.html to serve by default",
   "generate": "Docsify's generators",
   "generate.sidebar": "Generate sidebar file",
+  "generate.overwrite": "Allow overwrite generated files",
   "livereload.port": "livereload Listen port.",
   "usage": "Usage",
-  "version": "Show version number",
-  "gen.sidebar": "Generate sidebar"
+  "version": "Show version number"
 }

tools/locales/zh.json

@@ -13,8 +13,8 @@
   "serve.indexname": "自定义入口文件名，代替默认的 index.html",
   "generate": "docsify 的生成器",
   "generate.sidebar": "生成侧边栏文件",
+  "generate.overwrite": "允许覆盖生成的文件",
   "livereload.port": "设置 livereload 端口",
   "usage": "例子",
-  "version": "当前版本号",
-  "gen.sidebar": "生成侧边栏"
+  "version": "当前版本号"
 }