Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smoeding/puppet-global-plugin
A GNU global plugin to parse Puppet manifests
https://github.com/smoeding/puppet-global-plugin
gnu-global puppet source-code tagging
Last synced: 18 days ago
JSON representation
A GNU global plugin to parse Puppet manifests
- Host: GitHub
- URL: https://github.com/smoeding/puppet-global-plugin
- Owner: smoeding
- License: gpl-3.0
- Created: 2018-07-21T06:09:43.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-09-20T17:16:12.000Z (over 6 years ago)
- Last Synced: 2024-11-16T12:26:01.283Z (3 months ago)
- Topics: gnu-global, puppet, source-code, tagging
- Language: C
- Size: 36.1 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# puppet-global-plugin
A GNU global plugin to parse Puppet manifests
## Building
Note: This has only be tested on Debian 9 (Stretch)!
You will need autoconf/automake/libtool to build the plugin. Run the following comands in the top level directory:
``` shellsession
autoreconf -i -f -I m4
./configure --prefix=/usr
make
```
This will build the plugin. You can ignore the message about `aclocal` not being able to find the `m4` directory.
Optionally you can now also run the tests:
``` shellsession
make check
```
Then run `make install` as `root` to install the plugin:
``` shellsession
make install
```
The `configure` script used `--prefix=/usr` and therefore the plugin will be installed in `/usr/lib/gtags` where GNU global expects the files on Debian.
The installation also creates `/usr/lib/gtags/puppet.la`. This file is not used on Debian and can be deleted if you care.
## Setup
Create the file `~/.globalrc` with the following content:
``` text
# Configuration file for GNU GLOBAL source code tag system.
#
# Please refer to gtags.conf(5) for details.
#
default:\
:tc=native:tc=puppet:
native:\
:tc=gtags:tc=htags:
ctags:\
:tc=htags:
#---------------------------------------------------------------------
# Configuration for gtags(1)
# See gtags(1).
#---------------------------------------------------------------------
common:\
:skip=tags,TAGS,gtags.files,*.orig,*.rej,*.bak,*~,#*#,*.swp,*.tmp,*.zip,*.gz,*.bz2,*.xz,*.lzh,*.Z,*.tgz:
#
# Built-in parsers.
#
gtags:\
:tc=common:\
:tc=builtin-parser:
#
builtin-parser:\
:langmap=c\:.c.h,yacc\:.y,asm\:.s.S,java\:.java,cpp\:.c++.cc.hh.cpp.cxx.hxx.hpp.C.H,php\:.php.php3.phtml:
#
# Puppet
#
puppet|Puppet plugin parser:\
:tc=common:\
:langmap=puppet\:.pp:\
:gtags_parser=puppet\:$libdir/gtags/puppet.so:
#---------------------------------------------------------------------
# Configuration for htags(1)
#---------------------------------------------------------------------
htags:\
::
```
This instructs GNU global to use the plugin for Puppet manifests.