homplexity

Haskell code quality tool

https://github.com/mgajda/homplexity

Version on this page:0.4.3.4
LTS Haskell 7.24:0.4.3.3
Stackage Nightly 2017-01-17:0.4.3.4
Latest on Hackage:0.4.8.1

See all snapshots homplexity appears in

BSD-3-Clause licensed by Michal J. Gajda
Maintained by [email protected]
This version can be pinned in stack with:homplexity-0.4.3.4@sha256:a26f2751339c73cd0e4d8768dd18bd47267d9fa79944b1c00f4d5e15022b8d64,3549

Module documentation for 0.4.3.4

There are no documented modules for this package.

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.

Build Status Hackage Hackage Dependencies

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

Changes

Changelog

0.4.3.4  July 2016

    * Updated for haskell-src-exts-1.18.
      This release is backwards incompatible with old haskell-src-exts before 1.18.

0.4.3.3  May 2016

    * Updated bounds again.

0.4.3.2  May 2016

    * Updated deps.

0.4.3.1  Feb 2016

    * Updated bounds for GHC 8.0.

0.4.3.0  Jun 2015

    * Thanks to Mikolaj Konarski for fixing an embarrassing eternal loop due to biplate quirk.

0.4.2.0  Jun 2015

    * Compatible with GHC 7.8.

0.4.1.0  Jun 2015

    * Corrected embarassing missing module.
    * Better documentation, cleanup.

0.4.0.0  Jun 2015

    * Added number of arguments, and constructor depth.

0.3.0.0  Jun 2015

    * Configurable thresholds.

0.2.0.0  Jun 2015

    * First release on Hackage.

0.1.0.1  Jun 2015

    * First successful Travis builds. (Took a while du  to changes in Happy,
    that prevented haskell-src-exts from building.

0.1.0.0  Apr 2015

    * Put source code on GitHub.