rubocop-on-rbs 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f2d0a08d15b11889f3e9cb30b870ab7f10708d79fc88984271cd0d1d229a6eb2
+  data.tar.gz: c5bbecab5e33bbbddcab3081b1df9c0370948e1c4cbd2fbe9ea1f9bb8e7cf820
+SHA512:
+  metadata.gz: 8153af6d71ecd6f087d9511de6a3caa2ded02a2edf6a1e51833a212d1a1fee269bfcf8c398b536ce89fedebf91b86784aba445117779101a64efb83e1082ffd8
+  data.tar.gz: aa38d915d25385ae67af7a84d7b480b28fcd23a6e4110e273e5d42571ff1b7bf5daf0116c7803b14297cbbd4a4f4e706836b2b1d6bc770edf8d81104f76aff46

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-05-15
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at co000ri@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 ksss
+
+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,186 @@
+# RuboCop on RBS
+
+A [RuboCop](https://github.com/rubocop/rubocop) extension focused on enforcing [RBS](https://github.com/ruby/rbs) best practices and coding conventions.
+
+## Synopsis
+
+Now, We can support RBS files by rubocop.
+
+```console
+$ cat sig/foo.rbs
+module Foo
+def foo: (   void) -> untyped
+end
+
+$ bundle exec rubocop sig/foo.rbs
+Inspecting 1 file
+W
+
+Offenses:
+
+sig/foo.rbs:2:1: C: [Correctable] RBS/Layout/IndentationWidth: Use 2 (not 0) spaces for indentation.
+def foo: (   void) -> untyped
+
+sig/foo.rbs:2:11: C: [Correctable] RBS/Layout/ExtraSpacing: Unnecessary spacing detected.
+def foo: (   void) -> untyped
+          ^^
+sig/foo.rbs:2:14: W: RBS/Lint/WillSyntaxError: void type is only allowed in return type or generics parameter
+def foo: (   void) -> untyped
+             ^^^^
+
+1 file inspected, 3 offenses detected, 2 offenses autocorrectable
+```
+
+## Support VSCode
+
+We are currently working on a response, but it is possible to modify part of [vscode-rubocop](https://github.com/rubocop/vscode-rubocop) as a temporary hack to use it in vscode as well.
+
+Open your installed vscode extension.
+
+```
+$ code ~/.vscode/extensions/rubocop.vscode-rubocop-X.Y.Z/
+```
+
+Search `documentSelector:[{`.
+
+Then, Edit to add following to `documentSelector[]`
+
+```js
+{scheme:"file",language:"rbs"}
+```
+
+Additionally, by configuring the `settings.json` below, you can enable auto-correction to run on file save.
+
+```json
+{
+    "[rbs]": {
+        "editor.formatOnSave": true,
+        "editor.defaultFormatter": "rubocop.vscode-rubocop"
+    },
+}
+```
+
+And restart VSCode.
+
+## Departments
+
+### RBS
+
+This gem handles many cops.
+All cops can be enabled by following setting by default.
+
+```yaml
+RBS:
+  Enabled: true
+```
+
+See `config/default.yml` for all Cop.
+
+### RBS/Layout
+
+This department is a collection of relatively minor fixes has been gathered.
+
+```yaml
+RBS/Layout:
+  Enabled: true
+```
+
+```console
+$ bundle exec rubocop --only RBS/Layout
+```
+
+### RBS/Lint
+
+This department is gathering important points that need to be fixed.
+
+```yaml
+RBS/Lint:
+  Enabled: true
+```
+
+```console
+$ bundle exec rubocop --only RBS/Lint
+```
+
+### RBS/Style
+
+This department unifies multiple styles.
+
+```yaml
+RBS/Style:
+  Enabled: true
+```
+
+```console
+$ bundle exec rubocop --only RBS/Style
+```
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+You need to tell RuboCop to load the RBS extension. There are three
+ways to do this:
+
+### RuboCop configuration file
+
+Put this into your `.rubocop.yml`.
+
+```yaml
+require: rubocop-on-rbs
+```
+
+Alternatively, use the following array notation when specifying multiple extensions.
+
+```yaml
+require:
+  - rubocop-other-extension
+  - rubocop-on-rbs
+```
+
+Now you can run `rubocop` and it will automatically load the RuboCop on RBS
+cops together with the standard cops.
+
+### Command line
+
+```sh
+$ rubocop --require rubocop-on-rbs
+```
+
+### Rake task
+
+```ruby
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-on-rbs'
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ksss/rubocop-on-rbs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ksss/rubocop-on-rbs/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RuboCop on RBS project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ksss/rubocop-on-rbs/blob/main/CODE_OF_CONDUCT.md).

data/config/default.yml

@@ -0,0 +1,165 @@
+inherit_mode:
+  merge:
+    - Exclude
+    - Include
+
+AllCops:
+  Include:
+    - '**/*.rbs'
+
+Lint:
+  Exclude:
+    - '**/*.rbs'
+
+# RBS
+
+RBS:
+  Enabled: true
+  Include:
+    - '**/*.rbs'
+
+## RBS/Layout
+
+RBS/Layout:
+  Enabled: true
+
+RBS/Layout/CommentIndentation:
+  Description: 'Use 2 spaces for comment indentation'
+  Enabled: true
+
+RBS/Layout/EmptyLineAroundOverloads:
+  Description: 'No empty line between overload'
+  Enabled: true
+
+RBS/Layout/EndAlignment:
+  Description: 'Align `end` keyword'
+  Enabled: true
+
+RBS/Layout/ExtraSpacing:
+  Description: 'Remove extra spacing'
+  Enabled: true
+
+RBS/Layout/IndentationWidth:
+  Description: 'Use 2 spaces for indentation'
+  Enabled: true
+
+RBS/Layout/OverloadIndentation:
+  Description: 'Indent overload method'
+  Enabled: true
+
+RBS/Layout/SpaceAroundArrow:
+  Description: 'Use space around `->`'
+  Enabled: true
+
+RBS/Layout/SpaceAroundBraces:
+  Description: 'Use space around `{}`'
+  Enabled: true
+
+RBS/Layout/SpaceBeforeColon:
+  Description: 'Use space before `:`'
+  Enabled: true
+
+RBS/Layout/SpaceBeforeOverload:
+  Description: 'Use space before overload method'
+  Enabled: true
+
+RBS/Layout/TrailingWhitespace:
+  Description: 'Remove trailing whitespace'
+  Enabled: true
+
+## RBS/Lint
+
+RBS/Lint:
+  Severity: warning
+  Enabled: true
+
+RBS/Lint/Syntax:
+  Description: 'Check RBS syntax'
+  Enabled: true
+
+RBS/Lint/TypeParamsArity:
+  Description: 'Check type params arity'
+  Enabled: true
+  Expects:
+    # Default expects.
+    # You can add expects in .rubocop.yml.
+
+    ## class/module
+    Array: 1
+    Enumerable: 1
+    Enumerator: 2
+    Enumerator::Chain: 1
+    Enumerator::Generator: 1
+    Enumerator::Lazy: 2
+    Enumerator::Product: 1
+    FrozenError: 1
+    Hash: 2
+    KeyError: 2
+    NameError: 1
+    NoMatchingPatternKeyError: 2
+    NoMethodError: 1
+    ObjectSpace::WeakKeyMap: 2
+    Range: 1
+    Set: 1
+    Struct: 1
+
+    ## interface
+    Array::_Pattern: 1
+    Enumerable::_NotFound: 1
+    Gem::_HashLike: 2
+    Kernel::_RationalDiv: 1
+    Marshal::_Proc: 1
+    String::_MatchAgainst: 2
+    _Each: 1
+    _EachEntry: 1
+    _Range: 1
+    _ToA: 1
+    _ToAry: 1
+    _ToH: 2
+    _ToHash: 2
+
+    ## type alias
+    array: 1
+    hash: 2
+    range: 1
+
+RBS/Lint/UselessOverloadTypeParams:
+  Description: 'Check useless overload type params'
+  Enabled: true
+
+RBS/Lint/WillSyntaxError:
+  Description: 'Check RBS will syntax error'
+  Enabled: true
+
+## RBS/Style
+
+RBS/Style:
+  Enabled: true
+
+RBS/Style/BlockReturnBoolish:
+  Description: 'Use `bool` for block return type'
+  Enabled: true
+
+RBS/Style/ClassicType:
+  Description: 'Use simple type'
+  Enabled: true
+
+RBS/Style/DuplicatedType:
+  Description: 'Check duplicated type'
+  Enabled: true
+
+RBS/Style/InitializeReturnType:
+  Description: 'Use `void` for initialize method'
+  Enabled: true
+
+RBS/Style/MergeUntyped:
+  Description: 'Merge to `untyped`'
+  Enabled: true
+
+RBS/Style/OptionalNil:
+  Description: 'Use nil instead of nil?'
+  Enabled: true
+
+RBS/Style/TrueFalse:
+  Description: 'Use bool instead of true | false'
+  Enabled: true

data/lib/rubocop/cop/rbs/layout/comment_indentation.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RBS
+      module Layout
+        # @example default
+        #   # bad
+        #     # comment here
+        #   def foo: () -> void
+        #
+        #   # good
+        #   # comment here
+        #   def foo: () -> void
+        class CommentIndentation < RuboCop::RBS::CopBase
+          extend AutoCorrector
+
+          MSG = "Incorrect indentation detected (column %<expect>s instead of %<actual>s)."
+
+          def on_rbs_new_investigation
+            indent_start_lines = Set.new
+            indent_end_lines = Set.new
+            processed_rbs_source.decls.each do |decl|
+              walk_decl(decl) do |d|
+                indent_start_lines << d.location.start_line
+                indent_end_lines << d.location.end_line
+              end
+            end
+
+            expected_width = 0
+            processed_rbs_source.tokens.each do |token|
+              case token.type
+              when :kMODULE, :kCLASS, :kINTERFACE
+                next unless indent_start_lines.include?(token.location.start_line)
+
+                expected_width += 2
+              when :kEND
+                next unless indent_end_lines.include?(token.location.start_line)
+
+                expected_width -= 2
+              when :tLINECOMMENT
+                if token.location.start_column != expected_width
+                  token_range = location_to_range(token.location)
+                  message = format(MSG, expect: expected_width, actual: token.location.start_column)
+                  add_offense(token_range, message: message) do |corrector|
+                    line_start_pos = processed_source.buffer.line_range(token.location.start_line).begin_pos
+                    indent = range_between(line_start_pos, token.location.start_pos)
+                    corrector.replace(indent, ' ' * expected_width)
+                  end
+                end
+              end
+            end
+          end
+
+          def walk_decl(decl, &block)
+            if decl.respond_to?(:members)
+              yield decl
+              decl.members.each { |member| walk_decl(member, &block) }
+            end
+          end
+
+          def tokenize(source)
+            ::RBS::Parser.lex(source).value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rbs/layout/empty_lines_around_overloads.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RBS
+      module Layout
+        # @example default
+        #   # bad
+        #   class Foo
+        #     def foo: () -> void
+        #     end
+        #
+        #   # good
+        #   class Foo
+        #     def foo: () -> void
+        #   end
+        class EmptyLinesAroundOverloads < RuboCop::RBS::CopBase
+          extend AutoCorrector
+
+          MSG = 'Empty line detected around overloads.'
+
+          def on_rbs_def(decl)
+            return unless 1 < decl.overloads.length
+
+            decl.overloads.each_cons(2) do |overload, next_overload|
+              check_empty_lines(overload, next_overload)
+            end
+          end
+
+          def check_empty_lines(overload, next_overload)
+            return if overload.method_type.location.end_line + 1 == next_overload.method_type.location.start_line
+
+            total = 0
+            range = overload.method_type.location.end_line...(next_overload.method_type.location.start_line - 1)
+            processed_source.raw_source.each_line.each_with_index do |line, lineno|
+              if range.cover?(lineno) && line == "\n"
+                empty_line = range_between(total, total + 1)
+                add_offense(empty_line) do |corrector|
+                  corrector.remove(empty_line)
+                end
+              end
+              total += line.length
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rbs/layout/end_alignment.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RBS
+      module Layout
+        # @example default
+        #   # bad
+        #   class Foo
+        #     def foo: () -> void
+        #     end
+        #
+        #   # good
+        #   class Foo
+        #     def foo: () -> void
+        #   end
+        class EndAlignment < RuboCop::RBS::CopBase
+          extend AutoCorrector
+
+          def on_rbs_new_investigation
+            processed_rbs_source.decls.each do |decl|
+              check_indentation(decl, expect: 0)
+            end
+          end
+
+          def check_indentation(decl, expect:)
+            if decl.location.key?(:end)
+              # module, class and interface
+              check(decl, expect: expect)
+              decl.members.each do |member|
+                check_indentation(member, expect: expect + 2)
+              end
+            end
+          end
+
+          def check(decl, expect:)
+            end_loc = decl.location[:end]
+            actual = end_loc.start_column
+            if actual != expect
+              line_start_pos = processed_source.raw_source.rindex(/\R/, end_loc.start_pos) + 1
+              range = range_between(end_loc.start_pos, end_loc.end_pos)
+              source = decl.location.source.each_line.first.strip
+              message = "`end` at #{end_loc.start_line}, #{end_loc.start_column} is not aligned with " \
+                        "`#{source}` at #{decl.location.start_line}, #{decl.location.start_column}."
+              add_offense(range, message: message) do |corrector|
+                whitespace = range_between(line_start_pos, end_loc.start_pos)
+                corrector.replace(whitespace, ' ' * expect)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end