rubocop-rbs_inline 1.4.0 → 1.5.0.pre.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28c10d4c13563cfc463decbe536ccbb53c0dab6102fb0c3f439b0693a03e0e6b
-  data.tar.gz: cc3e878fd7e43ea9e5ec255c355ada40a946a39381c6dc6d66c74450bde97ad7
+  metadata.gz: 813f81c0980296d50e92c6a928f3ac51e3954748095a1e0dd6117cdcf77a8166
+  data.tar.gz: '029b0e05c922841def3501e57587045660c4d0f05752dba974797f7215661b62'
 SHA512:
-  metadata.gz: 0bbb06a5a7217f4a9858eefba6e3dac8e07c46363c8406b47cccbda6a66eda54710dd63b34c990eca2941e41bce1a2f73565e0c2853839aacf8809388f7c031e
-  data.tar.gz: b4733af9878300b883cbe5e8919d914ecfa003416135e9c747bb4c22380e6d938551ff790ed6584003f17e4bea4771318beea62be91937b857d858e1cd889191
+  metadata.gz: 2768b2232009f4c70366981b7ffc47ef55edef17f6938f31d0740a645189a71fea2666e64edaf005cb27489ea18f2038f80c917240bc861fa8b60672e2286dbc
+  data.tar.gz: 42191af687cb627862f2ee617579df7932c65b656d35c7c4651453dc2c58106f28f73b2794107c3eb99a4d66bab141b43015072493bd19b60e3a8bc27f7d4f76

data/.claude/hooks/pre-commit-check.sh

@@ -0,0 +1,29 @@
+#!/bin/bash
+
+# Hook input is JSON from stdin
+input=$(cat)
+tool_name=$(echo "$input" | jq -r '.tool_name')
+command=$(echo "$input" | jq -r '.tool_input.command // ""')
+
+# Only run for git commit commands
+if [[ "$tool_name" != "Bash" ]] || [[ ! "$command" =~ git[[:space:]]+(commit|cherry-pick|merge|rebase) ]]; then
+    exit 0
+fi
+
+cd "$CLAUDE_PROJECT_DIR" || exit 1
+
+echo "Running pre-commit checks..." >&2
+
+# Generate RBS and run all checks
+if ! "$CLAUDE_PROJECT_DIR/bin/rbs-inline" --opt-out --output=sig/ lib/ >&2; then
+    echo "Error: RBS generation failed" >&2
+    exit 2
+fi
+
+if ! "$CLAUDE_PROJECT_DIR/bin/rake" >&2; then
+    echo "Error: rake checks failed" >&2
+    exit 2
+fi
+
+echo "All checks passed!" >&2
+exit 0

data/.claude/hooks/rbs-inline.sh

