nodejs版本程式碼註釋率統計上新啦~~~

小云菜發表於2020-05-31
NodeJS

github連結在這

Installation

$ npm install jscrs -g

Usage

$ npx jscrs

or

$ jscrs

options

不建議使用自定義配置

config

配置檔案，該檔案必須是json格式。配置檔案支援的選項與cli options相同

  • Cli options： --config, -c
  • Type: path
  • Default: null

比如自定義配置檔案

$ jscrs -c /config/jscrs/config.json

Ignore case

是否啟用忽略.gitignore檔案內相關檔案和目錄的功能

  • Cli options: --gitignore, --g,
  • Type: boolean
  • Default false

Output

生成html和json報告的輸出路徑

  • Cli options: --output, -o
  • Type: path
  • Default: ./report/

config file

強烈建議

請在專案根目錄下新建.cr.config.json檔案，並寫入自定義內容

{
  "ext": [
    "ts",
    "tsx",
    "js",
    "jsx",
    "vue",
    "html",
    "md" // md文件算作註釋
  ],
  "path": [
    "/src"
  ],
  "ignore":[
    "/dist/**",
    "dest/**",
    "./node_modules/**",
    "test/**",
    "data/**",
    "src/doc/**",
    "doc",
    "entries/",
  ]
}

如果不新增該檔案，且未在bash命令中指定自定義檔案位置，使用預設配置項，預設項主要為以下內容

{
    ext: [
      'ts',
      'tsx',
      'js',
      'jsx',
      'vue',
      'html',
      'css',
      'less',
      'scss'
    ],
    path: [process.cwd()],
    ignore: [
      '/dist/**',
      'dest/**',
      './node_modules/**',
      'test/**',
      'data/**',
      'src/doc/**',
      'doc',
      'entries/'
    ],
    reports: ['console', 'html', 'json'],
    gitignore: false,  // 預設不啟用該功能
    output: './report' // 預設輸出目錄
  }

JSCRS Reporters

支援console, html, json

API

提供API方便整合

import {
  IOptions,
  IAnalysis,
  IReport,
  analysis
} from 'jscrs';

const options: IOptions = {};

const ana: IAnalysis = new analysis(options);

/**@return IReport*/
const report: IReport = ana.statisticCommentRate();

/**IReport to log*/
ana.generateReports();

相關文章