gemwork 0.7.8 → 0.7.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5814942677e2ae7070660fc2bf0b3d3dae6fd08744f15b8e74fb997b7e1d4382
-  data.tar.gz: 7e672645c76d464a3458dcf086182e102761df89031326ac01d36319c4e124a3
+  metadata.gz: d2e343966a1395439c2480be144d1b021e71b3b393e2c5a37a3e042fb9d9e26a
+  data.tar.gz: c4394858040c87beaf9721891e99f28b46673c40ebdd77bc5640f610bf7ad33c
 SHA512:
-  metadata.gz: 506f5bbf2f788b11ce8258c2c376695881ab19f89435df05896be4c8b8b8bdabcdc4977339d2a5c2e450c9e97a0b00f090452e6b0e63e88f602ef6fc5d7b6c77
-  data.tar.gz: d15d91a6345c8254dd4b8f8754f275f53ccdb9eee91cea5bde579885e75277ef524146059f3b52ba0357b89968a3ebc679178133f766e0b1a334cb117bb9690f
+  metadata.gz: 9b64fd4b8b8fd79164d315ec7ec04f7ca0b2211f860c92878c11d3e157e30c376110394a72ebddfce515c1393ebe7ab31741dfe2c7fdb428f3f13c960182c899
+  data.tar.gz: 767a780744a8429e0fe7682380e36dc5452205e6f2c2e1c28f9c7c9c64c2fae1f07cc58e672ab1230baa7d5062b572f807f40f20be1b610e9cb4ee247e879cef

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## [Unreleased]
 
+## [0.7.11] - 2025-2-15
+(0.7.10 yanked)
+
+- Minimize `rake brakeman` output when no warnings; return failure otherwise
+- Fail on error in Rubocop rake task
+- Add documentation to README + example config file for erb_lint
+
+## [0.7.9] - 2025-2-13
+
+- Add rake task for `erb_lint` for Rails apps
+
 ## [0.7.8] - 2025-2-12
 
 - Ignore `create` and `update` methods (controller actions) for Metrics/MethodLength cop

data/README.md

@@ -58,7 +58,7 @@ Running `rake -T` after this will reveal the additional tasks defined by Gemwork
 
 ### Rails
 
