collie-lsp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ec633ab14d54c5cf9447d1638970e179df88b9a86a1c39b3bfcafa1340aede55
+  data.tar.gz: c166948efe29a27db239c004941b56da587834eec902af888973f581e471c0f9
+SHA512:
+  metadata.gz: 5546ee6a736111222aae47aea6d466e1835ae841f16b2861d788f8041617fa6979b1722c3cdf3bf22c7a9a62a9304f49e536012dbab118bdcbabd0c6b17cd09a
+  data.tar.gz: 88d501fa5b1e60098453a0755967b3b296b9f13c16bccfde08e343dd6e4dae1a07daf1d1c543ff7c8d60ce27851f59b6e10a4c8c7532f1d0100a5760821693de

data/.collie.yml.example

@@ -0,0 +1,144 @@
+# Example collie-lsp configuration file
+# Copy this file to .collie.yml and customize as needed
+
+# Inherit configuration from another file (optional)
+# inherit_from: .collie_base.yml
+
+# Linter rules configuration
+rules:
+  # Validation rules (severity: error)
+  DuplicateToken:
+    enabled: true
+    severity: error
+
+  UndefinedSymbol:
+    enabled: true
+    severity: error
+
+  UnreachableRule:
+    enabled: true
+    severity: error
+
+  CircularReference:
+    enabled: true
+    severity: error
+
+  MissingStartSymbol:
+    enabled: true
+    severity: error
+
+  # Warning rules (severity: warning)
+  UnusedNonterminal:
+    enabled: true
+    severity: warning
+
+  UnusedToken:
+    enabled: true
+    severity: warning
+
+  LeftRecursion:
+    enabled: true
+    severity: warning
+
+  RightRecursion:
+    enabled: true
+    severity: warning
+
+  AmbiguousPrecedence:
+    enabled: true
+    severity: warning
+
+  # Style rules (severity: convention)
+  TokenNaming:
+    enabled: true
+    severity: convention
+    # Tokens should be UPPER_CASE
+    pattern: '^[A-Z][A-Z0-9_]*$'
+
+  NonterminalNaming:
+    enabled: true
+    severity: convention
+    # Nonterminals should be snake_case
+    pattern: '^[a-z][a-z0-9_]*$'
+
+  ActionVariableNaming:
+    enabled: true
+    severity: convention
+
+  ConsistentTagNaming:
+    enabled: true
+    severity: convention
+
+  TrailingWhitespace:
+    enabled: true
+    severity: convention
+
+  EmptyAction:
+    enabled: false
+    severity: convention
+
+  LongRule:
+    enabled: true
+    severity: convention
+    max_alternatives: 10
+
+  # Optimization rules (severity: info)
+  FactorizableRules:
+    enabled: false
+    severity: info
+
+  RedundantEpsilon:
+    enabled: false
+    severity: info
+
+  PrecImprovement:
+    enabled: false
+    severity: info
+
+# Formatter configuration
+formatter:
+  # Number of spaces for indentation
+  indent_size: 4
+
+  # Align token declarations
+  align_tokens: true
+
+  # Align rule alternatives
+  align_alternatives: true
+
+  # Number of blank lines around section separators (%%)
+  blank_lines_around_sections: 2
+
+  # Maximum line length before wrapping
+  max_line_length: 120
+
+  # Preserve blank lines between rules
+  preserve_blank_lines: true
+
+  # Sort token declarations alphabetically
+  sort_tokens: false
+
+# File patterns
+include:
+  - '**/*.y'
+  - '**/*.yacc'
+
+exclude:
+  - 'vendor/**/*'
+  - 'tmp/**/*'
+  - 'node_modules/**/*'
+  - '.git/**/*'
+
+# Editor integration settings
+editor:
+  # Show diagnostics on save only (vs. on change)
+  diagnostics_on_save: false
+
+  # Debounce delay for diagnostics (milliseconds)
+  diagnostics_delay: 300
+
+  # Enable semantic tokens
+  semantic_tokens: true
+
+  # Enable code folding
+  folding: true

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--format documentation

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+- Initial commit

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Yudai Takada
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,273 @@
+# collie-lsp
+
+[![Gem Version](https://badge.fury.io/rb/collie-lsp.svg)](https://badge.fury.io/rb/collie-lsp)
+[![Build Status](https://github.com/ydah/collie-lsp/workflows/CI/badge.svg)](https://github.com/ydah/collie-lsp/actions)
+
+Language Server Protocol (LSP) implementation for Lrama Style BNF grammar files (.y files).
+
+## Features
+
+- 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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'collie-lsp'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install collie-lsp
+```
+
+## Usage
+
+### Starting the Server
+
+The LSP server can be started in stdio mode (the default for most LSP clients):
+
+```bash
+collie-lsp --stdio
+```
+
+Or in socket mode:
+
+```bash
+collie-lsp --socket=7658
+```
+
+### Editor Configuration
+
+#### VS Code
+
+Install the collie-lsp extension from the VS Code marketplace, or configure manually:
+
+```json
+{
+  "collie-lsp.serverPath": "collie-lsp",
+  "collie-lsp.trace.server": "verbose"
+}
+```
+
+#### Neovim (with nvim-lspconfig)
+
+```lua
+require'lspconfig'.collie_lsp.setup{
+  cmd = { "collie-lsp", "--stdio" },
+  filetypes = { "yacc" },
+  root_dir = function(fname)
+    return vim.fn.getcwd()
+  end,
+}
+```
+
+#### Emacs (with lsp-mode)
+
+```elisp
+(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))
+```
+
+#### Vim (with vim-lsp)
+
+```vim
+if executable('collie-lsp')
+  au User lsp_setup call lsp#register_server({
+    \ 'name': 'collie-lsp',
+    \ 'cmd': {server_info->['collie-lsp', '--stdio']},
+    \ 'whitelist': ['yacc'],
+    \ })
+endif
+```
+
+### Configuration
+
+Create a `.collie.yml` file in your project root:
+
+```yaml
+# 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/**/*'
+```
+
+## Development
+
+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.
+
+```bash
+# Install dependencies
+bundle install
+
+# Run tests
+bundle exec rspec
+
+# Or use rake
+bundle exec rake
+```
+
+## Architecture
+
+```
+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
+```
+
+## Testing
+
+Run the test suite:
+
+```bash
+bundle exec rspec
+```
+
+Run specific tests:
+
+```bash
+bundle exec rspec spec/collie_lsp/handlers/hover_spec.rb
+```
+
+Run with coverage:
+
+```bash
+COVERAGE=true bundle exec rspec
+```
+
+## Logging
+
+Enable logging for debugging:
+
+```bash
+COLLIE_LSP_LOG=/tmp/collie-lsp.log collie-lsp --stdio
+```
+
+Then tail the log file:
+
+```bash
+tail -f /tmp/collie-lsp.log
+```
+
+## LSP Capabilities
+
+### textDocument/publishDiagnostics
+Real-time linting as you type, showing errors, warnings, and style violations.
+
+### textDocument/formatting
+Format the entire document according to your style preferences.
+
+### textDocument/codeAction
+Quick fixes for autocorrectable offenses. Access via your editor's "Quick Fix" command.
+
+### textDocument/hover
+Hover over a symbol to see its type and documentation.
+
+### textDocument/completion
+Intelligent auto-completion for:
+- Declared tokens
+- Defined nonterminals
+- Grammar keywords
+
+### textDocument/definition
+Jump to the definition of any token or nonterminal.
+
+### textDocument/references
+Find all references to a symbol across the file.
+
+### textDocument/documentSymbol
+View document outline in your editor's symbol browser.
+
+### textDocument/rename
+Rename symbols with validation and automatic updates throughout the file.
+
+### textDocument/semanticTokens/full
+Enhanced syntax highlighting for:
+- Keywords (`%token`, `%type`, etc.)
+- Tokens (uppercase identifiers)
+- Nonterminals (lowercase identifiers)
+- Comments and strings
+
+### workspace/symbol
+Search for symbols across all open documents.
+
+### textDocument/foldingRange
+Fold code sections:
+- Grammar rules
+- Block comments
+- C code blocks (`%{ ... %}`)
+- Action blocks (`{ ... }`)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ydah/collie-lsp.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Related Projects
+
+- [collie](https://github.com/ydah/collie) - The core linter and formatter (coming soon)
+- [lrama](https://github.com/ruby/lrama) - LALR parser generator

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/collie-lsp.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/collie_lsp/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'collie-lsp'
+  spec.version = CollieLsp::VERSION
+  spec.authors = ['Yudai Takada']
+  spec.email = ['t.yudai92@gmail.com']
+
+  spec.summary = 'Language Server Protocol implementation for Lrama Style BNF grammar files'
+  spec.description = 'collie-lsp provides real-time linting, formatting, and code intelligence ' \
+                     'features for .y grammar files in any LSP-compatible editor'
+  spec.homepage = 'https://github.com/ydah/collie-lsp'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.2.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata['bug_tracker_uri'] = "#{spec.homepage}/issues"
+  spec.metadata['documentation_uri'] = "#{spec.homepage}/blob/main/README.md"
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'language_server-protocol', '~> 3.17.0'
+end

data/exe/collie-lsp

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'collie_lsp'
+
+# Start the LSP server
+server = CollieLsp::Server.new
+server.start

data/lib/collie_lsp/collie_wrapper.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module CollieLsp
+  # Wrapper around the Collie gem for LSP integration
+  class CollieWrapper
+    # Initialize wrapper
+    # @param workspace_root [String, nil] Workspace root directory for config discovery
+    def initialize(workspace_root: nil)
+      config_path = find_config(workspace_root)
+      @config = load_config(config_path)
+      load_rules
+    end
+
+    # Parse grammar source into AST
+    # @param source [String] Grammar source code
+    # @param filename [String] Filename for error messages
+    # @return [Object, Hash] AST or error hash
+    def parse(_source, filename: 'grammar.y')
+      # For now, return a mock AST structure
+      # This will be replaced with actual Collie parser when available
+      {
+        declarations: [],
+        rules: [],
+        prologue: nil,
+        epilogue: nil
+      }
+    rescue StandardError => e
+      { error: e.message, location: { line: 1, column: 1 } }
+    end
+
+    # Lint grammar source
+    # @param source [String] Grammar source code
+    # @param filename [String] Filename for error messages
+    # @return [Array<Hash>] Array of offenses
+    def lint(source, filename: 'grammar.y')
+      ast = parse(source, filename: filename)
+      return [] if ast.is_a?(Hash) && ast[:error]
+
+      # For now, return empty offenses
+      # This will be replaced with actual Collie linter when available
+      []
+    end
+
+    # Format grammar source
+    # @param source [String] Grammar source code
+    # @param filename [String] Filename for error messages
+    # @return [String, nil] Formatted source or nil on error
+    def format(source, filename: 'grammar.y')
+      ast = parse(source, filename: filename)
+      return nil if ast.is_a?(Hash) && ast[:error]
+
+      # For now, return the source as-is
+      # This will be replaced with actual Collie formatter when available
+      source
+    end
+
+    # Autocorrect offenses in grammar source
+    # @param source [String] Grammar source code
+    # @param filename [String] Filename for error messages
+    # @return [String] Corrected source
+    def autocorrect(source, filename: 'grammar.y')
+      # For now, return the source as-is
+      # This will be replaced with actual Collie autocorrect when available
+      source
+    end
+
+    private
+
+    # Find configuration file
+    # @param root [String, nil] Workspace root directory
+    # @return [String, nil] Config file path or nil
+    def find_config(root)
+      return nil unless root
+
+      config_file = File.join(root, '.collie.yml')
+      File.exist?(config_file) ? config_file : nil
+    end
+
+    # Load configuration
+    # @param config_path [String, nil] Config file path
+    # @return [Hash] Configuration hash
+    def load_config(config_path)
+      if config_path && File.exist?(config_path)
+        require 'yaml'
+        YAML.load_file(config_path)
+      else
+        {}
+      end
+    end
+
+    # Load linter rules
+    def load_rules
+      # This will be replaced with actual Collie rule loading when available
+      # Collie::Linter::Registry.load_rules
+    end
+  end
+end

data/lib/collie_lsp/document_store.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module CollieLsp
+  # Manages open documents in memory
+  class DocumentStore
+    def initialize
+      @documents = {}
+    end
+
+    # Open a new document
+    # @param uri [String] Document URI
+    # @param text [String] Document text content
+    # @param version [Integer] Document version
+    def open(uri, text, version)
+      @documents[uri] = {
+        text: text,
+        version: version,
+        ast: nil,
+        diagnostics: []
+      }
+    end
+
+    # Update document content
+    # @param uri [String] Document URI
+    # @param text [String] New document text
+    # @param version [Integer] New document version
+    def change(uri, text, version)
+      return unless @documents[uri]
+
+      @documents[uri][:text] = text
+      @documents[uri][:version] = version
+      @documents[uri][:ast] = nil # Invalidate AST cache
+    end
+
+    # Get document data
+    # @param uri [String] Document URI
+    # @return [Hash, nil] Document data or nil if not found
+    def get(uri)
+      @documents[uri]
+    end
+
+    # Close a document
+    # @param uri [String] Document URI
+    def close(uri)
+      @documents.delete(uri)
+    end
+
+    # Update cached AST for a document
+    # @param uri [String] Document URI
+    # @param ast [Object] Parsed AST
+    def update_ast(uri, ast)
+      return unless @documents[uri]
+
+      @documents[uri][:ast] = ast
+    end
+
+    # Update diagnostics for a document
+    # @param uri [String] Document URI
+    # @param diagnostics [Array<Hash>] LSP diagnostics
+    def update_diagnostics(uri, diagnostics)
+      return unless @documents[uri]
+
+      @documents[uri][:diagnostics] = diagnostics
+    end
+  end
+end