https://github.com/tkonolige/ctags-shim
https://github.com/tkonolige/ctags-shim
ctags
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tkonolige/ctags-shim
- Owner: tkonolige
- License: bsd-3-clause
- Created: 2016-01-29T22:43:44.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-04-14T23:10:40.000Z (over 8 years ago)
- Last Synced: 2025-06-04T22:47:13.917Z (4 months ago)
- Topics: ctags
- Language: Haskell
- Size: 5.86 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ctags-shim
This is a simple program that bundles a variety of tag generating binaries into one command. It can easily be extended via a config file.
`ctags-shim` ignores files listed in `.gitignore`.
## Config file
The default ctags-shim config is located at `~/.ctags-shim.yaml` and has a format like below:
```yaml
excludes:
- dist
- .git
- Setup.hs
executables:
- ctags:
flags:
- "-f -"
extensions:
- cpp
- c
- h
- hpp
- py
- hothasktags:
extensions:
- hs
```
The `excludes` section is a list of glob patterns to be ignored when `ctags-shim` recurses through directories.
## Installing
You need GHC and cabal for installation.
```
> git clone https://github.com/tkonolige/ctags-shim.git
> cd ctags-shim
> cabal install
```
The default install location is `~/.cabal/bin`. You probably want to add this to your `$PATH`.
## Adding a tags generator
To add a new generator, add a new entry under the `executables` section of the config. The format should be:
```yaml
executables:
- my_binary
flags:
- "-f -"
extensions:
- my_filetype
```
The `flags` section is passed to the binary everytime it is called. The binary should output to stdout and should not recurse.