ghc-tags: Utility for generating ctags and etags with GHC API.

[ development, mpl, program ] [ Propose Tags ]

Utility for generating etags (Emacs) and ctags (Vim and other editors) with GHC API for efficient project navigation.


[Skip to Readme]
Versions [RSS] [faq] 1.0, 1.1, 1.2, 1.3
Change log CHANGELOG.md
Dependencies aeson, async, attoparsec, base (>=4.14 && <5), bytestring, containers, deepseq, directory, filepath, ghc, ghc-boot, ghc-lib (==9.0.*), ghc-paths, optparse-applicative, process, stm, temporary, text, time, unordered-containers, vector, yaml [details]
License MPL-2.0
Copyright (c) 2021, Andrzej Rybczak
Author Andrzej Rybczak
Maintainer andrzej@rybczak.net
Category Development
Home page https://github.com/arybczak/ghc-tags
Bug tracker https://github.com/arybczak/ghc-tags/issues
Source repo head: git clone https://github.com/arybczak/ghc-tags
Uploaded by arybczak at 2021-05-18T19:46:48Z
Distributions NixOS:1.3
Executables ghc-tags
Downloads 195 total (11 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs not available [build log]
Last success reported on 2021-05-19 [all 3 reports]

Flags

NameDescriptionDefaultType
ghc-lib

Use ghc-lib even when compiling with compatible GHC version.

DisabledManual

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Candidates


Readme for ghc-tags-1.1

[back to package description]

ghc-tags

Build Status Hackage

A command line tool that generates etags (Emacs) and ctags (Vim and other editors) for efficient code navigation (jump to definition).

Main features:

  • Leverages GHC API to obtain accurate information.
  • Uses multiple CPU cores when processing source files.
  • Supports fast incremental updates.

Supported file extensions:

  • .hs
  • .hs-boot
  • .lhs
  • .x (requires alex)
  • .hsc (requires hsc2hs)

Usage

For simple projects, i.e. the ones that don't use C pre-processor in non-trivial ways nor include any C sources it should be enough to execute ghc-tags -e (for etags) or ghc-tags -c (for ctags) in the root directory of the project.

For more complicated projects you need to create the configuration file (ghc-tags.yaml by default). It can contain the following keys:

  • source_paths - a list of paths for ghc-tags to process. Directories are traversed recursively.
  • exclude_paths - a list of paths for ghc-tags to exclude from processing.
  • language - the flavour of Haskell, either Haskell98 or Haskell2010.
  • extensions - a list of GHC language extensions to enable when parsing. Note that GHC needs much less extensions for parsing alone, so you should almost never need to override this.
  • cpp_includes - include paths for the C pre-processor.
  • cpp_options - other options for the C pre-processor, e.g. defines (usually undefined MIN_VERSION_x macros will go here).

If any of these keys is not specified, an appropriate default value will be picked instead. You can inspect the defaults by executing ghc-tags --default.

Note: it is possible to specify multiple project configurations in the configuration file by separating them with ---. For example, here is a configuration for GHC on Linux (compiler, utils and base):

source_paths:
- compiler

cpp_includes:
- _build/stage1/compiler/build
- compiler
- includes/dist-derivedconstants/header

---

source_paths:
- libraries/base

exclude_paths:
- libraries/base/GHC/Conc/POSIX/Const.hsc
- libraries/base/GHC/Event/Windows.hsc
- libraries/base/GHC/Event/Windows/ConsoleEvent.hsc
- libraries/base/GHC/Event/Windows/FFI.hsc
- libraries/base/GHC/IO/Windows/Handle.hsc
- libraries/base/System/CPUTime/Windows.hsc
- libraries/base/tests

cpp_includes:
- _build/stage1/libraries/base/build/include
- includes
- libraries/base/include

---

source_paths:
- libraries/ghc-bignum

exclude_paths:
- libraries/ghc-bignum/src/GHC/Num/Backend/Selected.hs

cpp_includes:
- libraries/ghc-bignum/include

---

source_paths:
- libraries/ghc-boot
- libraries/ghc-boot-th
- libraries/ghc-compact
- libraries/ghc-heap
- libraries/ghc-prim

exclude_paths:
- libraries/ghc-compact/tests
- libraries/ghc-heap/tests
- libraries/ghc-prim/tests

Acknowledgments

Thanks to Marcin Szamotulski for his work on ghc-tags-plugin ghc-tags is based on.