inventory: Project statistics and definition analysis

[ bsd3, library, program, utility ] [ Propose Tags ]

Please see the README on GitHub at https://github.com/aaronallen8455/inventory#readme


[Skip to Readme]
Versions [faq] 0.1.0.0, 0.1.0.1, 0.1.0.2, 0.1.0.3
Change log ChangeLog.md
Dependencies appendmap (>=0.1.5 && <0.2), array (>=0.5.4 && <0.6), base (>=4.7 && <5), bytestring (>=0.10.10 && <0.11), containers (>=0.6.2 && <0.7), directory (>=1.3.6 && <1.4), filepath (>=1.4.2 && <1.5), ghc (>=8.8 && <9.1), ghc-paths (>=0.1.0 && <0.2), inventory, mtl (>=2.2.2 && <2.3) [details]
License BSD-3-Clause
Copyright 2021 Aaron Allen
Author Aaron Allen
Maintainer aaronallen8455@gmail.com
Category Utility
Home page https://github.com/aaronallen8455/inventory#readme
Bug tracker https://github.com/aaronallen8455/inventory/issues
Source repo head: git clone https://github.com/aaronallen8455/inventory
Uploaded by aaronallen8455 at 2021-03-10T04:26:36Z
Distributions NixOS:0.1.0.3
Executables inventory
Downloads 199 total (9 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs uploaded by user
Build status unknown [no reports yet]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for inventory-0.1.0.3

[back to package description]

Inventory

This is a utility that provides a variety of statistics about your Haskell project. These include:

  • A list of type signatures that are shared among multiple locally defined functions, enumerating those functions along with their definition sites.
  • Lists of the most used and least used definitions in the project.
  • A breakdown of local definitions, telling you the number of each type of definition as well as how many lines of code they take up.

Using inventory

Install with stack update && stack install inventory or cabal update && cabal install inventory. The version used to compile inventory must be the same as the version used to compile your project. For stack users, this means you may have to stack install from within your project to use the right GHC.

Inventory uses .hie files to gather information about all haskell files in the project. Once you have generated .hie files for your project, execute inventory from your project's root.

How to generate .hie files

Cabal

Add this to your cabal.project.local file:

package *
  ghc-options: -fwrite-ide-info -hiedir=.hie

Then do a full rebuild of the project:

cabal clean
cabal build all

Stack

Add this to your stack.yaml file:

ghc-options:
  "$locals": -fwrite-ide-info
             -hiedir=.hie

Then do a full rebuild:

stack clean
stack build

By default inventory looks for HIE files in the .hie directory. You can override this using the HIE_DIR environment variable: HIE_DIR=path/to/dir inventory.

Examples

Here are some excerpts of the output that was produced by running inventory on the stack codebase:

Definition counts

Definiton counts image

Most used definitions

Most used image

Matching type signatures

Equivalent signatures image

The output for matching signatures can be useful for discovering functions that are duplicates of one another. For instance, the packageIdent and packageIdentifier functions in the above output turned out to be duplicates.

Known Issues/Limitations

  • Context such as constraints and foralls do not appear in the printed type signatures for GHC versions less than 9.0.1.
  • Standalone kind signatures are not yet included in definition counts.
  • Does not unfold type synonyms when comparing type signatures.
  • GHC versions other than 8.8, 8.10, and 9.0 are not currently supported.