@@ -0,0 +1,97 @@
+#!/bin/bash
+
+# Hook input is JSON from stdin
+input=$(cat)
+tool_name=$(echo "$input" | jq -r '.tool_name')
+
+cd "$CLAUDE_PROJECT_DIR" || exit 1
+
+# Handle Edit or Write tools
+if [[ "$tool_name" == "Edit" || "$tool_name" == "Write" ]]; then
+    file_path=$(echo "$input" | jq -r '.tool_input.file_path // ""')
+
+    if [[ ! "$file_path" =~ \.rb$ ]]; then
+        exit 0
+    fi
+
+    if [[ ! "$file_path" =~ /lib/ ]]; then
+        exit 0
+    fi
+
+    echo "Running rbs-inline for $file_path..." >&2
+
+    if ! "$CLAUDE_PROJECT_DIR/bin/rbs-inline" --opt-out --output=sig/ "$file_path" >&2; then
+        echo "Warning: RBS generation failed for $file_path" >&2
+        exit 0
+    fi
+
+    echo "RBS generation completed." >&2
+    exit 0
+fi
+
+# Handle Bash tool for mv command
+if [[ "$tool_name" == "Bash" ]]; then
+    command=$(echo "$input" | jq -r '.tool_input.command // ""')
+
+    # Check if this is a mv command
+    if [[ ! "$command" =~ ^[[:space:]]*(mv|git\ mv)[[:space:]] ]]; then
+        exit 0
+    fi
+
+    # Extract source and destination paths from mv command
+    # Handle common patterns: mv src dest, git mv src dest
+    # Remove the mv/git mv prefix and get the paths
+    paths=$(echo "$command" | sed -E 's/^[[:space:]]*(git[[:space:]]+)?mv[[:space:]]+//')
+
+    # Split into source and destination (simple case, space-separated)
+    # This handles: mv old.rb new.rb, mv old.rb dir/
+    source_path=$(echo "$paths" | awk '{print $1}')
+    dest_path=$(echo "$paths" | awk '{print $2}')
+
+    # Check if source was a .rb file in lib/
+    if [[ ! "$source_path" =~ \.rb$ ]] || [[ ! "$source_path" =~ lib/ ]]; then
+        exit 0
+    fi
+
+    echo "Detected mv of Ruby file in lib/: $source_path -> $dest_path" >&2
+
+    # Calculate the corresponding .rbs file path for the source
+    # Convert lib/path/to/file.rb to sig/path/to/file.rbs
+    source_rbs=$(echo "$source_path" | sed -E 's|^(.*/)?lib/|sig/|; s|\.rb$|.rbs|')
+
+    # Remove the old .rbs file if it exists
+    if [[ -f "$source_rbs" ]]; then
+        echo "Removing old RBS file: $source_rbs" >&2
+        rm -f "$source_rbs"
+    fi
+
+    # Determine the new .rb file path
+    # If dest is a directory, append the source filename
+    if [[ -d "$dest_path" ]]; then
+        dest_file="$dest_path/$(basename "$source_path")"
+    else
+        dest_file="$dest_path"
+    fi
+
+    # Check if the destination is in lib/
+    if [[ ! "$dest_file" =~ lib/ ]]; then
+        echo "Destination is not in lib/, skipping RBS generation" >&2
+        exit 0
+    fi
+
+    # Generate RBS for the new file
+    if [[ -f "$dest_file" ]]; then
+        echo "Running rbs-inline for $dest_file..." >&2
+
+        if ! "$CLAUDE_PROJECT_DIR/bin/rbs-inline" --opt-out --output=sig/ "$dest_file" >&2; then
+            echo "Warning: RBS generation failed for $dest_file" >&2
+            exit 0
+        fi
+
+        echo "RBS generation completed." >&2
+    fi
+
+    exit 0
+fi
+
+exit 0

data/.claude/hooks/setup.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+# Initialize rbenv for Claude Code on the Web
+eval "$(rbenv init -)"
+
+# Install dependencies
+# Note: Bundler 4.0.3 has a bug with Ruby 3.3.x causing CGI class variable errors.
+# Install and use Bundler 2.x to avoid this issue.
+gem install bundler -v 2.7.2 --no-document
+bundle _2.7.2_ install
+
+# Install dependencies for each gem directory (directories with .gemspec files)
+for gemspec in "$CLAUDE_PROJECT_DIR"/*/*.gemspec; do
+  if [[ -f "$gemspec" ]]; then
+    gem_dir=$(dirname "$gemspec")
+    if [[ -f "$gem_dir/Gemfile" ]]; then
+      echo "Installing dependencies for $(basename "$gem_dir")..."
+      (cd "$gem_dir" && bundle _2.7.2_ install)
+    fi
+  fi
+done
+
+# Persist environment for subsequent commands
+if [ -n "$CLAUDE_ENV_FILE" ]; then
+  echo 'eval "$(rbenv init -)"' >> "$CLAUDE_ENV_FILE"
+fi
+
+exit 0

data/.claude/settings.json

@@ -0,0 +1,38 @@
+{
+  "hooks": {
+    "SessionStart": [
+      {
+        "matcher": "startup",
+        "hooks": [
+          {
+            "type": "command",
+            "command": "\"$CLAUDE_PROJECT_DIR\"/.claude/hooks/setup.sh",
+            "timeout": 300
+          }
+        ]
+      }
+    ],
+    "PreToolUse": [
+      {
+        "matcher": "Bash",
+        "hooks": [
+          {
+            "type": "command",
+            "command": "\"$CLAUDE_PROJECT_DIR\"/.claude/hooks/pre-commit-check.sh"
+          }
+        ]
+      }
+    ],
+    "PostToolUse": [
+      {
+        "matcher": "Edit|Write|Bash",
+        "hooks": [
+          {
+            "type": "command",
+            "command": "\"$CLAUDE_PROJECT_DIR\"/.claude/hooks/rbs-inline.sh"
+          }
+        ]
+      }
+    ]
+  }
+}

data/.rspec

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

data/.rubocop.yml

@@ -1,10 +1,17 @@
 plugins:
   - rubocop-rake
   - rubocop-rspec
+  - rubocop-rbs_inline
 
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 3.1
+  TargetRubyVersion: 3.3
+  Exclude:
+    - bin/**/*
+    - vendor/**/*
+
+Layout/LineLength:
+  Max: 120
 
 Metrics/AbcSize:
   Max: 20
