https://github.com/migamake/homplexity

Haskell code complexity and quality measurement
https://github.com/migamake/homplexity

code-quality complexity hackage hacktoberfest2019 haskell quality

Last synced: about 2 months ago
JSON representation

Haskell code complexity and quality measurement

• Host: GitHub
• URL: https://github.com/migamake/homplexity
• Owner: migamake
• License: bsd-3-clause
• Created: 2015-04-19T05:14:24.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2023-01-25T03:22:11.000Z (almost 2 years ago)
• Last Synced: 2024-11-12T10:46:24.405Z (2 months ago)
• Topics: code-quality, complexity, hackage, hacktoberfest2019, haskell, quality
• Language: Haskell
• Size: 1.3 MB
• Stars: 61
• Watchers: 7
• Forks: 15
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md
  • License: LICENSE

Awesome Lists containing this project

README

        
homplexity

==========

**The project moved to https://gitlab.com/migamake/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](http://hackage.haskell.org/package/haskell-src-exts),

and [cppHs](http://hackage.haskell.org/package/cppHs).

Cabal builds across GHC versions:

![Gitlab pipeline status](https://img.shields.io/gitlab/pipeline/migamake/homplexity.svg)

[![Hackage](https://img.shields.io/hackage/v/homplexity.svg)](https://hackage.haskell.org/package/homplexity)

[![Hackage Dependencies](https://img.shields.io/hackage-deps/v/homplexity.svg?style=flat)](http://packdeps.haskellers.com/feed?needle=homplexity)

If you just need latest static executable [it is always available here](https://hub.docker.com/r/migamake/homplexity).

Official releases are on [Hackage](https://hackage.haskell.org/package/homplexity)

[![Gitter](https://badges.gitter.im/homplexity/community.svg)](https://gitter.im/homplexity/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

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.

For html output, run:

```

    homplexity --format=HTML Main.hs src/ 

```

How does it work?

-----------------

Homplexity is based on the idea of `Metric`s 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](https://raw.githubusercontent.com/mgajda/homplexity/master/docs/concepts.png)

![Legend of the diagram](https://raw.githubusercontent.com/mgajda/homplexity/master/docs/legend.png)