homplexity: Haskell code quality tool

[ bsd3, language, library, program, tools ] [ Propose Tags ]

Homplexity aims to measure code complexity, warning about fragments that might have higher defect probability due to bad coding style on-the-large:


[Skip to Readme]
Versions 0.2, 0.2.0.0, 0.3.0.0, 0.4.0.0, 0.4.1.0, 0.4.2.0, 0.4.3.0, 0.4.3.1, 0.4.3.2, 0.4.3.3, 0.4.3.4, 0.4.4.0, 0.4.4.1, 0.4.4.2, 0.4.4.3, 0.4.4.4 (info)
Change log changelog.md
Dependencies base (>=4.5 && <4.13), containers (>=0.3 && <0.7), cpphs (>=1.5 && <1.21), deepseq (>=1.3 && <1.7), directory (>=1.1 && <1.4), filepath (>=1.2 && <1.5), haskell-src-exts (>=1.18 && <1.21), hflags (>=0.3 && <0.5), homplexity, pqueue, template-haskell (>=2.6 && <2.16), uniplate (>=1.4 && <1.7) [details]
License BSD-3-Clause
Copyright Copyright by Michal J. Gajda '2015-'2018
Author Michal J. Gajda
Maintainer mjgajda@gmail.com
Category Language, Tools
Home page https://github.com/mgajda/homplexity
Bug tracker https://github.com/mgajda/homplexity/issues
Source repo head: git clone https://github.com/mgajda/homplexity.git
Uploaded by MichalGajda at Wed Dec 5 21:25:06 UTC 2018
Distributions NixOS:0.4.4.3
Executables homplexity-cli
Downloads 2835 total (179 in the last 30 days)
Rating 1.25 (votes: 1) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]
Hackage Matrix CI

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for homplexity-0.4.4.4

[back to package description]

homplexity

Aims to assess complexity and quality of Haskell code by measuring relative length of declarations, their depth, and code-to-comment ratio.

For parsing it uses haskell-src-exts, and cppHs.

Builds across GHC versions: Build across GHC versions

Builds with Stack: CircleCI (all branches)

Shippable CI: Run Status

GitLab CI: Gitlab pipeline status

Hackage Hackage Dependencies

If you just need latest static executable it is always available here.

Official releases are on Hackage

USAGE:

After installing with cabal install homplexity, you might run it with filenames or directories with your Haskell source

    homplexity Main.hs src/ 

Patches and suggestions are welcome.

You may run homplexity --help to see options.

How does it work?

Homplexity is based on the idea of Metrics that are applied to various CodeFragment types extracted automatically from parsed source. Each metric is then assessed whether it crosses any thresholds, and depending on them the severity of the message is chosen.

To see all metric values, set the warning --severity to INFO.

Diagram of concepts Legend of the diagram