1.0.0 • Published 5 years ago

c-scan v1.0.0

Weekly downloads
8
License
ISC
Repository
github
Last release
5 years ago

code-scan

自定义规则扫描代码,返回路径名称。

使用方法:

const scan = require('scan');
scan({
    extensions:'**/*.js',
    rootPath:'src',
    defalutIgnore:'true',
    ignoreRules:[],
    ignoreFileName:'.gitignore'
});

param列表:

extensions

  • 扫描文件扩展名
  • 默认值:**/*.js

rootPath

  • 扫描文件路径
  • 默认值:.

defalutIgnore

  • 是否开启默认忽略(glob规则)
  • glob ignore规则为内部使用,为了统一ignore规则,自定义规则使用gitignore规则
  • 默认值:true

默认开启的 glob ignore 规则:

const DEFAULT_IGNORE_PATTERNS = [
    'node_modules/**',
    'build/**',
    'dist/**',
    'output/**',
    'common_build/**'
];

ignoreRules

  • 自定义忽略规则(gitignore规则)
  • 默认值:[]

ignoreFileName

  • 自定义忽略规则配置文件路径(gitignore规则)
  • 默认值:.gitignore
  • 指定为null则不启用ignore配置文件