-For a Rails project, you may need to conditionally run the above by returning early unless the current environment is development. Further, you may want to include other tasks, such as `eslint`, `prettier`, `brakeman`, and `test:system`.
+For a Rails project, you may need to conditionally run the above by returning early unless the current environment is development. Further, you may want to include other gems & their rake tasks, such as: [`erb_lint`](#erb_lint), [`eslint`](#eslint), [`prettier`](#prettier), `brakeman`, and `test:system`.
 
 ```ruby
 # frozen_string_literal: true
@@ -69,8 +69,9 @@ spec = Gem::Specification.find_by_name("gemwork")
 
 # Load additional tasks defined by Gemwork.
 Dir.glob(
-  Pathname.new(spec.gem_dir).
-    join("lib", "tasks", "{util,rubocop,reek,eslint,prettier,brakeman}.rake")) do |task|
+  Pathname.new(spec.gem_dir).join(
+    "lib/tasks",
+    "{util,rubocop,erb_lint,reek,eslint,prettier,brakeman}.rake")) do |task|
   load(task)
 end
 
@@ -80,6 +81,7 @@ task :default do
   run_tasks(%i[
     test
     rubocop
+    erb_lint
     reek
     eslint
     prettier
@@ -214,11 +216,34 @@ require "gemwork/test/support/spec_dsl"
 
 For a Rails app, additional configuration may be desired to improve linter support.
 
+#### erb_lint
+
+https://github.com/Shopify/erb_lint
+
+Install with:
+
+```
+group :development do
+  gem "erb_lint", require: false
+end
+```
+
+Add [.erb_lint.yml](https://github.com/pdobb/gemwork/blob/main/lib/erb_lint/.erb_lint.yml) to the Rails project's root.
+
+Run with:
+
+```bash
+rake erb_lint
+
+# To run on manually, on a specific path:
+erb_lint --format=compact path/to/template.html.erb
+```
+
 #### eslint
 
 The below fixes eslint linting errors in Rails (7+, ...) projects.
 
-```json
+```javascript
 // .eslintrc.json
 
 {
@@ -247,7 +272,7 @@ General config recommendations for prettier:
 vendor
 ```
 
-```json
+```javascript
 // .prettierrc.json
 
 {
@@ -286,6 +311,7 @@ For Rails projects, you may want to manually install additional gems as well:
 
 - [rubocop-rails](https://github.com/rubocop/rubocop-rails) -- A RuboCop extension focused on enforcing Rails best practices and coding conventions.
 - [rubocop-capybara](https://github.com/rubocop/rubocop-capybara) -- Code style checking for Capybara files.
+- [erb_lint](https://github.com/Shopify/erb_lint) -- erb linting, including with Rubocop
 
 ## Development
 

data/lib/erb_lint/.erb_lint.yml

@@ -0,0 +1,35 @@
+EnableDefaultLinters: true
+linters:
+  DeprecatedClasses:
+    enabled: false
+  ErbSafety:
+    enabled: true
+  HardCodedString:
+    enabled: false
+  PartialInstanceVariable:
+    enabled: true
+  Rubocop:
+    enabled: true
+    rubocop_config:
+      inherit_from:
+        - .rubocop.yml
+      Layout/InitialIndentation:
+        Enabled: false
+      Layout/LeadingEmptyLines:
+        Enabled: false
+      Layout/MultilineArrayLineBreaks:
+        Enabled: false
+      Layout/TrailingEmptyLines:
+        Enabled: false
+      Layout/TrailingWhitespace:
+        Enabled: false
+      Lint/UselessAssignment:
+        Enabled: false
+      Style/FrozenStringLiteralComment:
+        Enabled: false
+  RequireScriptNonce:
+    enabled: false
+  SpaceInHtmlTag:
+    enabled: false
+  StrictLocals:
+    enabled: true

data/lib/gemwork/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gemwork
-  VERSION = "0.7.8"
+  VERSION = "0.7.11"
 end

data/lib/tasks/brakeman.rake

@@ -5,10 +5,19 @@ task(:brakeman, :output_files) do |_task, args|
   require "brakeman"
 
   files = args[:output_files].split if args[:output_files]
-  Brakeman.run(
-    app_path: ".",
-    quiet: true,
-    output_files: files,
-    print_report: true,
-    pager: false)
+  result =
+    Brakeman.run(
+      app_path: ".",
+      quiet: true,
+      output_files: files,
+      print_report: false,
+      pager: false)
+
+  if result.warnings.empty?
+    puts "\e[32m0 warnings\e[0m"
+  else
+    puts "\e[31mWarnings found\e[0m"
+    puts result.report
+    exit 1
+  end
 end

data/lib/tasks/erb_lint.rake

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+desc "Run erb_lint on **/*.html.erb"
+task :erb_lint do
+  system("bundle exec erb_lint --format=compact --lint-all") ||
+    exit($CHILD_STATUS.exitstatus)
+end

data/lib/tasks/rubocop.rake

@@ -3,5 +3,5 @@
 require "rubocop/rake_task"
 
 RuboCop::RakeTask.new do |t|
-  t.fail_on_error = false
+  t.fail_on_error = true
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: gemwork
 version: !ruby/object:Gem::Version
-  version: 0.7.8
+  version: 0.7.11
 platform: ruby
 authors:
 - Paul DobbinSchmaltz
 bindir: exe
 cert_chain: []
-date: 2025-02-12 00:00:00.000000000 Z
+date: 2025-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -202,6 +202,7 @@ files:
 - LICENSE.txt
 - README.md
 - lib/.DS_Store
+- lib/erb_lint/.erb_lint.yml
 - lib/gemwork.rb
 - lib/gemwork/.DS_Store
 - lib/gemwork/test/support/much_stub-rails.rb
@@ -230,6 +231,7 @@ files:
 - lib/rubocop/style-rails.yml
 - lib/rubocop/style.yml
 - lib/tasks/brakeman.rake
+- lib/tasks/erb_lint.rake
 - lib/tasks/eslint.rake
 - lib/tasks/prettier.rake
 - lib/tasks/reek.rake