Hind

Hind is a Ruby gem for generating code intelligence data in LSIF (Language Server Index Format) and SCIP (Sourcegraph Code Intelligence Protocol) formats. It helps create index files that power code navigation features like go-to-definition, find references, and hover documentation.

Install the gem:

gem install hind

Or add it to your Gemfile:

gem 'hind'

To generate LSIF data for your Ruby project:

# Basic usage
hind lsif

# Specify directory and output file
hind lsif -d /path/to/project -o output.lsif

# Process specific files with glob pattern
hind lsif -g "lib/**/*.rb"

# Exclude patterns
hind lsif -e "test/**/*" -e "spec/**/*"

# Verbose output
hind lsif -v

Options:

• -d, --directory DIR - Root directory to process (default: current directory)
• -o, --output FILE - Output file path (default: dump.lsif)
• -g, --glob PATTERN - File pattern to match (default: **/*.rb)
• -f, --force - Overwrite output file if it exists
• -e, --exclude PATTERN - Patterns to exclude (can be specified multiple times)
• -v, --verbose - Enable verbose output
• -c, --config FILE - Path to configuration file

To use Hind with GitLab for code intelligence:

1. Add this to your .gitlab-ci.yml:

lsif:
  stage: lsif
  script:
    - gem install hind
    - hind lsif -d . -o dump.lsif -v
  artifacts:
    reports:
      lsif: dump.lsif

2. GitLab will automatically process the LSIF data and enable code intelligence features.

• Generates LSIF data for Ruby code
• Supports code intelligence features:
  • Go to definition
  • Find references
  • Hover documentation
  • Symbol search
• Integrates with GitLab code intelligence
• Configurable output and processing
• Comprehensive error checking and reporting

After checking out the repo:

1. Install dependencies:

bundle install

2. Run tests:

bundle exec rspec

3. Run the gem locally:

bundle exec bin/hind

Bug reports and pull requests are welcome on GitHub at https://github.com/yourusername/hind.

The gem is available as open source under the terms of the MIT License.