class-metrix 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 440b6eacf85b731cd683533be57ab3b2c17b25605ce70ed650bed43539f34531
-  data.tar.gz: 728575b7ddac28f55d5d192f3e1004858f19820453a9e6c3d00002df50855c92
+  metadata.gz: 9b893eab40ee30c91bfb72059fcaffc282efca2088e4e150d2cf89c7fb0ff835
+  data.tar.gz: 553832b76ef1c44f6ace2cb7b37808dc2e18ef3c2f16882cc2aa951d1d9b82b3
 SHA512:
-  metadata.gz: 868af534a658dc3a083315ee1660f4ba8754919474ac3d6c5c2458f2a5af8df763bfa292d6d1c426a0df20b4ef3419cd7cc031397bd14ed3a563f0dee07b605c
-  data.tar.gz: 9bcfe4160f94b93abf072e1888c92222a790387f16e16d376ef93be48c28d4ac7ee1edd931c6b9e70236c64e3bec17d0610c2561db14ab80e60d4f0ed1a6af41
+  metadata.gz: 98297596048b427aa614a18ab3bb01cde37382b95df9b10dd2d9e2856db0afccdc420245e6b5f84ac676fa35bd7b6b68e8d945bf58f987526c39fde840d05a8f
+  data.tar.gz: dc3729ab21692725a5660b781c51c81282640640a3fae6d11328fb0485f30f4af4e30e71c74e987a3ad5709726878fb04713e349098bd4df0538468416b0099f

data/.vscode/README.md

@@ -1,72 +1,128 @@
-# VS Code Works### Ruby Support
+# VS Code Configuration for ClassMetrix
 
-- **Ruby LSP** (`shopify.ruby-lsp`) - Primary Ruby language server with Rubocop formatting
-- **Solargraph** (`castwide.solargraph`) - Alternative Ruby IntelliSense
+## 🎯 Overview
 
-### Markdown Support
+This directory contains comprehensive VS Code configuration for the ClassMetrix Ruby gem development with full RBS (Ruby Signature) and Steep type checking integration.
 
-- **Prettier** (`esbenp.prettier-vscode`) - Primary Markdown formatter
-- **Markdown All in One** (`yzhang.markdown-all-in-one`) - Comprehensive Markdown support
-- **markdownlint** (`davidanson.vscode-markdownlint`) - Markdown lintingnfiguration
+## 📦 Extensions
 
-This folder contains VS Code workspace configuration files that help maintain consistent development environment across team members.
+### Required Extensions
 
-## Files Overview
+- **Ruby LSP** (`shopify.ruby-lsp`) - Primary Ruby language support
+- **RBS Syntax** (`soutaro.rbs-syntax`) - RBS file syntax highlighting
+- **Steep VS Code** (`soutaro.steep-vscode`) - Type checking integration
+- **RBS Snippets** (`mateuszdrewniak.rbs-snippets`) - Code snippets for RBS
 
-- **settings.json**: Workspace-specific settings for Ruby and Markdown formatting
-- **extensions.json**: Recommended extensions for this project
-- **tasks.json**: Predefined tasks for common operations (Rubocop, RSpec)
-- **launch.json**: Debug configurations for Ruby files and tests
+### Optional Extensions
 
-## Required Extensions
+- **Ruby Debugger** (`koichisasada.vscode-rdbg`) - Debugging support
+- **GitLens** (`eamodio.gitlens`) - Enhanced Git integration
+- **Markdown All in One** (`yzhang.markdown-all-in-one`) - Documentation support
 
-To get the best development experience, install these recommended extensions:
+## ⚙️ Settings Configuration
 
-### Ruby Support
+### Ruby Language Support
 
-- **Ruby LSP** (`shopify.ruby-lsp`) - Primary Ruby language server
-- **Solargraph** (`castwide.solargraph`) - Alternative Ruby IntelliSense
+- **Format on Save**: Enabled with RuboCop
+- **Ruby LSP**: Full feature set enabled
+- **Semantic Highlighting**: Enabled for both Ruby and RBS files
 
-### Markdown Support
+### RBS Type Checking
 
-- **Markdown All in One** (`yzhang.markdown-all-in-one`) - Comprehensive Markdown support
-- **markdownlint** (`davidanson.vscode-markdownlint`) - Markdown linting
+- **Steep Integration**: Real-time type checking
+- **Diagnostics**: Enabled for immediate feedback
+- **File Associations**: `.rbs` files properly recognized
 
-### General
+### Code Quality
 
-- **EditorConfig** (`editorconfig.editorconfig`) - Consistent coding styles
-- **GitLens** (`eamodio.gitlens`) - Enhanced Git capabilities
+- **RuboCop**: Integrated for code formatting and linting
+- **Auto-fix on Save**: Automatic code corrections
 
