rubocop-katalyst 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f7856ab1894339789037570d66597d5c0001d6a4fd28a2a5bb228522e251ed2
-  data.tar.gz: 8cda1a7dd1232c75e87ca0d0ff2d05fe229e96e042737ed2839e02973741ec07
+  metadata.gz: 878afbb9d22a62f802f3e4379fd9a715be12dccaf4e0b3349142c67279c597a2
+  data.tar.gz: 5f280bcdb95e544029a7bebb381d41988ac939beca5b74c12bf4f4383be7ec32
 SHA512:
-  metadata.gz: fb176b91189adbcaa56fce98ce71de0405d757e4766f1e5119feb63e6e9f3672b4e4bf3aa13c00115b994656f18963fbc694b546ea9ca5499f8e76905cdb4090
-  data.tar.gz: 7f9636d40e7accedef362ebfd0e37aaf35f01113f15c8306b2e2b4797949f9d09f1ddde6eca7251e8cb588aa2b2ba171a97ba72bd76e7e9c36a62e9906a3f68d
+  metadata.gz: 420954d6e572772b3045b2c0ffdd4515e69cf3afb4e60956cc036cd1375cf4ba6c42ed03b70bd4c6f2ce4326b21bbe23dbc546e87472d44baad9bbe54b68310b
+  data.tar.gz: 0102a86810a38372d0d28b2fcc22c377da73349ec18f2e7545bb3d86abab2ca10dd8d484ef635cfbbd597dc8f5d57a8efd4cf3b62b25faa722747c39776a5e84

data/.erb-lint.yml

@@ -0,0 +1,27 @@
+---
+EnableDefaultLinters: true
+exclude:
+  - "node_modules/**/*"
+  - "vendor/**/*"
+linters:
+  ErbSafety:
+    enabled: true
+  Rubocop:
+    enabled: true
+    rubocop_config:
+      inherit_from:
+        - .rubocop.yml
+      Layout/InitialIndentation:
+        Enabled: false
+      Layout/LineLength:
+        Enabled: false
+      Layout/TrailingEmptyLines:
+        Enabled: false
+      Lint/UselessAssignment:
+        Enabled: false
+      Naming/FileName:
+        Enabled: false
+      Rails/OutputSafety:
+        Enabled: false
+      Style/FrozenStringLiteralComment:
+        Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [1.1.0] - 2023-05-19
+
+- Add erb_lint rake task and config (optional dependency)
+- Add prettier rake task and config (assumes yarn)
+
+## [1.0.5] - 2023-03-16
+
+- Add extra prefixes for spec contexts
+- Allow repeated examples in policy specs
+
 ## [1.0.2] - 2022-09-02
 
 - ignore multiple expectations in features and system specs
@@ -22,4 +32,3 @@
 - Initial release
 - Disable new cops by default
 - Enforce styles within the project
-

data/README.md

@@ -9,7 +9,8 @@ Cops are broken down by department; a file corresponding to each department can
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'rubocop-katalyst', require: false
+gem "rubocop-katalyst", require: false
+gem "erb_lint", require: false # optional dependency
 ```
 
 And then execute:
@@ -29,6 +30,22 @@ require:
   - rubocop-katalyst
 ```
 
+You can integrate this gem with Rake by adding the following to your `Rakefile`:
+
+```ruby
+require "rubocop/katalyst/rake_task"
+RuboCop::Katalyst::RakeTask.new
+
+require "rubocop/katalyst/erb_lint_task"
+RuboCop::Katalyst::ErbLintTask.new
+
+require "rubocop/katalyst/prettier_task"
+RuboCop::Katalyst::PrettierTask.new
+
+desc "Run lint before running RSpec"
+task spec: :lint
+```
+
 That's it. You're all set to use Katalyst's base code styles. Override what you need in your `.rubocop.yml` file as the project demands.
 
 The gem is designed for use with Rails, so if you're using this in a non-Rails environment, you can disable the Rails cops in your configuration file with:

data/config/rubocop-rspec.yml

@@ -1,6 +1,17 @@
 # RuboCop RSpec extension configuration overrides
 # https://github.com/rubocop/rubocop-rspec
 
+RSpec/ContextWording:
+  Description: >-
+    Checks that context docstring starts with an allowed prefix.
+  Prefixes:
+    - after
+    - as
+    - "on"
+    - when
+    - with
+    - without
+
 RSpec/ExampleLength:
   Exclude:
     - spec/features/**/*
@@ -10,3 +21,7 @@ RSpec/MultipleExpectations:
   Exclude:
     - spec/features/**/*
     - spec/system/**/*
+
+RSpec/RepeatedExample:
+  Exclude:
+    - spec/policies/**/*

data/lib/rubocop/katalyst/erb_lint_task.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "rake"
+require "rake/tasklib"
+
+module RuboCop
+  module Katalyst
+    # Provides a custom rake task.
+    #
+    # require 'rubocop/katalyst/erb_lint_task'
+    # RuboCop::Katalyst::ErbLintTask.new
+    class ErbLintTask < ::Rake::TaskLib
+      attr_accessor :verbose
+
+      def initialize(verbose: true)
+        super()
+
+        @verbose = verbose
+
+        desc "Run ErbLint" unless ::Rake.application.last_description
+        task(erb_lint: "erb_lint:lint")
+
+        setup_subtasks
+
+        task(lint: :erb_lint)
+        task(autocorrect: "erb_lint:autocorrect")
+      end
+
+      private
+
+      def run_cli(verbose, *options)
+        require "erb_lint/cli"
+
+        cli = ERBLint::CLI.new
+        puts "Running ERBLint" if verbose
+        result = cli.run(["--config", config.to_path, *options])
+        abort("ERBLint failed!") unless result
+      end
+
+      def setup_subtasks
+        namespace :erb_lint do
+          desc "Run erb_lint linter"
+          task :lint do
+            run_cli(verbose, "--lint-all")
+          end
+
+          desc "Run erb_lint autocorrect"
+          task :autocorrect do
+            run_cli(verbose, "--lint-all", "-a")
+          end
+        end
+      end
+
+      def config
+        config = Pathname.new(".erb-lint.yml")
+        config = default_config unless config.exist?
+        config
+      end
+
+      def default_config
+        Pathname.new(__dir__).join("../../.erb-lint.yml")
+      end
+    end
+  end
+end