@@ -29,9 +36,22 @@ RSpec/NestedGroups:
 Style/Documentation:
   Enabled: false
 
+Style/HashSyntax:
+  EnforcedShorthandSyntax: always
+
 # for RBS::Inline
 Layout/LeadingCommentSpace:
   Enabled: false
 
 Style/CommentedKeyword:
   Enabled: false
+
+# rubocop-rbs_inline configuration
+Style/RbsInline/MissingTypeAnnotation:
+  EnforcedStyle: doc_style_and_return_annotation
+
+Style/RbsInline/RedundantTypeAnnotation:
+  EnforcedStyle: doc_style_and_return_annotation
+
+Style/RbsInline/RequireRbsInlineComment:
+  EnforcedStyle: never

data/.vscode/settings.json

@@ -1,13 +1,21 @@
 {
     "cSpell.words": [
+        "bindir",
         "blockarg",
         "Ivar",
+        "KOMIYA",
         "kwarg",
         "kwoptarg",
         "kwrestarg",
         "optarg",
+        "popen",
+        "readlines",
         "restarg",
-        "strscan"
+        "rubocop",
+        "rubygems",
+        "strscan",
+        "Takeshi",
+        "tk0miya"
     ],
     "rbs-helper.rbs-inline-on-save": true,
     "rbs-helper.rbs-inline-signature-directory": "sig/"

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+## 1.5.0 (unreleased)
+
+### New Cops
+
+- **Style/RbsInline/RedundantAnnotationWithSkip**: Warns when type annotations (`#:` method type signatures, `# @rbs` method types, parameter annotations, return type annotations, or trailing inline types) are present alongside `# @rbs skip` or `# @rbs override`. These directives skip RBS generation, making any additional type annotations redundant. Supports unsafe autocorrect.
+- **Style/RbsInline/RedundantReturnType**: Warns when both a `# @rbs return` comment and a `#:` annotation comment specify the return type for the same method. The `EnforcedStyle` option accepts `inline_comment` (prefer `#:`) or `rbs_return_comment` (prefer `# @rbs return`). Supports safe autocorrect.
+- **Style/RbsInline/RedundantArgumentType**: Warns when both a `# @rbs param` comment and a `#:` annotation comment specify the argument type for the same method. The `EnforcedStyle` option accepts `annotation_comment` or `rbs_param_comment` (default). Supports autocorrect when `annotation_comment` style is preferred.
+- **Style/RbsInline/MissingTypeAnnotation**: Warns when a method definition has no type annotation. The `Visibility` option narrows the target methods by visibility (default: `all`).
+- **Style/RbsInline/RequireRbsInlineComment**: Enforces the presence or absence of a `# rbs_inline:` magic comment. The `EnforcedStyle` option accepts `always` (default, requires the comment) or `never` (forbids the comment).
+- **Style/RbsInline/EmbeddedRbsSpacing**: Warns when a `@rbs!` embedded RBS comment block is not followed by a blank line. Supports autocorrect.
+- **Style/RbsInline/VariableCommentSpacing**: Warns when a `@rbs` variable comment (`@ivar`, `@@cvar`, `self.@ivar`) is not followed by a blank line. Supports autocorrect.
+- **Style/RbsInline/MethodCommentSpacing**: Warns when a method-related `@rbs` annotation (`param`, `return`, `&block`, `override`, `skip`, etc.) is not placed immediately before the method definition it describes.
+- **Style/RbsInline/MissingDataClassAnnotation**: Warns when an attribute passed to `Data.define` does not have a trailing `#:` inline type annotation. Supports autocorrect.
+- **Style/RbsInline/DataClassCommentAlignment**: Warns when the `#:` inline type annotation comments in a multiline `Data.define` block are not aligned to the same column. Supports autocorrect.
+
+### Enhancements
+
+- **InvalidComment**: Added autocorrect support.
+- **KeywordSeparator**: Added autocorrect support.
+- **ParametersSeparator**: Added autocorrect support.
+
+### Dependency Updates
+
+- Updated rbs-inline to 0.13.0.
+- Raised minimum Ruby version to 3.3.0.

data/CLAUDE.md

@@ -0,0 +1,66 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+rubocop-rbs_inline is a RuboCop extension gem that provides cops for validating RBS::Inline type annotation comments in Ruby code. It checks syntax, formatting, and redundancy of `#:` and `# @rbs` style annotations.
+
+## Common Commands
+
+```bash
+# Run tests
+bin/rspec
+bin/rspec spec/rubocop/cop/style/rbs_inline/invalid_comment_spec.rb      # single file
+bin/rspec spec/rubocop/cop/style/rbs_inline/invalid_comment_spec.rb:8     # single example
+
+# Lint
+bin/rake rubocop
+bin/rake rubocop:autocorrect       # safe autocorrect
+bin/rake rubocop:autocorrect_all   # all autocorrect
+
+# Type check
+bin/rake rbs:check                 # runs steep check
+
+# Default rake task (runs specs, rubocop, and type check)
+bin/rake
+
+# Generate a new cop
+bin/rake 'new_cop[Style/RbsInline/CopName]'
+```
+
+## Architecture
+
+### Cop Structure
+
+All cops live under `RuboCop::Cop::Style::RbsInline` namespace in `lib/rubocop/cop/style/rbs_inline/`. Each cop validates a different aspect of RBS::Inline annotations:
+
+- **InvalidComment** - Validates `#:` and `# @rbs` comment syntax
+- **InvalidTypes** - Validates RBS type syntax in annotations
+- **KeywordSeparator** - Ensures keywords like `module-self` aren't followed by `:`
+- **ParametersSeparator** - Ensures parameter annotations use `:` separator
+- **RedundantArgumentType** - Detects redundant argument type specs (configurable style)
+- **RedundantReturnType** - Detects redundant return type specs (3 style options)
+- **UnmatchedAnnotations** - Ensures annotation parameters match actual method parameters
+
+### Shared CommentParser Module
+
+`comment_parser.rb` is a module mixed into cops that need to parse RBS::Inline annotations. It uses `RBS::Inline::AnnotationParser` and Prism to parse comments, and provides helpers for finding leading annotations, inline comments, and return annotations relative to method definitions.
+
+### Plugin System
+
+The gem integrates with RuboCop via LintRoller (`lib/rubocop/rbs_inline/plugin.rb`). Default cop configuration is in `config/default.yml`.
+
+### Type Signatures
+
+RBS type signatures for all source files are maintained in `sig/` directory. The project uses Steep for static type checking, configured via `Steepfile`.
+
+### Testing Pattern
+
+Tests use RuboCop's RSpec support helpers (`expect_offense` / `expect_no_offenses`). Test files mirror the cop file structure under `spec/rubocop/cop/style/rbs_inline/`.
+
+## Code Style Notes
+
+- `Layout/LeadingCommentSpace` and `Style/CommentedKeyword` are disabled because RBS::Inline `#:` comments violate these rules by design.
+- Max line length: 120 characters.
+- The codebase itself uses RBS::Inline annotations (`#:` and `# @rbs` comments) for type definitions.