feat: support generate uuid

Author: MuYunyun

docs/数学公式.md

@@ -1,3 +1,8 @@
+<!--
+title: 数学公式
+date: 2019-05-12 13:23:44
+-->
+
 ## 数学公式
 
 支持在 `$$` 与 `$$` 之间书写 latex 数学公式即能显示在网页上。

packages/crd-scripts/index.js

@@ -4,6 +4,7 @@ const initCache = require('./src/utils/initCache')
 const Servers = require('./src/server')
 const Build = require('./src/build')
 const Deploy = require('./src/deploy')
+const Generate = require('./src/generate')
 const paths = require('./src/conf/path')
 
 module.exports = {
@@ -13,5 +14,6 @@ module.exports = {
   Servers,
   Build,
   Deploy,
+  Generate,
   paths,
 }

packages/crd-scripts/src/conf/node-directory-tree.js

@@ -3,6 +3,7 @@ const fs = require('fs')
 const PATH = require('path')
 const YAML = require('yamljs')
 const { execSync } = require('child_process')
+const { replaceFileContent } = require('crd-utils')
 const { getDigitFromDir, timeFormat } = require('../utils')
 
 const constants = {
@@ -37,14 +38,14 @@ function safeReadDirSync(path) {
   return dirData
 }
 
-/**
- * build directory Tree, fork from https://github.com/mihneadb/node-directory-tree
+/** build directory Tree, fork from https://github.com/mihneadb/node-directory-tree
  * path: path for file
  * options: {
  *   exclude: RegExp|RegExp[] - A RegExp or an array of RegExp to test for exclusion of directories.
  *   extensions : RegExp - A RegExp to test for exclusion of files with the matching extension.
- *   mdconf: boolean
- *   prerender: boolean use for prerender
+ *   mdconf: Boolean.
+ *   prerender: Boolean. Used for prerender.
+ *   generate: Boolean. Used for generating info in front-matter.
  * }
  */
 function directoryTree({
@@ -75,37 +76,41 @@ function directoryTree({
     if (options && options.mdconf) {
       item.type = constants.FILE
       const contentStr = fs.readFileSync(path).toString()
-      if (contentStr) {
-        const contentMatch = contentStr.match(/^<!--([^>]*)-->/)
-        item.mdconf = contentMatch ? YAML.parse(contentMatch[1]) : {}
-        try {
-          // see https://stackoverflow.com/questions/2390199/finding-the-date-time-a-file-was-first-added-to-a-git-repository/2390382#2390382
-          const result = execSync(`git log --format=%aD ${path} | tail -1`)
-          item.birthtime =
-            Buffer.isBuffer(result) && timeFormat(new Date(result))
-        } catch (error) {
-          // eslint-disable-next-line no-console
-          console.log(`error: ${error.message}`)
-        }
-        try {
-          // see https://stackoverflow.com/questions/22497597/get-the-last-modification-data-of-a-file-in-git-repo
-          const result = execSync(`git log -1 --pretty="format:%ci" ${path}`)
-          item.mtime = Buffer.isBuffer(result) && timeFormat(new Date(result))
-        } catch (error) {
-          // eslint-disable-next-line no-console
-          console.log(`error: ${error.message}`)
-        }
-        item.size = stats.size // File size in bytes
-        item.extension = ext
-        if (!options.prerender) {
-          item.relative = item.path.replace(process.cwd(), '')
-          item.isEmpty = contentMatch
-            ? !String.prototype.trim.call(contentStr.replace(contentMatch[0], ''))
-            : true
-          const uglifyContent = contentStr.replace(/\s/g, '')
-          item.content = uglifyContent
+      if (!contentStr) return
+      const contentMatch = contentStr.match(/^<!--([^>]*)-->/)
+      if (options.generate) {
+        if (contentMatch && contentMatch[1].indexOf('abbrlink') === -1) {
+          replaceFileContent(path, contentMatch[1], `\nabbrlink: 290a4219${contentMatch[1]}`)
+          console.log('✅ replaceFileContent success')
         }
       }
+
+      item.mdconf = contentMatch ? YAML.parse(contentMatch[1]) : {}
+      try {
+        // see https://stackoverflow.com/questions/2390199/finding-the-date-time-a-file-was-first-added-to-a-git-repository/2390382#2390382
+        const result = execSync(`git log --format=%aD ${path} | tail -1`)
+        item.birthtime =
+          Buffer.isBuffer(result) && timeFormat(new Date(result))
+      } catch (error) {
+        console.log(`❎ error: ${error.message}`)
+      }
+      try {
+        // see https://stackoverflow.com/questions/22497597/get-the-last-modification-data-of-a-file-in-git-repo
+        const result = execSync(`git log -1 --pretty="format:%ci" ${path}`)
+        item.mtime = Buffer.isBuffer(result) && timeFormat(new Date(result))
+      } catch (error) {
+        console.log(`❎ error: ${error.message}`)
+      }
+      item.size = stats.size // File size in bytes
+      item.extension = ext
+      if (!options.prerender) {
+        item.relative = item.path.replace(process.cwd(), '')
+        item.isEmpty = contentMatch
+          ? !String.prototype.trim.call(contentStr.replace(contentMatch[0], ''))
+          : true
+        const uglifyContent = contentStr.replace(/\s/g, '')
+        item.content = uglifyContent
+      }
     }
   } else if (stats.isDirectory()) {
     const dirData = safeReadDirSync(path)

packages/crd-scripts/src/conf/webpack.config.prod.js

@@ -7,8 +7,8 @@ const CopyMarkdownImageWebpackPlugin = require('copy-markdown-image-webpack-plug
 const MiniCssExtractPlugin = require('mini-css-extract-plugin')
 const PrerenderSPAPlugin = require('crd-prerender-spa-plugin')
 const { generateSiteMap } = require('crd-generator-sitemap')
-// const CssMinimizerPlugin = require('css-minimizer-webpack-plugin');
-// const UglifyJsPlugin = require('uglifyjs-webpack-plugin');
+// const CssMinimizerPlugin = require('css-minimizer-webpack-plugin')
+// const UglifyJsPlugin = require('uglifyjs-webpack-plugin')
 const fs = require('fs-extra')
 const { defaultHTMLPath, docsBuildDist } = require('crd-utils')
 const { getDocsConfig } = require('crd-utils')
@@ -171,13 +171,13 @@ module.exports = function (cmd) {
           await fs.remove(`${docsBuildDist}/${docsConfig.repo}`)
           // move README as root index.html
           await fs.copy(`${docsBuildDist}/README/index.html`, `${docsBuildDist}/index.html`)
-          console.log('generate prerender file success!')
+          console.log('✅ generate prerender file success!')
           if (docsConfig.seo) {
             if (docsConfig.seo.google) {
               fs.writeFileSync(`${docsBuildDist}/sitemap.xml`, generateSiteMap(routes))
             }
           }
-          console.log('generate sitemap file success!')
+          console.log('✅ generate sitemap file success!')
         }
       },
       // The actual renderer to use. (Feel free to write your own)

packages/crd-scripts/src/generate.js

@@ -0,0 +1,23 @@
+const fs = require('fs')
+const { docsConfig } = require('crd-utils')
+const DirectoryTree = require('./conf/node-directory-tree')
+
+module.exports = function generate(program) {
+  if (!fs.existsSync(docsConfig)) {
+    console.log('❎ please check config.yml in root dir!\n')
+    return
+  }
+
+  const dir = program.markdownPaths
+  const dirs = Array.isArray(dir) ? dir : [dir]
+  const otherProps = {
+    mdconf: true,
+    extensions: /\.md/,
+    generate: true
+  }
+  dirs.map(path => DirectoryTree({
+    path,
+    options: otherProps,
+  }))
+  console.log('✅ generate success!')
+}

packages/crd-utils/index.js

@@ -16,10 +16,29 @@ const getDocsConfig = () => {
   return yaml.safeLoad(fs.readFileSync(docsConfig))
 }
 
+const replaceFileContent = (path, source, target) => {
+  fs.readFile(path, (err, data) => {
+    if (err) {
+      console.log(`❎ readFileContent error in ${path}`)
+      return
+    }
+    console.log(`✅ readFileContent success in ${path}`)
+    const replaceResult = data.toString().replace(source, target)
+    fs.writeFile(path, replaceResult, (err) => {
+      if (err) {
+        console.log(`❎ writeFileContent error in ${path}`)
+        return
+      }
+    })
+    console.log(`✅ writeFileContent success in ${path}`)
+  })
+}
+
 module.exports = {
   resolveApp,
   resolveTool,
   getDocsConfig,
+  replaceFileContent,
   // common paths
   docsGitIgnore: resolveApp('.gitignore'),
   docsBase: resolveApp(''),

packages/create-react-doc/README.md

@@ -12,15 +12,17 @@
 
 # react-doc
 
-react-doc 是配合 [Create React Doc](https://github.com/MuYunyun/create-react-doc) 使用的脚手架。
+react-doc 是配合 [Create React Doc](https://github.com/MuYunyun/create-react-doc) 使用的脚手架，其内置如下命令。
 
 ```bash
-$ react-doc doc      // 在当前文件夹下创建名为 doc 的文档站点
-$ react-doc start    // 启动项目
-$ react-doc build    // 项目打包
-$ react-doc deploy   // 手动发布项目
+$ react-doc doc         // 在当前文件夹下创建名为 doc 的文档站点
+$ react-doc start       // 启动项目
+$ react-doc build       // 项目打包
+$ react-doc deploy      // 手动发布项目
+$ react-doc theme       // 创建新主题包
+$ react-doc generate    // 用于自动生成 Front-matter 中相关字段信息
 ```
 
 # 调试
 
-进入该目录, 执行 yarn link, 即可在全局使用 react-doc xxx 命令。
+进入此包目录, 执行 yarn link, 即可在全局使用 react-doc xxx 命令。

packages/create-react-doc/index.js

@@ -7,6 +7,7 @@ const {
   initTheme,
   initCache,
   Deploy,
+  Generate,
   Servers,
   Build,
 } = require('crd-scripts')
@@ -17,10 +18,11 @@ const pkg = require('./package.json')
 program
   .version(pkg.version, '-v, --version')
   .description('Markdown doc site generator for React.')
-  .option('start', 'Documents generated.')
+  .option('start', 'Start the documents site in local env.')
   .option('build', 'Build the documents generated.')
   .option('deploy', 'Deploy site to gh-pages.')
   .option('theme', 'Create a new theme')
+  .option('generate', 'Generate info in front-matter')
   .option('-o, --output <path>', 'Writes the compiled file to the disk directory.', '.crd-dist')
   .option('-p, --port [number]', 'The port.', 3000)
   .option('--host [host]', 'The host.', '0.0.0.0')
@@ -32,14 +34,15 @@ program
     console.log('    $ react-doc start')
     console.log('    $ react-doc build')
     console.log('    $ react-doc deploy')
+    console.log('    $ react-doc theme')
+    console.log('    $ react-doc generate')
     console.log()
   })
   // the third value in process.argv is the value we want.
   .parse(process.argv)
 
-const { start, build, deploy, theme } = program
-
-if (!start && !build && !deploy && !theme) return initProject(program)
+const { start, build, deploy, theme, generate } = program
+if (!start && !build && !deploy && !theme && !generate) return initProject(program)
 
 if (theme) {
   return input({
@@ -62,7 +65,7 @@ program.output = path.join(process.cwd(), program.output)
 const docsConfig = getDocsConfig()
 
 // assign all the markdown dir
-if (start || build) {
+if (start || build || generate) {
   fs.existsSync(docsReadme) &&
     program.markdownPaths.push(docsReadme)
 
@@ -84,23 +87,31 @@ if (deploy) {
 }
 
 // no point markdown paths
-if (program.markdownPaths.length === 0) return console.log('Please specify the directory in config.yml.'.red)
+if (program.markdownPaths.length === 0) {
+  return console.log('❎ Please specify the markdownPaths props in config.yml.'.red)
+}
 
 let isExists = true
 // judge if files exist.
 program.markdownPaths.forEach((item) => {
   if (!fs.existsSync(item)) {
-    console.log(`Error: Directory ${item.yellow} does not exist`.red)
     isExists = false
   }
 })
 
-if (isExists) {
-  initCache(program, () => {
-    if (build) {
-      Build(program)
-    } else {
-      Servers(program)
-    }
-  })
+if (!isExists) {
+  console.log(`❎ Error: Directory ${item.yellow} does not exist`.red)
+  return
+}
+
+if (generate) {
+  return Generate(program)
 }
+
+initCache(program, () => {
+  if (build) {
+    Build(program)
+  } else {
+    Servers(program)
+  }
+})