tokei-js

Tokei 的 Node.js 封装。

安装

# 使用 NPM
$ npm i tokei-js

# 使用 Yarn
$ yarn add tokei-js

使用

new Tokei(options)

实例化 Tokei。

• options {Object}
  • format {String} 代码行数报告输出格式
  • exclude {String|Array} 文件或文件夹忽略规则
• 返回: {Tokei} 一个 Tokei 实例

tokei.loc(target)

异步方法。

• target {String} 目标文件或文件夹
• 返回: {Promise} 目标文件或文件夹内所有文件的代码行数报告

import Tokei from 'tokei-js';

(async () => {
  const tokei = new Tokei({
    format: 'yaml',
    exclude: ['*.md', '*.json'],
  });

  const locResult = await tokei.loc(process.cwd());
})();

tokei.locSync(target)

同步方法。

• target {String} 目标文件或文件夹
• 返回: {JSON|YAML|TOML|CBOR} 目标文件或文件夹内所有文件的代码行数报告，具体返回怎样的格式取决于实例化时的设置

import Tokei from 'tokei-js';

const tokei = new Tokei({
  format: 'yaml',
  exclude: ['*.md', '*.json'],
});

const locResult = tokei.locSync(process.cwd());

贡献指南

仔细查阅 CONTRIBUTING.md 以了解详情。

证书

tokei-js 获得了 MIT 许可，仔细查阅 LICENSE.md 以了解详情。