data/lib/rubocop/katalyst/prettier_task.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "rake"
+require "rake/tasklib"
+
+module RuboCop
+  module Katalyst
+    # Provides a custom rake task.
+    #
+    # require 'rubocop/katalyst/prettier_task'
+    # RuboCop::Katalyst::PrettierTask.new
+    class PrettierTask < ::Rake::TaskLib
+      attr_accessor :verbose
+
+      def initialize(verbose: true)
+        super()
+
+        @verbose = verbose
+
+        desc "Run Prettier" unless ::Rake.application.last_description
+        task(prettier: "prettier:lint")
+
+        task(lint: :prettier)
+        task(autocorrect: "prettier:autocorrect")
+
+        setup_subtasks
+      end
+
+      private
+
+      def yarn(*options)
+        sh("yarn", *options)
+      end
+
+      def installed?
+        config.exist?
+      end
+
+      def config
+        ::Rails.application.root.join(".prettierrc.json")
+      end
+
+      def install_prettier
+        yarn("add", "--dev", "prettier")
+        config.open("w") do |f|
+          f.write <<~JSON
+            {}
+          JSON
+        end
+        yarn("install")
+      end
+
+      def setup_subtasks
+        namespace :prettier do
+          desc "Install npm packages with yarn"
+          task install: :environment do
+            install_prettier unless installed?
+          end
+
+          desc "Lint JS/SCSS files using prettier"
+          task lint: :install do
+            yarn("run", "prettier", "--check", *paths)
+          end
+
+          desc "Autocorrect JS/SCSS files using prettier"
+          task autocorrect: :install do
+            yarn("run", "prettier", "--write", *paths)
+          end
+        end
+      end
+
+      def paths
+        %w[
+          app/assets/javascripts
+          app/assets/stylesheets
+        ]
+      end
+    end
+  end
+end

data/lib/rubocop/katalyst/rake_task.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "rubocop/rake_task"
+
+module RuboCop
+  module Katalyst
+    # Provides a custom rake task.
+    #
+    # require "rubocop/katalyst/rake_task"
+    # RuboCop::Katalyst::RakeTask.new
+    class RakeTask < ::RuboCop::RakeTask
+      attr_accessor :verbose
+
+      def initialize(name = :rubocop, *args, &task_block)
+        super
+
+        task(lint: :rubocop)
+        task(autocorrect: "rubocop:autocorrect")
+      end
+    end
+  end
+end

data/lib/rubocop/katalyst/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Katalyst
-    VERSION = "1.0.4"
+    VERSION = "1.1.0"
   end
 end

data/lib/tasks/erb_lint.rake

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+begin
+  require "erb_lint"
+rescue LoadError
+  return
+end
+
+def erb_lint_config
+  local = Rails.application.root.join(".erb-lint.yml")
+  if local.exist?
+    local.to_path
+  else
+    Pathname.new(__dir__).join("../../.erb-lint.yml").to_path
+  end
+end
+
+namespace :erb_lint do
+  desc "Require erb_lint"
+  task :require do
+    require "erb_lint/cli"
+  rescue LoadError
+    nil
+  end
+
+  desc "Run erb_lint linter"
+  task lint: :require do
+    ERBLint::CLI.new.run(["--config", erb_lint_config, "--lint-all"])
+  end
+
+  desc "Run erb_lint autocorrect"
+  task autocorrect: :require do
+    ERBLint::CLI.new.run(["--config", erb_lint_config, "--lint-all", "-a"])
+  end
+end
+
+desc "Run erb_lint linter"
+task erb_lint: "erb_lint:lint"

data/package.json

@@ -0,0 +1,10 @@
+{
+  "private": true,
+  "scripts": {
+    "lint": "prettier --check *.json app/assets/javascripts app/assets/stylesheets",
+    "autocorrect": "prettier --write *.json app/assets/javascripts app/assets/stylesheets"
+  },
+  "devDependencies": {
+    "prettier": "2.7.1"
+  }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-katalyst
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Katalyst Interactive
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-27 00:00:00.000000000 Z
+date: 2023-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -87,6 +87,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".erb-lint.yml"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
@@ -106,8 +107,13 @@ files:
 - lib/rubocop-katalyst.rb
 - lib/rubocop/cop/katalyst_cops.rb
 - lib/rubocop/katalyst.rb
+- lib/rubocop/katalyst/erb_lint_task.rb
 - lib/rubocop/katalyst/inject.rb
+- lib/rubocop/katalyst/prettier_task.rb
+- lib/rubocop/katalyst/rake_task.rb
 - lib/rubocop/katalyst/version.rb
+- lib/tasks/erb_lint.rake
+- package.json
 homepage: https://github.com/katalyst/rubocop-katalyst
 licenses:
 - MIT
@@ -132,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
 summary: Code standards for Katalyst