https://github.com/clark800/def
function definition search script (ctags alternative)
https://github.com/clark800/def
ctags shell-script vim
Last synced: over 1 year ago
JSON representation
function definition search script (ctags alternative)
- Host: GitHub
- URL: https://github.com/clark800/def
- Owner: clark800
- License: unlicense
- Created: 2021-10-20T04:06:37.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-11-25T15:18:46.000Z (over 2 years ago)
- Last Synced: 2025-01-25T17:41:23.261Z (over 1 year ago)
- Topics: ctags, shell-script, vim
- Language: Shell
- Homepage:
- Size: 2.93 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# def
`def` is a simple POSIX shell script that recursively searches source files in
the current directory for the definition of the given function name and prints
out all matching lines.
It can also be used to implement "go to definition" functionality for editors.
It does not require any database files like ctags and cscope.
#### Features
* If the current directory is a `git` directory, then any gitignored files
and directories will be skipped.
* The following file extensions are recognized:
c, h, py, js, ts, lua, awk, sh, rs, go.
#### Usage
`def [] []`
`def` will only search files with the specified file extension, which defaults
to `c`. With no arguments, `def` will list all function definitions.
#### Vim Integration
Copying `def.vim` into your vimrc will add a colon command `:D ` to search
for definitions in files with the same extension as the current file
(unless the current file is a `.h` file in which case it will search `.c` files)
and jump to the first definition found. Also, the F12 key will run this command
with the current name under the cursor. Additionally, the `:Dh ` command
and Shift+F12 work similarly, but always search `.h` files. If multiple
definitions are found, you can use `:lnext` to step through the results.
#### Caveats
* For C files, function prototypes will be listed in addition to definitions.
This shouldn't be an issue if prototypes are in `.h` files since these are not
normally searched. If there are prototypes in `.c` files, they can be indented
by a space to make them not appear.
* Function definitions inside block comments will be listed if the comment
starts on a prior line.
* Filenames and paths containing double quotes are not supported.