https://github.com/gpanders/ztags
Generate tags files for Zig projects
https://github.com/gpanders/ztags
Last synced: about 15 hours ago
JSON representation
Generate tags files for Zig projects
- Host: GitHub
- URL: https://github.com/gpanders/ztags
- Owner: gpanders
- License: mit
- Created: 2022-05-31T19:55:36.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-06-25T16:23:17.000Z (10 months ago)
- Last Synced: 2024-06-26T17:40:49.107Z (10 months ago)
- Language: Zig
- Homepage: https://git.sr.ht/~gpanders/ztags
- Size: 113 KB
- Stars: 18
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ztags
Generate tags files for Zig projects.
Unlike `ctags`, this does not use regular expressions, but instead analyzes the
abstract syntax tree of the source code.
## Building
Clone this repository and build with `zig build` (Only Zig 0.13 is supported).
This will produce a `Debug` build by default, which generates useful error
messages but can be a bit slow. To build a release build use
```console
$ zig build -Doptimize=ReleaseSafe
```
To build the man page (requires [scdoc][]), run
```console
$ zig build docs
```
This will install the man page to `share/man/man1/ztags.1` relative to the
prefix given with `-p`/`--prefix` (default `zig-out`).
To build and install both `ztags` and the man page to `$PREFIX` simultaneously,
use
```console
$ zig build -Doptimize=ReleaseSafe -p $PREFIX install docs
```
[scdoc]: https://sr.ht/~sircmpwn/scdoc/
## Usage
Pass a source file to the `ztags` executable. `ztags` will find `@import`
statements for relative files (i.e. any imports that end with `.zig`) and
recursively index those files too.
Packages (imports that are not a relative path, but a package name such as
`@import("foo")`) are not followed, as package information is not available at
runtime. Instead, pass the root source file of each package as an additional
command line argument.
For example, the entire Zig standard library can be indexed using:
```console
$ ztags /path/to/zig/std/std.zig
```
The following "kinds" are supported:
- `enum`
- `field`
- `struct`
- `constant`
- `function`
- `variable`
- `union`
## Contributing
Bugs can be reported on the [issue tracker][issues]. PRs are accepted on [GitHub][github] or [Codeberg][codeberg].
[issues]: https://codeberg.org/gpanders/ztags/issues
[github]: https://github.com/gpanders/ztags
[codeberg]: https://codeberg.org/gpanders/ztags
## License
MIT