geoxing/cqc

Code Quality Checker - Check your code quality by running one command.

Code Quality Checker

Check your code quality by running one command.

Supported Languages

• js, jsx
• css, less, scss, sass, styl

Getting Started

Installation

npm install -g cqc

Usage

cqc src/**/*.js src/**/*.jsx

Output:

Number of files:        10
Source lines of code:   647
Duplicate rate:         3.46%
High complexity rate:   0.00%
Max complexity:         10

Options

Option	Type	Default	Description
Files options
--ignore-path	path		Specify path of ignore file
--ignore-pattern	pattern		Pattern of files to ignore
--filter-pattern	pattern		Output percentage of all files but only details that related to the filter pattern
Script options
--jscpd-min-lines	number	5	Set the min size of duplication in code lines
--jscpd-min-tokens	number	70	Set the min size of duplication in code tokens
--complexity-max	number	10	Set the allowed max complexity of a function
Disable options
--disable-base			Disable base checker
--disable-sloc			Disable sloc checker
--disable-jscpd			Disable jscpd checker
--disable-complexity			Disable complexity checker
Reporter options
-f, --format	string		Specify an output format. Supported format: json
--verbose			Verbose mode. A lot more information output
--threshold-jscpd	number		Set the jscpd threshold, process will exit if duplicate rate is more than threshold
--threshold-complexity	number		Set the complexity threshold, process will exit if complexity rate is more than threshold

Examples:

Set the ignore file path

cqc src/**/*.js --ignore-path ".gitignore,.eslintignore"

Ignore vendors and third-party libraries

cqc src/**/*.js --ignore-pattern "src/vendor/**/*.js,src/third-party/**/*.js"

Output json format

cqc src/**/*.js --format json

Output:

{
    "base": {
        "numberOfFiles": 10
    },
    "sloc": {
        "source": 647
    },
    "jscpd": {
        "percentage": "3.46"
    },
    "complexity": {
        "percentage": "0.00",
        "max": 10
    }
}

Verbose mode

cqc src/**/*.js --verbose

Output:

Number of files: 10
File list:
    - E:\github\xcatliu\cqc\src\BaseChecker\index.js
    - E:\github\xcatliu\cqc\src\CheckerResult\cqcReporter.js
    - E:\github\xcatliu\cqc\src\CheckerResult\index.js
    - E:\github\xcatliu\cqc\src\CodeQualityChecker\index.js
    - E:\github\xcatliu\cqc\src\ComplexityChecker\eslintConfig.js
    - E:\github\xcatliu\cqc\src\ComplexityChecker\index.js
    - E:\github\xcatliu\cqc\src\JscpdChecker\getLanguageFromFilepath.js
    - E:\github\xcatliu\cqc\src\JscpdChecker\index.js
    - E:\github\xcatliu\cqc\src\JscpdChecker\jscpdReporter.js
    - E:\github\xcatliu\cqc\src\SlocChecker\index.js

Physical lines:             800
Source lines of code:       647
Comments:                   36
Single-line comments:       36
Block comments:             0
Mixed source and comments:  0
Empty lines:                117
TODO's:                     1

Duplicate rate:             3.46%
Files of duplicated code:   3
Count of duplicated code:   2
Lines of duplicated code:   28
Duplication details:
    - E:\github\xcatliu\cqc\src\CheckerResult\cqcReporter.js: 150-154
      E:\github\xcatliu\cqc\src\CheckerResult\cqcReporter.js: 156-160
    - E:\github\xcatliu\cqc\src\JscpdChecker\index.js: 41-63
      E:\github\xcatliu\cqc\src\JscpdChecker\jscpdReporter.js: 22-44

High complexity rate:       0.00%
High complexity count:      0
Max complexity:             10

Set the jscpd threshold

cqc src/**/*.js --threshold-jscpd 3

Output:

Number of files:        10
Source lines of code:   646
Duplicate rate:         3.46%
High complexity rate:   0.00%
Max complexity:         10

Oops, duplicate rate is MORE than threshold 3%, please check the details by adding --verbose option.

API

It's also able to use cqc as a node module:

const CodeQualityChecker = require('cqc');
const codeQualityChecker = new CodeQualityChecker();

// This will return a checkerResult object which include the check result
const cqcResult = codeQualityChecker.check([
    'src/**/*.js',
    'src/**/*.jsx'
], {
    ignorePath: '.gitignore,.eslintignore',
    ignorePattern: 'src/vendor/**/*.js,src/third-party/**/*.js',
    filterPattern: 'src/path/to/filterPattern',

    jscpdMinLines: 5,
    jspcdMinTokens: 70,
    complexityMax: 10,

    disableBase: false,
    disableSloc: false,
    disableJscpd: false,
    disableComplexity: false,

    format: undefined,
    verbose: true,
    thresholdJscpd: 3,
    thresholdComplexity: 10
});

// Calling report function will console.log result like cli did
cqcResult.report({
    format: undefined,
    verbose: true,
    thresholdJscpd: 3,
    thresholdComplexity: 10
});

Concept Definition

Concept	Definition
Number of files	The number of input files
Source lines of code	The lines of code except commants and blank lines
Lines of duplicated code	Lines of code (more than 5 lines or more than 70 tokens) which is exactly the same between two files, or in different place of one file
Duplicate rate	Lines of duplicated code / Source lines of code
Complexity	https://en.wikipedia.org/wiki/Cyclomatic_complexity
High complexity rate	The number of files which has complexity more than 10 / Number of files
Max complexity	The highest complexity of all input files

Troubleshootings

Why cqc src/**/*.js only identify the files under two-level dir?

Some shell has different behavior between others. Please try to wrap the pattern by quotes:

cqc "src/**/*.js"