-## Auto-formatting
+## 🛠️ Available Tasks
 
-The configuration enables automatic formatting on save for:
+### Ruby Development Tasks
 
-- **Ruby files**: Using Rubocop via Ruby LSP (Shopify.ruby-lsp)
-- **Markdown files**: Using Prettier formatter
-- **Format on type**: Enabled for Ruby files for real-time formatting
+- **`Ctrl+Shift+P` → "Tasks: Run Task"**
 
-## Available Tasks
+| Task                        | Description                 | Shortcut               |
+| --------------------------- | --------------------------- | ---------------------- |
+| `Rubocop: Check`            | Lint all Ruby files         | -                      |
+| `Rubocop: Fix`              | Auto-fix all RuboCop issues | `Ctrl+Shift+R, Ctrl+R` |
+| `Rubocop: Fix Current File` | Fix current file only       | -                      |
+| `RSpec: Run All Tests`      | Run entire test suite       | -                      |
+| `RSpec: Run Current File`   | Run tests for current file  | -                      |
 
-Access via `Ctrl+Shift+P` → "Tasks: Run Task":
+### Type Checking Tasks
 
-- **Rubocop: Check** - Run Rubocop linting
-- **Rubocop: Fix** - Auto-fix Rubocop violations
-- **Rubocop: Fix Current File** - Fix violations in current file only
-- **RSpec: Run All Tests** - Run complete test suite
-- **RSpec: Run Current File** - Run tests for current file
-- **Bundle Install** - Install/update gems
+| Task                       | Description                 | Shortcut               |
+| -------------------------- | --------------------------- | ---------------------- |
+| `RBS: Validate`            | Validate RBS syntax         | `Ctrl+Shift+R, Ctrl+V` |
+| `RBS: Generate Prototypes` | Generate RBS from Ruby code | -                      |
+| `Steep: Type Check`        | Run type checking           | `Ctrl+Shift+R, Ctrl+S` |
+| `Steep: Watch Mode`        | Continuous type checking    | `Ctrl+Shift+R, Ctrl+W` |
 
-## Debug Configurations
+### Build Tasks
 
-Available debug configurations:
+| Task             | Description              |
+| ---------------- | ------------------------ |
+| `Bundle Install` | Install gem dependencies |
 
-- **Ruby: Run Current File** - Debug the currently open Ruby file
-- **RSpec: Debug Current File** - Debug tests in current file
-- **RSpec: Debug All Tests** - Debug entire test suite
+## ⌨️ Keyboard Shortcuts
 
-## Setup Instructions
+### Custom Shortcuts
 
-1. Open this project in VS Code
-2. Install recommended extensions (VS Code will prompt you)
-3. Run "Bundle Install" task to ensure gems are installed
-4. Start coding! Auto-formatting will work on save
+- **`Ctrl+Shift+R, Ctrl+V`**: RBS Validate
+- **`Ctrl+Shift+R, Ctrl+S`**: Steep Type Check
+- **`Ctrl+Shift+R, Ctrl+W`**: Steep Watch Mode
+- **`Ctrl+Shift+R, Ctrl+R`**: RuboCop Fix
+
+### Usage Pattern
+
+1. Press `Ctrl+Shift+R` to enter "Ruby mode"
+2. Press the second key for the specific action
+
+## 📝 Code Snippets
+
+### RBS Snippets
+
+- **`rbsclass`**: Complete RBS class template
+- **`rbsmodule`**: RBS module template
+- **`rbsmethod`**: Method signature
+- **`rbsattr_reader`**: Attribute reader
+- **`rbsattr_writer`**: Attribute writer
+- **`rbsattr_accessor`**: Attribute accessor
+
+### Usage
+
+1. Type snippet prefix in `.rbs` file
+2. Press `Tab` to expand
+3. Use `Tab` to navigate through placeholders
+
+## 🚀 Getting Started
+
+### 1. Install Extensions
+
+VS Code will prompt to install recommended extensions when you open the workspace.
+
+### 2. Verify Setup
+
+1. Open any `.rb` file - should have Ruby LSP support
+2. Open any `.rbs` file - should have syntax highlighting
+3. Run `Ctrl+Shift+R, Ctrl+S` - should type check without errors
+
+### 3. Start Development
+
+1. Use `Ctrl+Shift+R, Ctrl+W` to start watch mode
+2. Edit Ruby files - see real-time type checking
+3. Use code snippets for rapid RBS development
+
+## 📊 Current Status
+
+✅ **Type Safety**: 100% (0 Steep errors)
+✅ **RBS Coverage**: Complete for all extractors
+✅ **VS Code Integration**: Fully configured
+✅ **Development Workflow**: Optimized
+
+---
+
+This VS Code setup provides a complete Ruby development environment with modern type checking capabilities.

