The package-o-tron package

[Tags: bsd3, library, program]

Utility to help managing Makefiles for Haskell projects, a cabal lint which can check the other-modules and build-deps sections in your cabal files, and a quick command that can show the direct package dependencies of a set of Haskell source files. See the README in the repo for more information: https://github.com/JakeWheat/package-o-tron.


[Skip to ReadMe]

Properties

Version0.1.0.0
Change logNone available
Dependenciesbase (==4.*), Cabal, filemanip, filepath, groom, packdeps, process [details]
LicenseBSD3
CopyrightJake Wheat 2012
AuthorJake Wheat
Maintainerjakewheatmail@gmail.com
CategoryDevelopment
Source repositoryhead: git clone https://github.com/JakeWheat/package-o-tron.git
ExecutablesShowPackages, CabalLint, Makefilerize
UploadedFri Oct 5 22:10:54 UTC 2012 by JakeWheat
DistributionsNixOS:0.1.0.0
Downloads249 total (9 in last 30 days)
Votes
0 []
StatusDocs uploaded by user
Build status unknown [no reports yet]

Modules

[Index]

Downloads

Maintainers' corner

For package maintainers and hackage trustees

Readme for package-o-tron-0.1.0.0

Package-o-tron is a collection of utilities to help managing cabal
files for your projects, maintaining Makefiles and other build
systems, and also some which help with your package database.


The central code is a function which takes a list of folders, then
parses all the imports in all the haskell source in these folders. It
then creates the dependency information between the different files,
and the dependency on packages information (using ghc-pkg dump)


Currently implemented:

The Makefile in the package-o-tron package gives an example of how to
use package-o-tron to help manage a makefile for haskell projects,
using the Makefilerize command.

You could use a Makefile:

* to quickly develop when you have multiple .cabal projects and don't
  want to spend time reinstalling them when you do a rebuild (this can
  also be much faster if you use -j and have lots of executables)

* if you have files to compile as part of the development which aren't
  in a cabal package, or if you want to integrate with existing
  Makefiles, e.g. for mixed haskell/c projects.

See the Makefile and autorules.mk in the repo (link below) for an
example of how this works. This tool is used in the hssqlppp project
Makefile (https://github.com/JakeWheat/hssqlppp), see the Makefile and
autorules.mk there for another example.


CabalLint

CabalLint will check the following issues in your cabal file:

*  missing and superfluous other-modules and build-deps in library,exe
   and test sections

*  version ranges which exclude the latest versions of a build-dep
   (just uses packdeps from hackage)

run it like this:
CabalLint package-o-tron.cabal
No output means everything OK


ShowPackages

Run on a set of source folders, and it will show you all the packages
referenced by the source in those folders



Planned utils:

Showpackages: extend to show indirectly depended on packages as well

blessed package set creation: run on some folders to get a package
list. Then it follows the package dependencies to get all the needed
non-system packages. Then it looks in your .cabal and copies out the
tarballs for all these packages. Now you can create a fresh install in
a sandbox or fresh machine without needing an internet connection, or
worrying about if hackage is down, or if the latest set of packages
don't install.

Cabal build testing

Use sandboxing to check the sdists from a .cabal install without error
and if there are tests they run and pass. The sandboxing is used to
check a range of versions of ghc crossed with the lowest and latest
versions of the dependencies listed in the .cabal. Later, maybe this
can be extended to search earlier versions of dependencies to get more
accurate lower bounds.

Package database lint:

check your ghc package database for the following issues:
duplicate packages installed
packages which aren't the latest versions installed
not sure how to automatically help with these situations though

Third party cabal install checker:

run a wrapper around cabal-install ... --dry-run. reports:
any reinstalls (easy since cabal already does this)
any different versions of already installed packages would be
  installed
any versions of packages which aren't the latest of those packages
  would be installed

Third party cabal file hacker:

when you try to install a lot of packages, and some of them have
version constraints on their dependencies which lead to another
package being installed not at the latest version: this will cabal
unpack the offending packages and alter their constraints to allow all
the latest versions of packages automatically. Not completely safe of
course, but I always end up doing this manually and it is really
tedious.



Repository: https://github.com/JakeWheat/package-o-tron

Contact: jakewheatmail@gmail.com