BSD3 licensed by Michal J. Gajda
Maintained by mjgajda@gmail.com

Module documentation for 0.4.3.3

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.

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

Changes

Changelog

0.4.4.4  Nov 2018
    * Fix missing pattern for InfixMatch.

0.4.4.3  Nov 2018
    * Fixed wrong base bounds for tests.

0.4.4.2  Nov 2018
    * Releases on GitHub release page
    * Automated Docker build

0.4.4.1  Nov 2018
    * Fix crashes on unnamed modules, and XML pages

0.4.4.0  Nov 2018
    * Relax dependencies for GHC up to 8.6
    * Build as a library

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.
comments powered byDisqus