rubocop-rbs 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d4c9bb32e6323c9c18f2b096da62d0e22e18be953d63aaa5604a2dd08861af7
-  data.tar.gz: 9b593cc7039f03b3cc07635fd0b25a465d404289decabe459befe45c1431efa5
+  metadata.gz: 7053fde02f4e277c641087d31f649ab76b8f017d9f789d72ce1eccdabffe0c8c
+  data.tar.gz: ffe77e48590facabf35d3e06d5d8c3d369d0bbe96d3778113dc293a18b55db33
 SHA512:
-  metadata.gz: 5f8b812d5aa182a68e3ca9e4da6cc0e48df67b43851f32f0b740a3d1e29c0095b0c6f4d949374c0ff195e8019c7014bcf9b7add13a76473d1b5f5963decd8a13
-  data.tar.gz: 6ffd5e997d7995e223cf9de22b0f56b29b4de840965e84881ac00140f0095c818d6391e42e596508051d19c8a3c24882b040516fc5fd38d0384fd2ea8a6a94b6
+  metadata.gz: 9f3bbb652c3834d9ee604f58a35782d442ef82aae6c484f879983d4dd26b2822f213fd92bcc64fd6e04b414776010238a278ce6bc199da48c0bf9adf5c06671e
+  data.tar.gz: 6a66ed9bbd891c9cea8cab5c55f85ccbef0d1966ec65dee374f0d2e39eff89c939e0d0f2c73542dee0d35897440f917e7aac5da91fc0684993575f0b738ddc65

data/README.md

@@ -1,5 +1,7 @@
 # RuboCop RBS
 
+[![Gem Version](https://badge.fury.io/rb/rubocop-rbs.svg)](https://badge.fury.io/rb/rubocop-rbs)
+
 RucoCop extension that check RBS signatures.
 
 > DISCLAIMER: this extension is an ALPHA version, it could be not 100% stable
@@ -15,17 +17,49 @@ Please ⭐ if you like it.
 
 ## Install
 
-- Add to your Gemfile: `gem 'rubocop-rbs'` (and execute bundle)
+- Add to _Gemfile_: `gem 'rubocop-rbs', '~> 0.1.1'` (and execute bundle);
+- Add to _.rubocop.yml_:
 
-## Usage
+```yml
+require:
+  - rubocop-rbs
+```
 
-- Execute `rubocop`
+## Usage
 
-To disable the cop:
+- Execute rubocop: `bundle exec rubocop`
+- To skip the cop from some files:
 
 ```yml
 Rbs/MethodSignature:
-  Enabled: false
+  Exclude:
+    - main.rb
+```
+
+## Offenses
+
+- _Rbs/MethodSignature: signature error_: one or more signature errors in a RBS file:
+
+```
+main.rb:7:3: C: Rbs/MethodSignature: signature error, sig/main.rbs:1:0...1:3: Syntax error: cannot start a declaration, token=def (kDEF)
+  def test_required_positionals(key1, key2); end
+  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+```
+
+- _Rbs/MethodSignature: missing signature_: method signature not found in the RBS files:
+
+```
+main.rb:7:3: C: Rbs/MethodSignature: missing signature
+  def test_required_positionals(key1, key2); end
+  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+```
+
+- _Rbs/MethodSignature: signature mismatch_: method signature has different arguments from the one defined in the RBS files:
+
+```
+main.rb:7:3: C: Rbs/MethodSignature: signature mismatch, expected: (untyped, untyped, untyped) -> void
+  def test_required_positionals(key1, key2); end
+  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 ```
 
 ## Do you like it? Star it!

data/lib/rubocop/cop/rbs/method_signature.rb

@@ -74,7 +74,7 @@ module RuboCop
         end
 
         def arity_arg_match?(arity, rbs_args)
-          arity[:arg].to_i == rbs_args.required_positionals.count
+          arity[:arg].to_i == (rbs_args.required_positionals.count + rbs_args.trailing_positionals.count)
         end
 
         def arity_optarg_match?(arity, rbs_args)

data/lib/rubocop/rbs/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Rbs
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rbs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-02 00:00:00.000000000 Z
+date: 2023-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbs