https://github.com/ytetsuro/sabik

Visualize source code complexity with Sabik. This tool is to find the bad smell code. I think your helpful refactoring.
https://github.com/ytetsuro/sabik

analytics cli-tool cognitive-complexity complexity difficulty hack hacktoberfest halstead-complexity-measures halstead-metrics javascript maintainability metrics php report typescript visualizer

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/ytetsuro/sabik
• Owner: ytetsuro
• License: mit
• Created: 2020-11-13T12:34:35.000Z (over 4 years ago)
• Default Branch: develop
• Last Pushed: 2023-11-30T14:56:19.000Z (over 1 year ago)
• Last Synced: 2024-03-20T09:09:18.605Z (about 1 year ago)
• Topics: analytics, cli-tool, cognitive-complexity, complexity, difficulty, hack, hacktoberfest, halstead-complexity-measures, halstead-metrics, javascript, maintainability, metrics, php, report, typescript, visualizer
• Language: TypeScript
• Homepage:
• Size: 2.9 MB
• Stars: 39
• Watchers: 4
• Forks: 4
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Sabik](https://sabik.botch.me/images/sabik-visual.png)

===

This project is under development.

Please feel free to PullRequest and Issue.

---

![ci-build](https://github.com/ytetsuro/sabik/workflows/ci-build/badge.svg)

[![Known Vulnerabilities](https://snyk.io/test/github/ytetsuro/sabik/badge.svg)](https://snyk.io/test/github/ytetsuro/sabik)

![Coverage Badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/ytetsuro/32248b8c823155bb09711c7a5b960d3d/raw/sabik_coverage_heads_master.json)

![LogicalLineOfCode(Average per method)](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/ytetsuro/32248b8c823155bb09711c7a5b960d3d/raw/sabik_line_of_code_heads_master.json)

![CognitiveComplexity(Max)](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/ytetsuro/32248b8c823155bb09711c7a5b960d3d/raw/sabik_cognitive_complexity_heads_master.json)

![Maintainability(Min)](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/ytetsuro/32248b8c823155bb09711c7a5b960d3d/raw/sabik_maintainability_heads_master.json)

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](http://sabik.botch.me/example/).

* [Basic Using](#basic-using)

* [Support Programming Language](#support-programming-language)

* [What analyzable metrics?](#what-analyzable-metrics)

* [License](#license)

# Basic Using

Please use Node.js >= 14.

If you use Node.js 14 or less, please use version 0.2.0.

```sh-session

$ npx sabik /target/path

```

## Local installation

If you felt sabik is slow, using local installation.

```sh-session

$ npm i -g sabik

```

### Using sabik with local installed

```sh-session

$ sabik /target/path

```

## Help

```sh-session

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. example: .test.ts$ .spec.ts$

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

```

# Support Programming Language

* TypeScript

* JavaScript

* PHP

For now.

# What analyzable metrics?

Sabik analyzable metrics are following.

* Cyclomatic Complexity

* Cognitive Complexity

* Halstead complexity measures

* Line of Code(Logical, Physical)

* Maintainability

For now.

## Cyclomatic Complexity

Cyclomatic Complexity is metrics for linearly independent paths count.

Made Thomas McCabe.

High is bad, low is good metrics.

Higher when your code has a deep nest.

It’s very tiresome add test when over 8 scores. (In my experience)

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

[CyclomaticComplexity](https://en.wikipedia.org/wiki/Cyclomatic_complexity)

## 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](https://www.sonarsource.com/docs/CognitiveComplexity.pdf)

## 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](http://www.virtualmachinery.com/sidebar2.htm)

## 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)

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

[Maintainability](https://docs.microsoft.com/en-us/visualstudio/code-quality/code-metrics-maintainability-index-range-and-meaning?view=vs-2019)

# License

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