统计代码行

2021-05-04 约 716 字预计阅读 2 分钟次阅读

特性

支持计算代码行数和代码字符数丰富的配置文件，支持匹配任意规则的文件或文件夹支持生成计算结果的json 支持全局安装命令行使用

安装

1.1 全局安装

1

npm i count-code-line -g

1.2 本地安装

1

npm i count-code-line -D

1.2 本地安装 npm i count-code-line -D 1

使用

2.1 全局安装使用

在任意项目内打开命令行工具，运行一下命令即可

1

count-code-line

运行成功会在根目录下输出 count.output.json 文件

2.2 本地安装使用

在 package.json 文件中的scripts属性中加入如下配置

1
2
3
4
5
6


...
"scripts": {
    ...
    "count": "count-code-line"
},
...

然后在根目录下运行

1

npm run count

运行成功会在根目录下输出 count.output.json 文件

2.3 nodejs 引用

1
2


const count = require('count-code-line');
count();

配置文件

3.1 默认配置文件及配置项

count-code-line 支持自定义配置文件，以下是默认配置

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24


module.exports = {
    includes: [], // 需要包含的目录及文件 默认全部包含
    excludes: [], // 需要排除的目录及文件 默认全部移除
    defaultExcludes: [ // 默认排除的目录及文件
        '.git',
        '.vscode',
        'node_modules',
        'package.json',
        'package-lock.json',
        'yarn-lock.json',
        'count.output.json',
    ],
    defaultExcludesFileType: [ // 默认排除的文件类型
        '.zip', '.rar', '.png', '.jpg', '.jpeg', '.gif', '.bmp', '.mp3', '.wma', '.wav', '.mp4', '.flv', '.mov', '.avi', '.wmv', '.rmvb ', '.ogg', '.avi', '.ppt', '.pptx', '.doc','.docx','.xls','.xlsx','.psd','.ttf','.fon','.exe','.msi',
    ],
    output: 'count.output.json', // 默认的输出结果文件
    outputTrace: '', // 配置输出 trace 结果的文件，默认不输出
    encodings: [ // 支持的文件编码，对于不支持的文件将忽略
        'ascii',
        'utf8',
        'utf-8',
        'unicode'
    ]
};

3.2 自定义配置文件

在项目根目录下新建 count.config.js 文件写入上述配置覆盖默认配置即可

3.2 自定义配置文件在项目根目录下新建 count.config.js 文件写入上述配置覆盖默认配置即可

对于为空的配置项，将使用默认配置

3.3 目录匹配规则

includes excludes 等配置项均支持模糊匹配，匹配规则如下

‘a’ 将匹配根目录下 a 文件夹内的所有文件及文件夹；正则： new RegExp(^/a/.*)

‘a/a.js’ 仅匹配指定文件

‘a/’ 仅匹配 a 文件夹内的所有子文件；正则： new RegExp(^/a/([^/])$)

‘a/**/.js’ 匹配 a 文件夹内的所有以 .js 为后缀的文件；正则： new RegExp(^/a/([^/]).js$)

‘a/.js’ 仅匹配 a 文件夹内的所有以 .js 为后缀的子文件；正则： new RegExp(^/a/([^/]).js$)