sorbet_view 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8a0b48778cd35569ebf4fd8e6ab0adac11232ba3b59199eb33fa0bb2a5281cf
-  data.tar.gz: 40283808c1562e713e70e3ce70d31fa1058841c0d5bffa29bc33124a8b005b98
+  metadata.gz: 2019d3e1be947510db7affa9e59bb2762029b5fbef59aecc0ac8d9bbd3f669ca
+  data.tar.gz: f52c75816d4d3afe3e6fe693d3e3764679667be85675b23c8768bd5e5b22a45d
 SHA512:
-  metadata.gz: 24e77a9a6b85ae1e2d33b837ce91e9b8fd694e97d568eea83f942666b46a8806779949baaa8c5c0694ef2fad104abe490d1a09cacbfffc8bb57adc8f52f4d429
-  data.tar.gz: 3e8c78986b0d889de56f026a24b4eb79be312b536cd49cf6fca45a8515788cb08fe7f133ec71259994cf831f2a59aa79f04ecf04fdb78f13be4d260e9fc673e3
+  metadata.gz: 4d70e4367cec565f2f599fa91cdc144882f975203c735836bb5c446776b62e6a44063a53fa2b14086c4269d3c1562aa7ade61bda670d422f438e4ad5ece278b3
+  data.tar.gz: 814785d6a2872e1e250926bdf7d37d4a55cbcfa8a55ca71bfd3cd7b68150293a3703685bf9285c4b9b326678b60c5a33afe4b53ab6be98f253c854cecbb40ff9

data/README.md

@@ -0,0 +1,139 @@
+# SorbetView
+
+Sorbet type-checking for Rails view templates (ERB). Extracts Ruby code from templates, generates typed Ruby files, and provides LSP support for editor integration.
+
+## Features
+
+- Type-check Ruby code inside ERB templates with [Sorbet](https://sorbet.org/)
+- LSP proxy server for hover, completion, go-to-definition in `.erb` files
+- ViewComponent `erb_template` heredoc support
+- Source mapping between templates and generated Ruby for accurate error reporting
+- Tapioca DSL compiler for helper method RBI generation
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'sorbet_view'
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+## Setup
+
+Generate a config file:
+
+```bash
+bundle exec sv init
+```
+
+This creates `.sorbet_view.yml`:
+
+```yaml
+input_dirs:
+  - app/views
+
+exclude_paths: []
+
+output_dir: sorbet/templates
+
+extra_includes: []
+
+skip_missing_locals: true
+```
+
+### Configuration Options
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `input_dirs` | `['app/views']` | Directories to scan for `.erb` templates |
+| `exclude_paths` | `[]` | Paths to exclude from scanning |
+| `output_dir` | `'sorbet/templates'` | Where generated Ruby files are written |
+| `extra_includes` | `[]` | Additional modules to include in generated classes |
+| `extra_body` | `''` | Additional code to include in generated classes |
+| `skip_missing_locals` | `true` | Skip partials without `locals:` declaration |
+| `sorbet_path` | `'srb'` | Path to the Sorbet binary |
+| `typed_level` | `'true'` | Sorbet `typed` level for generated files |
+| `component_dirs` | `[]` | Directories to scan for ViewComponent files |
+
+## Usage
+
+### Compile templates
+
+```bash
+bundle exec sv compile
+```
+
+### Compile and type-check
+
+```bash
+bundle exec sv tc
+```
+
+Pass extra arguments to Sorbet after `--`:
+
+```bash
+bundle exec sv tc -- --error-url-base=https://srb.help/
+```
+
+### LSP server
+
+```bash
+bundle exec sv lsp
+```
+
+Used by the [VSCode extension](vscode/) for editor integration.
+
+### Clean generated files
+
+```bash
+bundle exec sv clean
+```
+
+## Declaring locals in partials
+
+Use magic comments to declare partial locals and their types:
+
+```erb
+<%# locals: (user:, admin: false) %>
+<%# locals_sig: sig { params(user: User, admin: T::Boolean).void } %>
+
+<h1><%= user.name %></h1>
+<% if admin %>
+  <p>Admin</p>
+<% end %>
+```
+
+## ViewComponent support
+
+Add `component_dirs` to your config:
+
+```yaml
+component_dirs:
+  - app/components
+```
+
+Components using `erb_template` heredocs are automatically detected and compiled.
+
+## Tapioca integration
+
+SorbetView includes a Tapioca DSL compiler that generates RBI files for controller helper methods. Run:
+
+```bash
+bundle exec tapioca dsl
+```
+
+## Requirements
+
+- Ruby >= 3.2
+- [Sorbet](https://sorbet.org/)
+- [herb](https://herb-tools.dev/) (for fast ERB parsing)
+
+## License
+
+MIT License. See [LICENSE](LICENSE) for details.

data/lib/sorbet_view/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module SorbetView
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/sorbet_view.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors = ['kazuma']
   spec.summary = 'Sorbet type-checking for Rails view templates'
   spec.description = 'Extracts Ruby code from view templates (ERB, etc.) for Sorbet type-checking, with LSP support'
-  spec.homepage = 'https://github.com/user/sorbet_view'
+  spec.homepage = 'https://github.com/kazzix14/sorbet_view'
   spec.license = 'MIT'
   spec.required_ruby_version = '>= 3.2'
 
@@ -30,5 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'listen', '~> 3.0'
   spec.add_dependency 'psych'
   spec.add_dependency 'sorbet-runtime'
-  spec.add_dependency 'srb_lens'
+  spec.add_dependency 'srb_lens', '~> 0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sorbet_view
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - kazuma
@@ -69,16 +69,16 @@ dependencies:
   name: srb_lens
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.0
 description: Extracts Ruby code from view templates (ERB, etc.) for Sorbet type-checking,
   with LSP support
 executables:
@@ -87,6 +87,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
+- README.md
 - Rakefile
 - exe/sv
 - lib/sorbet_view.rb
@@ -124,13 +125,13 @@ files:
 - vscode/package.json
 - vscode/src/extension.ts
 - vscode/tsconfig.json
-homepage: https://github.com/user/sorbet_view
+homepage: https://github.com/kazzix14/sorbet_view
 licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-  homepage_uri: https://github.com/user/sorbet_view
-  source_code_uri: https://github.com/user/sorbet_view
+  homepage_uri: https://github.com/kazzix14/sorbet_view
+  source_code_uri: https://github.com/kazzix14/sorbet_view
 rdoc_options: []
 require_paths:
 - lib