collie 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c8b86b09838d7091834f3243ae717931e2085c16013aa17e0dff5e8569e8975b
+  data.tar.gz: 4d09ba7a44de27ff966cf4edc0da4b9824749d719f1051d7fce6d8c39e36c97d
+SHA512:
+  metadata.gz: fbf34be5a91e5a0fb0d5bf334e0bffe92ad289720b059022e9e6c050facbba9e0956ea49d4820eec03fc06e81138a4beb06a1e872031472eaffb2f55ec770f18
+  data.tar.gz: 7d323a0aaca55514da222f2ba48f8bd436fb1139a43d83d7bac90845f06844bd29f9ab280d1859f42e54dc260d9e142af410260042546848f6f7693bf4a9bd11

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# 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
+
+## 0.1.0 - 2025-12-17
+
+- Initial commit

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'rspec'
+gem 'simplecov'
+gem 'yard'

data/LICENSE.txt

@@ -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,333 @@
+# Collie
+
+A linter and formatter for Lrama Style BNF grammar files (.y files). Collie helps you write clean, maintainable, and error-free grammar files for parser generators like Lrama, Yacc, and Bison.
+
+[![CI](https://github.com/ydah/collie/workflows/CI/badge.svg)](https://github.com/ydah/collie/actions)
+[![Gem Version](https://badge.fury.io/rb/collie.svg)](https://badge.fury.io/rb/collie)
+
+## Features
+
+- 18 Built-in Lint Rules - Catch common errors and suggest improvements
+- Lrama Extension Support - Full support for parameterized rules, named references, and inline rules
+- Smart Formatting - Consistent indentation, alignment, and spacing
+- Configurable - Customize rules and formatting options via `.collie.yml`
+- Multiple Output Formats - Text, JSON, and GitHub Actions annotations
+- Auto-correction - Automatically fix certain issues
+
+## Installation
+
+```bash
+gem install collie
+```
+
+Or add to your Gemfile:
+
+```ruby
+gem 'collie', require: false
+```
+
+## Quick Start
+
+### Try Online
+
+Try Collie in your browser without installing anything:
+
+[Open Playground](https://ydah.github.io/collie/playground/) (Coming soon)
+
+### Lint a grammar file
+
+```bash
+# Check for issues
+collie lint parse.y
+
+# Auto-fix issues where possible
+collie lint -a parse.y
+```
+
+### Format a grammar file
+
+```bash
+# Check formatting
+collie fmt --check parse.y
+
+# Format in-place
+collie fmt parse.y
+
+# Show diff
+collie fmt --diff parse.y
+```
+
+### List all available rules
+
+```bash
+collie rules
+```
+
+## Configuration
+
+Create a `.collie.yml` file in your project root:
+
+```yaml
+# Inherit from another config (optional)
+inherit_from: .collie_base.yml
+
+# Rule configuration
+rules:
+  DuplicateToken:
+    enabled: true
+    severity: error
+
+  TokenNaming:
+    enabled: true
+    severity: convention
+    pattern: '^[A-Z][A-Z0-9_]*$'
+
+  LongRule:
+    enabled: true
+    max_alternatives: 10
+
+  # Disable specific rules
+  LeftRecursion:
+    enabled: false
+
+# Formatter options
+formatter:
+  indent_size: 4
+  align_tokens: true
+  align_alternatives: true
+  blank_lines_around_sections: 2
+  max_line_length: 120
+
+# File patterns
+include:
+  - '**/*.y'
+exclude:
+  - 'vendor/**/*'
+  - 'tmp/**/*'
+```
+
+## Available Rules
+
+### Validation Rules (Error)
+
+| Rule | Description | Auto-fix |
+|------|-------------|----------|
+| `DuplicateToken` | Token defined multiple times | No |
+| `UndefinedSymbol` | Reference to undeclared token/nonterminal | No |
+| `UnreachableRule` | Rule not derivable from start symbol | No |
+| `CircularReference` | Infinite recursion in grammar | No |
+| `MissingStartSymbol` | No `%start` declaration with ambiguous default | No |
+
+### Warning Rules
+
+| Rule | Description | Auto-fix |
+|------|-------------|----------|
+| `UnusedNonterminal` | Nonterminal defined but never referenced | No |
+| `UnusedToken` | Token declared but never used | No |
+| `LeftRecursion` | Detects left recursion (informational) | No |
+| `RightRecursion` | Suggests left recursion conversion | No |
+| `AmbiguousPrecedence` | Operators without explicit precedence | No |
+
+### Style Rules (Convention)
+
+| Rule | Description | Auto-fix |
+|------|-------------|----------|
+| `TokenNaming` | Tokens should be UPPER_CASE | No |
+| `NonterminalNaming` | Nonterminals should be snake_case | No |
+| `ConsistentTagNaming` | Type tags should be consistent | No |
+| `TrailingWhitespace` | No trailing whitespace at end of lines | Yes |
+| `EmptyAction` | Warns on empty `{ }` actions | Yes |
+| `LongRule` | Rule with too many alternatives | No |
+
+### Optimization Rules (Info)
+
+| Rule | Description | Auto-fix |
+|------|-------------|----------|
+| `FactorizableRules` | Suggests factoring common prefixes | No |
+| `RedundantEpsilon` | Unnecessary epsilon productions | No |
+| `PrecImprovement` | Suggests `%prec` improvements | No |
+
+## Usage Examples
+
+### Example Grammar File
+
+```yacc
+%token <node> CLASS MODULE DEF
+%token <id> IDENTIFIER CONSTANT
+%token <num> INTEGER FLOAT
+
+%left '+' '-'
+%left '*' '/'
+%right '^'
+
+%%
+
+program
+    : class_definition
+    | module_definition
+    ;
+
+class_definition
+    : CLASS CONSTANT '{' class_body '}'
+        { $$ = make_class($2, $4); }
+    ;
+
+expr
+    : expr '+' expr    { $$ = add($1, $3); }
+    | expr '-' expr    { $$ = sub($1, $3); }
+    | expr '*' expr    { $$ = mul($1, $3); }
+    | '(' expr ')'     { $$ = $2; }
+    | IDENTIFIER       { $$ = var($1); }
+    | INTEGER          { $$ = num($1); }
+    ;
+
+%%
+```
+
+### Lrama Extensions
+
+Collie fully supports Lrama-specific syntax:
+
+```yacc
+# Parameterized Rules
+%rule pair(X, Y): X COMMA Y ;
+
+number_pair
+    : pair(NUMBER, NUMBER)
+        { $$ = make_pair($1, $3); }
+    ;
+
+# Named References
+assignment
+    : IDENTIFIER[var] EQUALS NUMBER[value]
+        { assign($var, $value); }
+    ;
+
+# Inline Rules
+%inline opt(X): /* empty */ | X ;
+```
+
+### CI Integration (GitHub Actions)
+
+Use the reusable workflow in your project:
+
+```yaml
+# .github/workflows/lint.yml
+name: Lint Grammar Files
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    uses: ydah/collie/.github/workflows/lint.yml@main
+    with:
+      files: 'src/**/*.y'
+      config: '.collie.yml'
+      fail-on-warnings: true
+```
+
+### Programmatic Usage
+
+```ruby
+require 'collie'
+
+# Parse a grammar file
+parser = Collie::Parser::Parser.new(source_code)
+ast = parser.parse
+
+# Analyze the grammar
+symbol_table = Collie::Analyzer::SymbolTable.new(ast)
+symbol_table.build
+
+# Run linter
+config = Collie::Config.new
+linter = Collie::Linter.new(config)
+offenses = linter.lint(ast)
+
+# Format the grammar
+formatter = Collie::Formatter::Formatter.new(config.formatter_options)
+formatted_code = formatter.format(ast)
+```
+
+## Command Line Options
+
+### `collie lint`
+
+```bash
+collie lint [OPTIONS] FILES
+
+Options:
+  --config PATH         Path to config file (default: .collie.yml)
+  --format FORMAT       Output format: text, json, github (default: text)
+  -a, --autocorrect     Auto-fix offenses where possible
+  --only RULES          Run only specified rules (comma-separated)
+  --except RULES        Exclude specified rules (comma-separated)
+```
+
+### `collie fmt`
+
+```bash
+collie fmt [OPTIONS] FILES
+
+Options:
+  --config PATH         Path to config file
+  --check               Check only, don't modify files
+  --diff                Show diff of changes
+```
+
+### `collie rules`
+
+```bash
+collie rules [OPTIONS]
+
+Options:
+  --format FORMAT       Output format: text, json (default: text)
+```
+
+## Development
+
+```bash
+# Install dependencies
+bundle install
+
+# Run tests
+bundle exec rspec
+
+# Run linter
+bundle exec rubocop
+
+# Run all checks
+bundle exec rake
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Credits
+
+Developed for improving the development experience with [Lrama](https://github.com/ruby/lrama), the next-generation parser generator for Ruby.
+
+## Related Projects
+
+### Editor Integration (Planned)
+
+- collie-lsp - LSP (Language Server Protocol) implementation for Collie
+- vscode-collie - VS Code extension for Collie
+
+### Parser Generators
+
+- [Lrama](https://github.com/ruby/lrama) - LALR (1) parser generator
+- [Bison](https://www.gnu.org/software/bison/) - GNU parser generator
+
+### Inspiration
+
+- [RuboCop](https://github.com/rubocop/rubocop) - Ruby static code analyzer (inspiration for architecture)

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc "Run tests"
+task default: [:spec]

data/collie.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/collie/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "collie"
+  spec.version = Collie::VERSION
+  spec.authors = ["Yudai Takada"]
+  spec.email = ["t.yudai92@gmail.com"]
+
+  spec.summary = "A linter and formatter for Lrama Style BNF grammar files"
+  spec.description = "Collie is a linter and formatter for Lrama Style BNF grammar files (.y files). " \
+                     "It helps establish best practices for grammar file development and improves " \
+                     "maintainability of complex parsers."
+  spec.homepage = "https://github.com/ydah/collie"
+  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["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 .circleci appveyor])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "pastel", "~> 0.8"
+  spec.add_dependency "thor", "~> 1.0"
+  spec.add_dependency "tty-table", "~> 0.12"
+end