看到各位大佬在掘金上发文章,看到一些大佬的仓库的目录,想自己也搞一个,然而懒癌发作,得找个理由让自己不做这件事,程序员不就得偷懒么(认真):
手动处理目录的缺点:
-
添加文章、修改文章标题、删除文章,需要找到对应的标题操作,其中包括内容和 markdown 语法,多了很繁琐
-
添加文章、修改文章时,我希望能记录文章的更新时间,这个手动拿到时间再填进去,多了也很繁琐
成功地说服了自己,然后开始动手
思路
-
遍历所有的文件 递归实现
-
遇到文件和文件夹时,按照 markdown 语法写入到 README.md 中
遇到的问题:
-
文件所属文件夹出错,比如说不是 CSS 的出现在 CSS 目录下,这里需要使用同步方式读取来处理这个问题
-
完成的文章和未完成的合并在一起,没有按照未完成(n)文件夹来分开,这部分是因为 fs 的 fs.readdirSync 这个 API 读取文件列表后,它的顺序不是我们在资源管理看到的,而是按照某种排序,我们需要手动控制在读取子目录根目录时,把未完成(n)文件名移到文件列表的最后
// 检测文件夹下属文件名是否有n(未完成)这个文件夹,有的话,将这个n移动到数组末端
let nIndex = files.findIndex(f => f === 'n')
~nIndex && (files.splice(nIndex, 1), files.push('n'))
复制代码
文件结构
目前只考虑到支持子目录以及n(未完成),扩展这方面嘛,暂时没考虑那么多
示例:
let fpath = '前端'
const repPath = 'https://github.com/869288142/blog/tree/master'
const outputFile = 'README.md'
let g = require('./generateDir')
new g(repPath, outputFile, fpath).run()
复制代码
完整代码
let fs = require('fs') //读写文件就需要引入fs--文件系统模块
let path = require('path')
let { sep } = path
class generateDir {
constructor(repPath, outputFile, path) {
this.repPath = repPath
this.outputFile = outputFile
this.path = path
}
run() {
this.unLinkOutput(this.outputFile)
this.readDir(this.path)
}
readDir(path) {
let exists = fs.existsSync(path), //以同步的方法检测目录是否存在
stat = fs.statSync(path) //文件信息
if (exists && stat) {
//如果目录存在
if (stat.isFile()) {
//如果是文件
let fpath = path.split(sep) //以路径分割符将路径分割成数组
// 获取文件名
let fileName = fpath[fpath.length - 1]
// 文件更新时间
let updateTime = this.formatDate(stat.mtime)
// 将内容追加到README.md
let fileNameWithoutSuffix = fileName.replace(/(.*)\.md/, '$1')
// 文件输出内容
let content =
// 文件名
`* [${fileNameWithoutSuffix}]` +
// URL
`(${this.repPath}/${fpath.join('/')}) ` +
// 更新时间
`更新于${updateTime}` +
// 空行
`\r\n \r\n`
fs.appendFileSync(this.outputFile, content)
} else if (stat.isDirectory()) {
//如果是文件夹
let fpath = path.split(sep) //以路径分割符将路径分割成数组
// 获取文件名
let fileName = fpath[fpath.length - 1]
let files = fs.readdirSync(path) //返回 指定目录下所有文件名称
// 过滤掉只有n下属文件夹和空n文件夹
let normalContent = `**${fileName}**`
let nContent = ' \r\n \r\n**撰写中**'
let totalContent = `${
fileName === 'n' ? nContent : normalContent
} \r\n \r\n`
if (files.length !== 1 && files.length !== 0) {
// n 文件夹名替换成撰写中
fs.appendFileSync(this.outputFile, totalContent)
// 遍历文件夹下属文件
if (files && files.length > 0) {
// 确保n文件夹的下属文件在第一级文件夹后面输出
let nIndex = files.findIndex(f => f === 'n')
~nIndex && (files.splice(nIndex, 1), files.push('n'))
// 对每个文件进行递归操作
files.forEach(file => {
this.readDir(path + sep + file)
})
}
}
}
} else {
console.info('根目录不存在.')
}
}
formatDate(date) {
return `${date.getFullYear()}.${date.getMonth() + 1}.${date.getDate()}`
}
unLinkOutput(outputFile) {
let unlinkPath = `${path.resolve('.')}/${outputFile}`
if (fs.existsSync(unlinkPath)) {
fs.unlinkSync(unlinkPath)
}
}
}
module.exports = exports = generateDir
复制代码
小结:
其实呢,这个应该挺多人想到的吧,嘻嘻,不过作为萌新,还是挺开心能用技术来简化自己的日常操作,之前也尝试过写脚本来实现自动删库然后填充数据,代码逻辑和质量方面也说不上好,如果大佬们觉得过得去的话,希望能得到人生中的第一颗小星星,新人还在练习写作中。