data/.vscode/extensions.json

@@ -1,10 +1,15 @@
-{  "recommendations": [
+{
+  "recommendations": [
     // Ruby language support
     "shopify.ruby-lsp",
-    "castwide.solargraph",
 
-    // Alternative Ruby support (choose one of the above)
-    // "rebornix.ruby",
+    // RBS and Steep support (type checking)
+    "soutaro.rbs-syntax",
+    "soutaro.steep-vscode",
+    "mateuszdrewniak.rbs-snippets",
+
+    // Debugging support
+    "koichisasada.vscode-rdbg",
 
     // Markdown support
     "esbenp.prettier-vscode",
@@ -21,8 +26,6 @@
 
     // Additional helpful extensions
     "ms-vscode.test-adapter-converter",
-    "hbenl.vscode-test-explorer",
-    "formulahendry.auto-rename-tag",
-    "bradlc.vscode-tailwindcss"
+    "hbenl.vscode-test-explorer"
   ]
 }

data/.vscode/keybindings.json

@@ -0,0 +1,26 @@
+[
+  {
+    "key": "ctrl+shift+r ctrl+v",
+    "command": "workbench.action.tasks.runTask",
+    "args": "RBS: Validate",
+    "when": "editorTextFocus"
+  },
+  {
+    "key": "ctrl+shift+r ctrl+s",
+    "command": "workbench.action.tasks.runTask",
+    "args": "Steep: Type Check",
+    "when": "editorTextFocus"
+  },
+  {
+    "key": "ctrl+shift+r ctrl+w",
+    "command": "workbench.action.tasks.runTask",
+    "args": "Steep: Watch Mode",
+    "when": "editorTextFocus"
+  },
+  {
+    "key": "ctrl+shift+r ctrl+r",
+    "command": "workbench.action.tasks.runTask",
+    "args": "Rubocop: Fix",
+    "when": "editorTextFocus"
+  }
+]

data/.vscode/rbs.code-snippets

@@ -0,0 +1,61 @@
+{
+  "RBS Class Definition": {
+    "prefix": "rbsclass",
+    "body": [
+      "class ${1:ClassName}",
+      "  ${2:# Instance variables}",
+      "  ${3:@var}: ${4:Type}",
+      "",
+      "  ${5:# Methods}",
+      "  def initialize: (${6:params}) -> void",
+      "  def ${7:method_name}: (${8:params}) -> ${9:ReturnType}",
+      "",
+      "  private",
+      "",
+      "  def ${10:private_method}: () -> ${11:ReturnType}",
+      "end"
+    ],
+    "description": "RBS class definition template"
+  },
+  "RBS Module Definition": {
+    "prefix": "rbsmodule",
+    "body": [
+      "module ${1:ModuleName}",
+      "  ${2:# Module methods}",
+      "  def self.${3:method_name}: (${4:params}) -> ${5:ReturnType}",
+      "",
+      "  ${6:# Instance methods}",
+      "  def ${7:method_name}: (${8:params}) -> ${9:ReturnType}",
+      "end"
+    ],
+    "description": "RBS module definition template"
+  },
+  "RBS Method Definition": {
+    "prefix": "rbsmethod",
+    "body": [
+      "def ${1:method_name}: (${2:params}) -> ${3:ReturnType}"
+    ],
+    "description": "RBS method definition"
+  },
+  "RBS Attribute Reader": {
+    "prefix": "rbsattr_reader",
+    "body": [
+      "attr_reader ${1:attribute}: ${2:Type}"
+    ],
+    "description": "RBS attribute reader"
+  },
+  "RBS Attribute Writer": {
+    "prefix": "rbsattr_writer",
+    "body": [
+      "attr_writer ${1:attribute}: ${2:Type}"
+    ],
+    "description": "RBS attribute writer"
+  },
+  "RBS Attribute Accessor": {
+    "prefix": "rbsattr_accessor",
+    "body": [
+      "attr_accessor ${1:attribute}: ${2:Type}"
+    ],
+    "description": "RBS attribute accessor"
+  }
+}

data/.vscode/settings.json

@@ -39,13 +39,24 @@
       "other": "off"
     }
   },
+  "[rbs]": {
+    "editor.defaultFormatter": "soutaro.rbs-syntax",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+    "editor.insertSpaces": true,
+    "editor.semanticHighlighting.enabled": true,
+    "editor.rulers": [120],
+    "editor.trimAutoWhitespace": true
+  },
 
   // File associations
   "files.associations": {
     "*.gemspec": "ruby",
     "Gemfile": "ruby",
     "Rakefile": "ruby",
-    ".rubocop.yml": "yaml"
+    ".rubocop.yml": "yaml",
+    "*.rbs": "rbs",
+    "Steepfile": "ruby"
   },
 
   // Auto-save settings
