feat: auto generate sidebar #130
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| const test = require('ava') | ||
| const fs = require('fs') | ||
| const path = require('path') | ||
|
|
||
| const {run} = require('../helpers/test-utils.js') | ||
|
|
||
| const genPath = path.join(__dirname, 'generate-cmd') | ||
| const docsPath = path.join(genPath, 'docs') | ||
|
|
||
| test.before('create temp directory', () => { | ||
| // Cleanup if the directory already exists | ||
| if (fs.existsSync(genPath)) { | ||
| fs.rmdirSync(genPath, {recursive: true}) | ||
| } | ||
|
|
||
| fs.mkdirSync(genPath) | ||
| }) | ||
|
|
||
| test.after('cleanup', () => { | ||
| fs.rmdirSync(genPath, {recursive: true}) | ||
| }) | ||
|
|
||
| test('generate _sidebar.md', t => { | ||
sy-records marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| run(['init', 'docs'], {cwd: genPath}) | ||
| run(['generate', 'docs'], {cwd: genPath}) | ||
| // Check for existence | ||
| t.true(fs.existsSync(path.join(docsPath, '_sidebar.md'))) | ||
| }) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,79 @@ | ||||||
| 'use strict' | ||||||
|
|
||||||
| const fs = require('fs') | ||||||
| const os = require('os') | ||||||
| const {cwd, exists} = require('../util') | ||||||
| const chalk = require('chalk') | ||||||
| const path = require('path') | ||||||
| const ignoreFiles = ['_navbar', '_coverpage', '_sidebar'] | ||||||
|
|
||||||
| // eslint-disable-next-line | ||||||
| module.exports = function (path = '', sidebar) { | ||||||
| const cwdPath = cwd(path || '.') | ||||||
|
|
||||||
| if (exists(cwdPath)) { | ||||||
| if (sidebar) { | ||||||
| const sidebarPath = cwdPath + '/' + sidebar || '_sidebar.md' | ||||||
|
|
||||||
| if (!exists(sidebarPath)) { | ||||||
| genSidebar(cwdPath, sidebarPath) | ||||||
| console.log(chalk.green(`Generate sidebar file '${sidebar}' success.`)) | ||||||
|
There was a problem hiding this comment.
Suggested change
There was a problem hiding this comment. It is better to have a - console.error(chalk.red(msg))
+ logger.error(msg)// logger.js
const error = (msg) => console.error(chalk.red(msg)); There was a problem hiding this comment. After the merge, I will submit a PR to amend this |
||||||
| return true | ||||||
| } | ||||||
|
|
||||||
| console.log(chalk.red(`${sidebarPath}`) + ' already exists.') | ||||||
sy-records marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| return false | ||||||
Koooooo-7 marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| } | ||||||
| } | ||||||
|
|
||||||
| console.log(chalk.red(`${cwdPath}`) + ' directory does not exist.') | ||||||
sy-records marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| } | ||||||
|
|
||||||
| function genSidebar(cwdPath, sidebarPath) { | ||||||
| let tree = '' | ||||||
| let lastPath = '' | ||||||
| let nodeName = '' | ||||||
| getDirFiles(cwdPath, function (pathname) { | ||||||
| path.relative(pathname, cwdPath) | ||||||
| pathname = pathname.replace(cwdPath + '/', '') | ||||||
| let filename = path.basename(pathname, '.md') | ||||||
| let splitPath = pathname.split(path.sep) | ||||||
|
|
||||||
| if (ignoreFiles.indexOf(filename) === -1) { | ||||||
| nodeName = '- [' + filename + '](' + pathname + ')' + os.EOL | ||||||
| } | ||||||
|
|
||||||
| if (splitPath.length > 1) { | ||||||
| if (splitPath[0] !== lastPath) { | ||||||
| lastPath = splitPath[0] | ||||||
| tree += os.EOL + '- ' + splitPath[0] + os.EOL | ||||||
| } | ||||||
|
|
||||||
| tree += ' ' + nodeName | ||||||
| } else { | ||||||
| if (lastPath !== '') { | ||||||
| lastPath = '' | ||||||
| tree += os.EOL | ||||||
| } | ||||||
|
|
||||||
| tree += nodeName | ||||||
| } | ||||||
| }) | ||||||
| fs.writeFile(sidebarPath, tree, 'utf8', err => { | ||||||
| if (err) { | ||||||
| console.log(chalk.red(`Generate sidebar file error, message: ${err.message}`)) | ||||||
sy-records marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| } | ||||||
| }) | ||||||
| } | ||||||
|
|
||||||
| function getDirFiles(dir, callback) { | ||||||
| fs.readdirSync(dir).forEach(function (file) { | ||||||
| let pathname = path.join(dir, file) | ||||||
|
|
||||||
| if (fs.statSync(pathname).isDirectory()) { | ||||||
| getDirFiles(pathname, callback) | ||||||
| } else if (path.extname(file) === '.md') { | ||||||
| callback(pathname) | ||||||
| } | ||||||
| }) | ||||||
| } | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| module.exports = { | ||
| init: require('./commands/init'), | ||
| serve: require('./commands/serve'), | ||
| start: require('./commands/start'), | ||
| generate: require('./commands/generate') | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.