sabik

Source code metrics tool.

Usage no npm install needed!

<script type="module">
  import sabik from 'https://cdn.skypack.dev/sabik';
</script>

README

Sabik

This project is under development.

Please feel free to PullRequest and Issue.

ci-build Known Vulnerabilities Coverage Badge LogicalLineOfCode(Average per method) CognitiveComplexity(Max) Maintainability(Min)

Visualize source code complexity with Sabik. This tool is to find the bad smell code. I think your helpful refactoring.

If you want to see what it looks like, click here.

Basic Using

$ npx sabik /target/path

Local installation

If you felt sabik is slow, using local installation.

$ npm i -g sabik

Using sabik with local installed

$ sabik /target/path

Help

USAGE
  $ sabik [TARGET]

OPTIONS
  -h, --help                               show CLI help

  -o, --outputReportPath=outputReportPath  output report path.
                                                 For HTML, specify the directory, and for JSON, specify the file.

  -t, --outputFormat=(HTML|JSON)           [default: HTML] output report format. HTML or JSON. default: HTML

  -v, --version                            show CLI version

  --excludes=excludes                      [default: $^] exclude patterns is separated by a comma. example: .test.ts$,.spec.ts$

  --matches=matches                        [default: .*] match patterns. example: .ts$

Support Programming Language

  • TypeScript
  • JavaScript
  • PHP < 8.0

For now.

What analyzable metrics?

Sabik analyzable metrics are following.

  • Cognitive Complexity
  • Halstead complexity measures
  • Line of Code(Logical, Physical)
  • Maintainability

For now.

Cognitive Complexity

Cognitive Complexity is metrics for human readability. Made SonarSource inc. High is bad, low is good metrics. Higher when your code has a deep nest. It’s read very hard when over 8 scores. (In my experience)

If you want to know more about the detail, please see the following.

CognitiveComplexity

Halstead complexity measures

Halstead complexity measures are metrics for a difficulty to understand. Made Maurice Howard Halstead. High is bad, low is good metrics. Higher when your code has many responsibilities. These metrics are judge difficulty from vocabulary size, for example, the newspaper is difficult but, children's book is easy to understand.

If you want to know more about the detail, please see the following.

Halstead complexity measures

Line of Code(Logical, Physical)

Physical Line of Code is metrics for line count include comments. Logical Line of Code is metrics for line count ignored comments. High is bad, low is good metrics.

Maintainability

Maintainability is metric for software maintainability. Made Microsoft inc. Low is bad, High is good metrics. This metric ranges from 0 ~ 100. It’s maintenance hard when under 60 scores. (In my experience) This metrics is normally using the following, calculate.

  • Line of Code
  • Halstead metrics
  • Cyclomatic Complexity

But in Sabik using following.

  • Line of Code
  • Halstead metrics
  • Cognitive Complexity

If you want to know more about the detail, please see the following.

Maintainability

License

Copyright (c) 2020 Tetsuro Yoshikawa Licensed under the MIT license.