@@ -81,6 +92,19 @@
   "ruby.rubocop.configFilePath": ".rubocop.yml",
   "ruby.rubocop.suppressRubocopWarnings": false,
 
+  // Steep type checker settings
+  "steep.enabled": true,
+  "steep.checkOnSave": true,
+  "steep.diagnosticsEnabled": true,
+  "steep.signatureHelp": true,
+  "steep.hover": true,
+
+  // RBS validation settings
+  "ruby.rbs": {
+    "enabled": true,
+    "diagnostics": true
+  },
+
   // Additional helpful settings
   "breadcrumbs.enabled": true,
   "editor.minimap.enabled": true,

data/.vscode/tasks.json

@@ -94,6 +94,147 @@
         "focus": false,
         "panel": "shared"
       }
+    },
+    {
+      "label": "RBS: Validate",
+      "type": "shell",
+      "command": "bundle",
+      "args": ["exec", "rbs", "validate"],
+      "group": "test",
+      "presentation": {
+        "echo": true,
+        "reveal": "always",
+        "focus": false,
+        "panel": "shared"
+      },
+      "problemMatcher": [
+        {
+          "owner": "rbs",
+          "fileLocation": "absolute",
+          "pattern": [
+            {
+              "regexp": "^([^:]+):(\\d+):(\\d+): (.*)$",
+              "file": 1,
+              "line": 2,
+              "column": 3,
+              "message": 4
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "label": "Steep: Type Check",
+      "type": "shell",
+      "command": "bundle",
+      "args": ["exec", "steep", "check"],
+      "group": "test",
+      "presentation": {
+        "echo": true,
+        "reveal": "always",
+        "focus": false,
+        "panel": "shared"
+      },
+      "problemMatcher": [
+        {
+          "owner": "steep",
+          "fileLocation": "absolute",
+          "pattern": [
+            {
+              "regexp": "^([^:]+):(\\d+):(\\d+): \\[([^\\]]+)\\] (.*)$",
+              "file": 1,
+              "line": 2,
+              "column": 3,
+              "severity": 4,
+              "message": 5
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "label": "Steep: Watch Mode",
+      "type": "shell",
+      "command": "bundle",
+      "args": ["exec", "steep", "watch", "lib"],
+      "group": "build",
+      "isBackground": true,
+      "presentation": {
+        "echo": true,
+        "reveal": "always",
+        "focus": false,
+        "panel": "shared"
+      },
+      "problemMatcher": [
+        {
+          "owner": "steep",
+          "fileLocation": "absolute",
+          "pattern": [
+            {
+              "regexp": "^([^:]+):(\\d+):(\\d+): \\[([^\\]]+)\\] (.*)$",
+              "file": 1,
+              "line": 2,
+              "column": 3,
+              "severity": 4,
+              "message": 5
+            }
+          ],
+          "background": {
+            "activeOnStart": true,
+            "beginsPattern": "^# Type checking files:",
+            "endsPattern": "^(No type error detected|Detected \\d+ problems)"
+          }
+        }
+      ]
+    },
+    {
+      "label": "Steep: Watch All Targets",
+      "type": "shell",
+      "command": "bundle",
+      "args": ["exec", "steep", "watch", "--target", "lib"],
+      "group": "build",
+      "isBackground": true,
+      "presentation": {
+        "echo": true,
+        "reveal": "always",
+        "focus": false,
+        "panel": "shared"
+      },
+      "problemMatcher": [
+        {
+          "owner": "steep",
+          "fileLocation": "absolute",
+          "pattern": [
+            {
+              "regexp": "^([^:]+):(\\d+):(\\d+): \\[([^\\]]+)\\] (.*)$",
+              "file": 1,
+              "line": 2,
+              "column": 3,
+              "severity": 4,
+              "message": 5
+            }
+          ],
+          "background": {
+            "activeOnStart": true,
+            "beginsPattern": "^# Type checking files:",
+            "endsPattern": "^(No type error detected|Detected \\d+ problems)"
+          }
+        }
+      ]
+    },
+    {
+      "label": "RBS: Generate Prototypes",
+      "type": "shell",
+      "command": "bundle",
+      "args": ["exec", "rbs", "prototype", "rb", "lib"],
+      "group": "build",
+      "presentation": {
+        "echo": true,
+        "reveal": "always",
+        "focus": false,
+        "panel": "shared"
+      },
+      "problemMatcher": []
     }
   ]
 }

data/CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.1] - 2025-06-08
+
 ## [1.0.0] - 2025-06-07
 
 ### 🎉 Major Release - Production Ready