基于nodejs实现根据文件类型统计工程源代码行数

我们需要用到2个模块，操作文件的模块fs和路径处理模块path。那么，让我们先引入它们。

const fs = require('fs')
const path = require('path')

然后，我们编写统计函数，我们命名为stat。我们要统计的是源代码，所以需要排除一些文件或目录，具体需要排除哪些文件或目录呢？node_modules肯定是要排除的，我们还需要提供一种方式来指定需要排除的目录或文件，比如源码目录中存在一个jquery.min.js文件，这是第三方库，肯定不能当作源码统计。说到根据文件类型统计，那么我们需要一个扩展名数组。

stat函数的入参定义如下：excludes，要排除的目录或文件；extnames，要统计的扩展名数组。

/** @param {{ excludes: string[], extnames: string[] }} param0 */
function stat ({ excludes, extnames }) {

}

以下代码全部在stat函数内部编写。我们先定义一个默认排除的目录数组defaultExcludes，然后对入参excludes进行重新赋值，合并默认排除的目录数组并调用数组的map方法，转化为新数组。如果路径以 / 开头，相对当前目录，转化为绝对路径，否则将 / 替换为当前操作系统目录分隔符。然后，我们定义了一个函数isExcluded，用于判断该目录或文件是否需要排除。

const defaultExcludes = ['/.git', '/.vscode', '/dist', '/node_modules', '/public', __filename]
  excludes = [...(excludes || []), ...defaultExcludes].map(_ => {
    return _.startsWith('/')
      ? path.resolve(__dirname, _.slice(1))
      : _.replace(/\//gm, path.sep)
  })

  /** @param {string} dir */
  const isExcluded = dir => excludes.some(_ => dir.includes(_))

接下来，我们定义更新计数函数。该函数接收2个参数，参数类型参见文档注释。

  /**
   * @param {Object<string, number>} map
   * @param {string} file
   */
  const updateCount = (map, file) => {
    const extname = file.split('.').pop()
    const isStat = extnames.includes(extname) && !isExcluded(file)
    if (isStat) {
      // 同步读取文件
      // 转化为utf8编码字符串
      // 去掉两端空白符
      // 以换行符分割字符串转化为数组
      // 获取数组长度就是文件行数
      const lineCount = fs.readFileSync(file).toString('utf8').trim().split('\n').length
      return {
        ...map,
        all: (map.all || 0) + lineCount,
        [extname]: (map[extname] || 0) + lineCount
      }
    }
    return map
  }

然后，我们定义合并统计map函数，该函数接收2个如上文档注释定义的类型作为参数，将2个map的统计值进行合并。并返回合并后的map。

  const mergeCount = (o1, o2) => {
    return Object.keys(o2).reduce((t, k) => {
      return {
        ...t,
        [k]: (t[k] || 0) + o2[k]
      }
    }, o1)
  }

最后，我们定义读取文件函数reader，该函数接收父目录作为参数，调用fs.readdirSync方法，返回一个子目录字符串构成的数组，调用数组的reduce方法进行聚合统计。最后，我们以该脚本所在目录开始调用读取函数进行递归读取。

  const reader = parentDir => {
    return fs.readdirSync(parentDir).reduce((t, d) => {
      const dir = path.resolve(parentDir, d)
      const isDir = fs.statSync(dir).isDirectory()
      return isDir
        ? isExcluded(dir)
          ? t
          : mergeCount(t, reader(dir))
        : updateCount(t, dir)
    }, {})
  }
  
  return reader(__dirname)

记住，以上代码，除了模块导入部分，全部写在stat函数体中。现在，我们看一下stat函数的使用例子。

const statMap = stat({
  extnames: ['js', 'css', 'scss', 'vue']
})

console.log(statMap) // 输出 { all: 2700, js: 831, vue: 1832, scss: 37 }

const statMap = stat({
  extnames: ['js', 'css', 'scss', 'vue'],
  excludes: ['auth']
})

console.log(statMap) // 输出 { all: 1968, js: 801, vue: 1130, scss: 37 }

const statMap = stat({
  extnames: ['js', 'vue'],
  excludes: ['auth', 'app/main.js']
})

console.log(statMap) // 输出 { all: 1904, js: 774, vue: 1130 }

是不是很简单？大家理解了吗？有什么不明白之处，欢迎评论区见！感谢阅读！