fix-imports: Program to manage the imports of a haskell module

[ bsd3, editor, haskell, ide, program ] [ Propose Tags ]

`fix-imports` is a small standalone program to manage the import block of a haskell program. It will try to add import lines for qualified names with no corresponding import, remove unused import lines, and keep the import block sorted, with optional rules for grouping.

Support for unqualified imports is limited to symbols you explicitly configure, so if you list `System.FilePath.(/)`, it will add that import when you use it, or remove when it's no longer used, but it won't go search modules for unqualified imports.

It doesn't mess with non-managed unqualified imports, so you can still use unqualified imports, you just have to do it manually.

Since it's a unix-style filter, it should be possible to integrate into any editor. There's an example vimrc to bind to a key in vim.


[Skip to Readme]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

Versions [RSS] 0.1.0, 0.1.1, 0.1.2, 0.1.3, 1.0.0, 1.0.1, 1.0.2, 1.0.3, 1.0.4, 1.0.5, 1.1.0, 2.1.0, 2.2.0, 2.3.0, 2.4.0
Change log changelog.md
Dependencies base (>=3 && <5), Cabal, containers, cpphs, deepseq, directory, filepath, ghc-lib-parser (==9.2.5.20221107), ghc-lib-parser-ex (==9.2.1.1), ghc-paths, mtl, pretty, process, split, text, time, uniplate [details]
License BSD-3-Clause
Author Evan Laforge
Maintainer Evan Laforge <qdunkan@gmail.com>
Category Editor, Haskell, IDE
Source repo head: git clone git://github.com/elaforge/fix-imports.git
Uploaded by EvanLaforge at 2023-04-06T06:22:24Z
Distributions
Reverse Dependencies 1 direct, 0 indirect [details]
Executables fix-imports
Downloads 10552 total (29 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs not available [build log]
Last success reported on 2023-04-06 [all 1 reports]

Readme for fix-imports-2.4.0

[back to package description]

fix-imports is a small standalone program to manage the import block of a haskell program. It will try to add import lines for qualified names with no corresponding import, remove unused import lines, and keep the import block sorted, with optional rules for grouping.

Support for unqualified imports is limited to symbols you explicitly configure, so if you list System.FilePath ((</>)), it will add that import when you use it, or remove when it's no longer used, but it won't go search modules for unqualified imports.

It doesn't mess with non-managed unqualified imports, so you can still use unqualified imports, you just have to do it manually.

Since it's a unix-style filter, it should be possible to integrate into any editor. There's an example vimrc to bind to a key in vim.

Usage:

Normally you would integrate it with your editor (see vimrc for a vim example), but for testing, here's an example invocation:

fix-imports -i src -i test src/A/B/C.hs <src/A/B/C.hs
[ fixed contents of A/B/C.hs, or an error ]

The -i flag is like ghc's -i flag, it will add an aditional root to the module search path. The example will find modules in both test/* and src/*, in addition to the package db.

fix-imports will look for .ghc.environment.* in the current directory and use it for pkgs to search. This is created by cabal v2, but only if you have write-ghc-environment-files: always in cabal.project. Otherwise, it assumes cabal v1 and will use the ghc-pkg command to use the global package db.

If it doesn't seem to see packages you think it should, run with --debug to see what it sees.

I don't use stack, but my understanding is this is enough to get ghc-pkg working:

export GHC_PACKAGE_PATH=$(stack path --ghc-package-path)