lint_roller 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 247433b599df47c6817d7afaafd5da089706ebcae854383d12e96c6c9551113a
+  data.tar.gz: 1f6d77951ed64e2f52d5145fed81b8eb0d5ad1befa353e20b3ce65c33d233e50
+SHA512:
+  metadata.gz: d826ec3722b1d85f1f718519ea5958e89dc22878f02e9e6f3b4d601a2a1e8d159be91a0c4f7dc1de0fb5245add220d4d656f6547b6d24f33d6dc84ae77347e09
+  data.tar.gz: d86e1f61d4eb7702014e5509d83a424fa74fb20efcb0209f775213313db90ee4e5cf2446a58038b002efd6532bcc9059fd72cb03dc7ef96f11b84bcc28f2b257

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [1.0.0]
+
+- Initial release

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in lint_roller.gemspec
+gemspec
+
+gem "rake"
+gem "minitest"
+gem "standard"
+gem "m"

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    lint_roller (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    m (1.6.1)
+      method_source (>= 0.6.7)
+      rake (>= 0.9.2.2)
+    method_source (1.0.0)
+    minitest (5.18.0)
+    parallel (1.22.1)
+    parser (3.2.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rubocop (1.48.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.16.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    standard (1.26.0)
+      language_server-protocol (~> 3.17.0.2)
+      rubocop (~> 1.48.1)
+      rubocop-performance (~> 1.16.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  lint_roller!
+  m
+  minitest
+  rake
+  standard
+
+BUNDLED WITH
+   2.4.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Test Double, Inc.
+
+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,176 @@
+# lint_roller - A plugin specification for linters
+
+`lint_roller` is an itty-bitty plugin API for code analysis tools like linters
+and formatters. It provides plugins for those tools to load extensions and
+specify custom rulesets.
+
+(As of this release, only [Standard
+Ruby](https://github.com/standardrb/standard) supports `lint_roller` plugins,
+but we think [RuboCop](https://github.com/rubocop/rubocop) could add support and
+most plugins would be compatible with both `rubocop` and `standardrb`.
+Additionally, there's nothing that would prevent other tools like
+[rufo](https://github.com/ruby-formatter/rufo) from adopting it.)
+
+## How to make a plugin
+
+If you want to make a plugin, the first thing you should do is extend
+[LintRoller::Plugin](/lib/lint_roller/plugin.rb) with a custom class. Let's take
+this example plugin for banana-related static analysis:
+
+```ruby
+module BananaRoller
+  class Plugin
+    # `config' is a Hash of options passed to the plugin by the user
+    def initialize(config = {})
+      @alternative = config["alternative"] ||= "chocolate"
+    end
+
+    def about
+      LintRoller::About.new(
+        name: "banana_roller",
+        version: "1.0", # or, in a gem, probably BananaRoller::VERSION
+        homepage: "https://github.com/example/banana_roller",
+        description: "Configuration of banana-related code"
+      )
+    end
+
+    # `context' is an instance of LintRoller::Context provided by the runner
+    def supported?(context)
+      if context.engine == :rubocop
+        true
+      else
+        false
+      end
+    end
+
+    # `context' is an instance of LintRoller::Context provided by the runner
+    def rules(context)
+      LintRoller::Rules.new(
+        type: :path,
+        config_format: :rubocop,
+        value: Pathname.new(__dir__).join("../../config/default.yml")
+      )
+    end
+  end
+end
+```
+
+And that's pretty much it. Just a declarative way to identify your plugin,
+detect whether it supports the given context (e.g. the current `runner` and
+`engine` and their respective `_version`s), and then provides your custom
+configuration as a [LintRoller::Rules](lib/lint_roller/rules.rb) object.
+
+## Packaging a plugin in a gem
+
+In order for a formatter to use your plugin, it needs to know where to what path
+to require and the name of your plugin class to instantiate and invoke.
+
+To make this work seamlessly for your users without additional configuration of
+their own, all you need to do is specify a metadata attribute called
+`default_lint_roller_plugin` in your gemspec.
+
+Taking [standard-custom](https://github.com/standardrb/standard-custom) as an
+example, its gemspec contains:
+
+```ruby
+Gem::Specification.new do |spec|
+  # …
+  spec.metadata["default_lint_roller_plugin"] = "Standard::Custom::Plugin"
+  # …
+end
+```
+
+Because gem specs are loaded by RubyGems and Bundler very early, remember to
+specify the plugin as a string representation of the constant, as load order
+usually matters, and most tools will need to be loaded before any custom
+extensions. Hence, `"Standard::Custom::Plugin"` instead of
+`Standard::Custom::Plugin`.
+
+## Using your plugin
+
+Once you've made your plugin, here's how it's configured from a Standard Ruby
+`.standard.yml` file.
+
+### If your plugin is packaged as a gem
+
+Packaging your plugin in a gem is the golden path, both because distributing
+code via [RubyGems.org](https://rubygems.org) is very neat, but also because it
+makes the least work for your users.
+
+If your gem name is `banana_roller` and you've set
+`spec.metadata["default_lint_roller_plugin"]` to `"BananaRoller::Plugin"`, then
+your users could just add this to their `.standard.yml` file:
+
+```yaml
+plugins:
+  - banana_roller
+```
+
+And that's it! During initialization, `standardrb` will `require
+"banana_roller"` and know to call `BananaRoller::Plugin.new(config)` to
+instantiate it.
+
+### If your plugin ISN'T in a gem
+
+If you're developing a plugin for internal use or in conjunction with a single
+project, you may want it to live in the same repo as opposed to packaging it in
+a gem.
+
+To do this, then—in lieu of a gem name—provide the path you want to be required
+as its name, and (since there is no `spec.metadata` to learn of your plugin's
+class name), specify it as an option on the plugin:
+
+```yaml
+plugins:
+  - lib/banana_roller/plugin:
+      plugin_class_name: BananaRoller::Plugin
+```
+
+(Be careful with the indentation here! Any configuration under a plugin must be
+indented in order for it to be parsed as a hash under the
+`"lib/banana_roller/plugin"` key.)
+
+Additionally, if you want the plugin's name to make more sense, you can give
+it whatever name you like in the configuration and specify the `require_path`
+explicitly:
+
+```yaml
+plugins:
+  - banana_roller:
+      require_path: lib/banana_roller/plugin
+      plugin_class_name: BananaRoller::Plugin
+```
+
+### Passing user configuration to the plugin
+
+When a `LintRoller::Plugin` is instantiated, users can pass a configuration hash
+that tells your plugin how to behave.
+
+To illustrate how this works in Standard Ruby, anything passed as a hash beneath
+a plugin will be passed to the class's `initialize` method:
+
+```yaml
+plugins:
+  - apple_roller
+  - banana_roller:
+      require_path: lib/banana_roller/plugin
+      plugin_class_name: BananaRoller::Plugin
+      alternative: "apples"
+  - orange_roller:
+      rind: false
+```
+
+In the above case, `apple_roller`'s plugin class will be instantiated with
+`new({})`, `banana_roller` will get all 3 of those parameters passed
+`BananaRoller::Plugin.new({require_path…})`, and `orange_roller`'s class will be
+called with `new({rind: false})`.
+
+## Code of Conduct
+
+This project follows Test Double's [code of
+conduct](https://testdouble.com/code-of-conduct) for all community interactions,
+including (but not limited to) one-on-one communications, public posts/comments,
+code reviews, pull requests, and GitHub issues. If violations occur, Test Double
+will take any action they deem appropriate for the infraction, up to and
+including blocking a user from the organization's repositories.
+

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "standard/rake"
+
+task default: %i[test standard:fix]

data/lib/lint_roller/about.rb

@@ -0,0 +1,9 @@
+module LintRoller
+  About = Struct.new(
+    :name, # "standard-performance"
+    :version, # "1.2.3"
+    :homepage, # "https://github.com/testdouble/standard-performance"
+    :description, # "A configuration of rubocop-performance rules to make Ruby go faster"
+    keyword_init: true
+  )
+end

data/lib/lint_roller/context.rb

@@ -0,0 +1,11 @@
+module LintRoller
+  Context = Struct.new(
+    :runner, # :standard, :rubocop
+    :runner_version, # "1.2.3"
+    :engine, # :rubocop
+    :engine_version, # "2.3.4",
+    :rule_format, # :rubocop
+    :target_ruby_version, # Gem::Version.new("2.7.0")
+    keyword_init: true
+  )
+end

data/lib/lint_roller/error.rb

@@ -0,0 +1,4 @@
+module LintRoller
+  class Error < StandardError
+  end
+end

data/lib/lint_roller/plugin.rb

@@ -0,0 +1,22 @@
+module LintRoller
+  class Plugin
+    # `config' is a Hash of options passed to the plugin by the user
+    def initialize(config = {})
+      @config = config
+    end
+
+    def about
+      raise Error.new("Please implement `about` and return an instance of LintRoller::About")
+    end
+
+    # `context' is an instance of LintRoller::Context provided by the runner
+    def supported?(context)
+      true
+    end
+
+    # `context' is an instance of LintRoller::Context provided by the runner
+    def rules(context)
+      raise Error.new("Please implement `rules(context)` and return an instance of LintRoller::Rules")
+    end
+  end
+end

data/lib/lint_roller/rules.rb

@@ -0,0 +1,17 @@
+module LintRoller
+  Rules = Struct.new(
+    # Valid values: :path, :object, :error
+    :type,
+    # Only known value right now is :rubocop but nothing would stop rufo or
+    # rubyfmt or prettier from adding support without a change to the gem
+    :config_format,
+    # If type is :path, String or Pathname. Otherwise, whatever :object type
+    # makes sense given :config_format (e.g. for RuboCop, a Hash loaded from a
+    # YAML file; note that providing a hash will prevent the use of RuboCop features
+    # like `inherit_from' and `require'!)
+    :value,
+    # If something went wrong an Error for the runner to deal with appropriately
+    :error,
+    keyword_init: true
+  )
+end

data/lib/lint_roller/version.rb

@@ -0,0 +1,3 @@
+module LintRoller
+  VERSION = "1.0.0"
+end

data/lib/lint_roller.rb

@@ -0,0 +1,11 @@
+require_relative "lint_roller/version"
+
+require_relative "lint_roller/about"
+require_relative "lint_roller/context"
+require_relative "lint_roller/rules"
+
+require_relative "lint_roller/plugin"
+require_relative "lint_roller/error"
+
+module LintRoller
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: lint_roller
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Justin Searls
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-15 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- searls@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/lint_roller.rb
+- lib/lint_roller/about.rb
+- lib/lint_roller/context.rb
+- lib/lint_roller/error.rb
+- lib/lint_roller/plugin.rb
+- lib/lint_roller/rules.rb
+- lib/lint_roller/version.rb
+homepage: https://github.com/standardrb/lint_roller
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/standardrb/lint_roller
+  source_code_uri: https://github.com/standardrb/lint_roller
+  changelog_uri: https://github.com/standardrb/lint_roller/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: A plugin specification for linter and formatter rulesets
+test_files: []