collie-lsp

Language Server Protocol (LSP) implementation for Lrama Style BNF grammar files (.y files).

• Real-time diagnostics and linting
• Document formatting
• Code actions and quick fixes
• Hover information and auto-completion
• Go to definition and find references
• Symbol renaming and workspace search
• Semantic highlighting and code folding

Add this line to your application's Gemfile:

gem 'collie-lsp'

And then execute:

bundle install

Or install it yourself as:

gem install collie-lsp

The LSP server can be started in stdio mode (the default for most LSP clients):

collie-lsp --stdio

Or in socket mode:

collie-lsp --socket=7658

Install the collie-lsp extension from the VS Code marketplace, or configure manually:

{
  "collie-lsp.serverPath": "collie-lsp",
  "collie-lsp.trace.server": "verbose"
}

require'lspconfig'.collie_lsp.setup{
  cmd = { "collie-lsp", "--stdio" },
  filetypes = { "yacc" },
  root_dir = function(fname)
    return vim.fn.getcwd()
  end,
}

(add-to-list 'lsp-language-id-configuration '(yacc-mode . "yacc"))

(lsp-register-client
 (make-lsp-client :new-connection (lsp-stdio-connection "collie-lsp")
                  :major-modes '(yacc-mode)
                  :server-id 'collie-lsp))

if executable('collie-lsp')
  au User lsp_setup call lsp#register_server({
    \ 'name': 'collie-lsp',
    \ 'cmd': {server_info->['collie-lsp', '--stdio']},
    \ 'whitelist': ['yacc'],
    \ })
endif

Create a .collie.yml file in your project root:

# Linter rules
rules:
  DuplicateToken:
    enabled: true
    severity: error

  TokenNaming:
    enabled: true
    severity: convention
    pattern: '^[A-Z][A-Z0-9_]*$'

  NonterminalNaming:
    enabled: true
    severity: convention
    pattern: '^[a-z][a-z0-9_]*$'

# Formatter options
formatter:
  indent_size: 4
  align_tokens: true
  align_alternatives: true
  max_line_length: 120

# File patterns
include:
  - '**/*.y'
exclude:
  - 'vendor/**/*'
  - 'tmp/**/*'

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

# Install dependencies
bundle install

# Run tests
bundle exec rspec

# Or use rake
bundle exec rake

lib/collie_lsp/
├── server.rb                  # Main LSP server
├── document_store.rb          # Document management
├── collie_wrapper.rb          # Collie gem integration
├── protocol/                  # LSP protocol handlers
│   ├── initialize.rb
│   ├── text_document.rb
│   └── shutdown.rb
└── handlers/                  # Feature handlers
    ├── diagnostics.rb         # Lint diagnostics
    ├── formatting.rb          # Document formatting
    ├── code_action.rb         # Quick fixes
    ├── hover.rb               # Hover information
    ├── completion.rb          # Auto-completion
    ├── definition.rb          # Go to definition
    ├── references.rb          # Find references
    ├── document_symbol.rb     # Document outline
    ├── rename.rb              # Symbol renaming
    ├── semantic_tokens.rb     # Semantic highlighting
    ├── workspace_symbol.rb    # Workspace search
    └── folding_range.rb       # Code folding

Run the test suite:

bundle exec rspec

Run specific tests:

bundle exec rspec spec/collie_lsp/handlers/hover_spec.rb

Run with coverage:

COVERAGE=true bundle exec rspec

Enable logging for debugging:

COLLIE_LSP_LOG=/tmp/collie-lsp.log collie-lsp --stdio

Then tail the log file:

tail -f /tmp/collie-lsp.log

Real-time linting as you type, showing errors, warnings, and style violations.

Format the entire document according to your style preferences.

Quick fixes for autocorrectable offenses. Access via your editor's "Quick Fix" command.

Hover over a symbol to see its type and documentation.

Intelligent auto-completion for:

• Declared tokens
• Defined nonterminals
• Grammar keywords

Jump to the definition of any token or nonterminal.

Find all references to a symbol across the file.

View document outline in your editor's symbol browser.

Rename symbols with validation and automatic updates throughout the file.

Enhanced syntax highlighting for:

• Keywords (%token, %type, etc.)
• Tokens (uppercase identifiers)
• Nonterminals (lowercase identifiers)
• Comments and strings

Search for symbols across all open documents.

Fold code sections:

• Grammar rules
• Block comments
• C code blocks (%{ ... %})
• Action blocks ({ ... })

Bug reports and pull requests are welcome on GitHub at https://github.com/ydah/collie-lsp.

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

• collie - The core linter and formatter (coming soon)
• lrama - LALR parser generator