hsimport: A command line program for extending the import list of a Haskell source file.

[ bsd3, development, library, program, utils ] [ Propose Tags ] [ Report a vulnerability ]

A command line program for extending the import list of a Haskell source file.

[Skip to Readme]

Modules

[Index]

HsImport

Downloads

hsimport-0.3.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

fendor

For package maintainers and hackage trustees

edit package information

Candidates

No Candidates

Versions [RSS]	0.1, 0.1.1, 0.2, 0.2.1, 0.2.2, 0.2.3, 0.2.4, 0.2.5, 0.2.6, 0.2.6.1, 0.2.6.2, 0.2.6.3, 0.2.6.4, 0.2.6.5, 0.2.6.6, 0.2.6.7, 0.2.6.8, 0.2.7, 0.2.8, 0.2.9, 0.2.10, 0.2.11, 0.3, 0.4, 0.5, 0.5.1, 0.5.2, 0.6, 0.6.1, 0.6.2, 0.6.3, 0.6.4, 0.6.5, 0.6.6, 0.6.7, 0.7, 0.7.1, 0.8.0, 0.8.1, 0.8.2, 0.8.3, 0.8.4, 0.8.5, 0.8.6, 0.8.8, 0.9.0, 0.10.0, 0.11.0
Dependencies	attoparsec (>=0.10.4.0 && <0.12), base (>=3 && <5), cmdargs (>=0.10.5 && <0.11), directory (>=1.2.0.1 && <1.3), haskell-src-exts (>=1.14.0 && <1.15), hsimport, lens (>=3.9.2 && <4.2), mtl (>=2.1.2 && <2.2), split (>=0.2.2 && <0.3), text (>=0.11.3.1 && <1.2) [details]
License	BSD-3-Clause
Author	Daniel Trstenjak
Maintainer	daniel.trstenjak@gmail.com
Category	Utils
Source repo	head: git clone https://github.com/dan-t/hsimport
Uploaded	by DanielTrstenjak at 2014-03-23T11:25:52Z
Distributions
Reverse Dependencies	1 direct, 0 indirect [details]
Executables	hsimport
Downloads	37975 total (2 in the last 30 days)
Rating	(no votes yet) [estimated by Bayesian average]
Your Rating	λ λ λ
Status	Docs available [build log] Successful builds reported [all 1 reports]

Readme for hsimport-0.3

[back to package description]

hsimport

A command line program for extending the import list of a Haskell source file.

hsimport gets the module name and the symbol name to import as arguments, parses the given source file by using the library haskell-src-exts and than tries to only extend the import list if it's necessary. If the symbol is already imported or if the whole module is already imported, than the given source file isn't changed.

Installation

cabal install hsimport

Examples

$> hsimport -m 'Control.Monad' SomeSource.hs`
=> import Control.Monad

$> hsimport -m 'Control.Monad' -s 'when' SomeSource.hs
=> import Control.Monad (when)

$> hsimport -m 'Control.Monad' -q 'CM' SomeSource.hs
=> import qualified Control.Monad as CM

$> hsimport -m 'Data.Maybe' -s 'Maybe'
=> import Data.Maybe (Maybe)

$> hsimport -m 'Data.Maybe' -s 'Maybe' -a
=> import Data.Maybe (Maybe(..))

$> hsimport -m 'Data.Maybe' -s 'Maybe' -w 'Just'
=> import Data.Maybe (Maybe(Just))

$> hsimport -m 'Data.Maybe' -s 'Maybe' -w 'Just' -w 'Nothing'
=> import Data.Maybe (Maybe(Just, Nothing))

Text Editor Integration

vim-hsimport

Command Line Usage

$> hsimport --help
hsimport [OPTIONS] [SOURCEFILE]
  A command line program for extending the import list of a Haskell source
  file.

Common flags:
  -m --modulename=ITEM     The module to import
  -s --symbolname=ITEM     The symbol to import, if empty, the entire module
                           is imported
  -a --all                 All constructors or methods of the symbol should
                           be imported: 'Symbol(..)'
  -w --with=ITEM           The constructors or methods of the symbol
                           should be imported: 'Symbol(With)'
  -q --qualifiedname=ITEM  The name to use for a qualified module import
  -o --outputsrcfile=FILE  Save modified source file to file, if empty, the
                           source file is modified inplace
  -h --help                Display help message
  -v --version             Print version information

Issues

There is some rudimentarily handling for code using CPP, but the import statements might be added at the wrong place, because the lines containing CPP directives are ignored and therefore they aren't considered in the source line count.