immosquare-cleaner 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7665690ab0d77f314f9feaa5a957d405e6180b886bc6ec0f8489984e4bb32b96
-  data.tar.gz: f8879a8bdbf932fd97f984ecac4a22b36e7ba223b6db7ef1f0f213375c34d785
+  metadata.gz: 684fefa6f6061c2cfd2a30c10852463e2a8a0605dc8d4078fe9cb8f136bd3f97
+  data.tar.gz: 9437ae1b6de815f2b97d5dd10f61fb3ad412e6989969f73a10b481b9560efd8b
 SHA512:
-  metadata.gz: 952cac84543b75a8bf42cd2adf738bd702e2d0c424b069103aedc9145b522f10ad8aa5883e03b9532b6232ff605213f3e4c1bc781420fc35b5b21da693723cb0
-  data.tar.gz: 761039c215cf757e82f24b02e302dac4195f22a2233d336e94940d71ca2345eaea72c305bd3a8ace4658441f7bf3e9615bef7da2a1614c8050661b3ea989607a
+  metadata.gz: d0962e5e3df0bf9493abeed5871e85fa8146787aec41b09ec37a322ccd88fd7d2454d1d08bb97aa03cf153f1e6ff75809b6d7f286fab0bf1f3ad5e4095f15291
+  data.tar.gz: 53315a827d4a2030c1ce6e05bd70c24ded051f9259056fd695261c99e3c3d4e969c89543fb46498e5dfd39ff3a8ec076300352c41860491e020255f8b9edd83f

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 immosquare
+
+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/bin/immosquare-cleaner

@@ -31,16 +31,33 @@ OptionParser.new do |parser|
   parser.on("-p", "--prevent-concurrent-write", "Prevent concurrent write") do
     options[:prevent_concurrent_write] = true
   end
+  parser.on("--hook", "Read the edited file from an AI agent hook payload on stdin") do
+    options[:hook] = true
+  end
   parser.on("-h", "--help", "Prints this help") do
     puts(parser)
     exit
   end
 end.parse!
 
+##============================================================##
+## Hook mode : the edited file comes from the agent's JSON payload.
+## Linters write their reports on stdout, which some agents
+## (Gemini CLI) parse as the hook's JSON answer: everything goes
+## to stderr instead. An unsupported or missing file ends the
+## hook silently with exit 0, so the agent is never blocked.
+##============================================================##
+if options[:hook]
+  file_path = ImmosquareCleaner::Hook.file_path($stdin.read)
+  exit(0) if file_path.nil?
+  $stdout.reopen($stderr)
+else
+  file_path = ARGV[0]
+end
+
 ##============================================================##
 ## Check if the file path is provided
 ##============================================================##
-file_path = ARGV[0]
 if !file_path
   puts("Error: Please provide a file or directory path.")
   exit(1)

data/lib/immosquare-cleaner/directory_cleaner.rb

@@ -37,6 +37,7 @@ module ImmosquareCleaner
       "log",
       "node_modules",
       "target",
+      "testdata",
       "tmp",
       "vendor"
     ].freeze

data/lib/immosquare-cleaner/hook.rb

@@ -0,0 +1,37 @@
+require "json"
+
+module ImmosquareCleaner
+  ##============================================================##
+  ## `immosquare-cleaner --hook` : the file to clean comes from the
+  ## JSON an AI agent pipes on stdin after an edit, not from ARGV.
+  ##
+  ## Each agent nests the edited path differently:
+  ## - Claude Code, Gemini CLI : tool_input.file_path
+  ## - Kimi Code               : tool_input.path
+  ## - Grok                    : toolInput.file_path
+  ## - Cursor (afterFileEdit)  : file_path at the top level
+  ## A relative path is resolved against the payload's `cwd`.
+  ##
+  ## A hook must never block the agent: anything that is not a
+  ## supported file (no path, deleted file, directory, LICENSE,
+  ## .env...) is skipped instead of reported.
+  ##============================================================##
+  module Hook
+    PAYLOAD_KEYS = ["tool_input", "toolInput"].freeze
+    PATH_KEYS    = ["file_path", "path", "target_file"].freeze
+
+    def self.file_path(raw_payload)
+      payload = JSON.parse(raw_payload.to_s)
+      return if !payload.is_a?(Hash)
+
+      sources = PAYLOAD_KEYS.map {|key| payload[key] }.grep(Hash) + [payload]
+      path    = sources.lazy.flat_map {|source| PATH_KEYS.map {|key| source[key] } }.find {|value| value.is_a?(String) && !value.empty? }
+      return if path.nil?
+
+      path = File.expand_path(path, payload["cwd"].is_a?(String) ? payload["cwd"] : Dir.pwd)
+      path if File.file?(path) && ImmosquareCleaner.supported?(path)
+    rescue JSON::ParserError
+      nil
+    end
+  end
+end

data/lib/immosquare-cleaner/processors/go.rb

@@ -0,0 +1,31 @@
+require "shellwords"
+
+module ImmosquareCleaner
+  module Processors
+    class Go < Base
+
+      def self.match?(file_path)
+        file_path.end_with?(".go")
+      end
+
+      def run
+        if !system("which gofmt > /dev/null 2>&1")
+          warn("ERROR: gofmt is not installed. Please install Go with: brew install go")
+          return
+        end
+
+        ##============================================================##
+        ## gofmt flags:
+        ## -s : apply gofmt's simplifications (redundant composite
+        ##      literal types, `s[a:len(s)]` → `s[a:]`...)
+        ## -w : write the result back to the file in place
+        ## Indentation stays in tabs: gofmt has no option for it, and
+        ## converting to spaces would make every Go tool (gopls,
+        ## `gofmt -l` in CI) flag the file as unformatted.
+        ##============================================================##
+        launch_cmds(["gofmt -s -w #{Shellwords.escape(file_path)}"])
+      end
+
+    end
+  end
+end

data/lib/immosquare-cleaner/version.rb

@@ -1,3 +1,3 @@
 module ImmosquareCleaner
-  VERSION = "1.0.1".freeze
+  VERSION = "1.1.0".freeze
 end

data/lib/immosquare-cleaner.rb

@@ -7,6 +7,7 @@ require "fileutils"
 require_relative "immosquare-cleaner/configuration"
 require_relative "immosquare-cleaner/markdown"
 require_relative "immosquare-cleaner/directory_cleaner"
+require_relative "immosquare-cleaner/hook"
 
 ##============================================================##
 ## Processors
@@ -19,6 +20,7 @@ require_relative "immosquare-cleaner/processors/json"
 require_relative "immosquare-cleaner/processors/markdown"
 require_relative "immosquare-cleaner/processors/shell"
 require_relative "immosquare-cleaner/processors/rust"
+require_relative "immosquare-cleaner/processors/go"
 require_relative "immosquare-cleaner/processors/toml"
 require_relative "immosquare-cleaner/processors/yaml"
 require_relative "immosquare-cleaner/processors/prettier"
@@ -123,6 +125,7 @@ module ImmosquareCleaner
       Processors::Markdown,
       Processors::Shell,
       Processors::Rust,
+      Processors::Go,
       Processors::Toml
     ].freeze
 

data/linters/erb_lint/custom_single_line_if_modifier.rb

@@ -74,7 +74,7 @@ module ERBLint
           context = {
             :new_code       => "<%= #{new_code} %>",
             :output_node    => output_node,
-            :is_output_node => is_output_erb?(output_node)
+            :is_output_node => output_erb?(output_node)
           }
 
           add_offense(full_range, MSG, context)
@@ -102,9 +102,9 @@ module ERBLint
         ## output_node should be <%= (output)
         ## end_node should be <% (not <%=)
         ##============================================================##
-        return false unless is_statement_erb?(if_node)
-        return false unless is_output_erb?(output_node)
-        return false unless is_statement_erb?(end_node)
+        return false unless statement_erb?(if_node)
+        return false unless output_erb?(output_node)
+        return false unless statement_erb?(end_node)
 
         ##============================================================##
         ## Extract and validate the code
@@ -133,7 +133,7 @@ module ERBLint
       ##============================================================##
       ## Check if ERB node is a statement (<% ... %>)
       ##============================================================##
-      def is_statement_erb?(erb_node)
+      def statement_erb?(erb_node)
         indicator = erb_node.children.first
         indicator.nil? || (indicator.respond_to?(:children) && indicator.children.first.nil?)
       end
@@ -141,7 +141,7 @@ module ERBLint
       ##============================================================##
       ## Check if ERB node is an output (<%= ... %>)
       ##============================================================##
-      def is_output_erb?(erb_node)
+      def output_erb?(erb_node)
         indicator = erb_node.children.first
         indicator.respond_to?(:children) && indicator.children.first == "="
       end

data/linters/rubocop/cop/custom_cops/style/comment_normalization.rb

@@ -104,16 +104,13 @@ module RuboCop
                 in_code = !in_code
                 body << text
                 content_seen = true
-              elsif in_code || text.match?(RAW_LINE)
+              elsif verbatim_line?(text, in_code)
                 body << text
                 content_seen = true
               elsif text == BLANK_LINE
                 body << BLANK_LINE if content_seen
               elsif text.match?(USER_SEPARATOR)
                 body << INSIDE_SEPARATOR if content_seen
-              elsif text.match?(STRUCTURED_LINE) || text.match?(INDENTED_LINE)
-                body << text
-                content_seen = true
               else
                 body << cleaned_line(text)
                 content_seen = true
@@ -123,6 +120,20 @@ module RuboCop
             body
           end
 
+          ##============================================================##
+          ## Lines kept as written. Precedence matters: inside a code
+          ## block or on a raw line everything is verbatim, even "##" or
+          ## a separator; elsewhere a blank line and a user separator win
+          ## over the structured/indented patterns ("##   ---" is a
+          ## separator, not an indented line).
+          ##============================================================##
+          def verbatim_line?(text, in_code)
+            return true if in_code || text.match?(RAW_LINE)
+            return false if text == BLANK_LINE || text.match?(USER_SEPARATOR)
+
+            text.match?(STRUCTURED_LINE) || text.match?(INDENTED_LINE)
+          end
+
           ##============================================================##
           ## Cleans up a standard text line:
           ## - "### foo"  → "## foo"  (collapse repeated #)

data/linters/rubocop-4.0.7.yml

@@ -32,6 +32,14 @@ Naming/FileName:
   Enabled: false
 Naming/MethodParameterName:
   MinNameLength: 1
+Naming/PredicateMethod:
+  AllowedMethods:
+  - call
+  - move_to_cache
+  - move_to_store
+  - save
+  - check_health
+  - elastic_import_with_progressbar
 Layout/LeadingEmptyLines:
   Enabled: false
 Layout/InitialIndentation:
@@ -88,6 +96,11 @@ Style/NegatedIf:
   Enabled: false
 Style/FormatStringToken:
   EnforcedStyle: template
+  Mode: conservative
+Style/OptionalBooleanParameter:
+  AllowedMethods:
+  - respond_to_missing?
+  - perform
 Style/NumericPredicate:
   EnforcedStyle: comparison
 Style/StringLiterals:

data/linters/rubocop.yml

@@ -37,6 +37,14 @@ Naming/FileName:
   Enabled: false # Allow filenames with dashes (e.g. immosquare-cleaner.rb)
 Naming/MethodParameterName:
   MinNameLength: 1 # Allow single-character parameter names
+Naming/PredicateMethod:
+  AllowedMethods:
+    - call
+    - move_to_cache # CarrierWave hooks: the gem calls them by these names and reads their boolean return.
+    - move_to_store
+    - save # ActiveModel contract: form objects expose `save` returning true/false, like ActiveRecord.
+    - check_health # Commands returning their success status (immosquare-railtie PumaManager, Elasticsearch import): a `?` name would hide the side effects.
+    - elastic_import_with_progressbar
 
 #################### Layout ###########################
 Layout/LeadingEmptyLines:
@@ -98,6 +106,11 @@ Style/NegatedIf:
   Enabled: false # Allow rewriting `if !` as `unless`
 Style/FormatStringToken:
   EnforcedStyle: "template" ## Use %{my_string} interpolation, not %<my_string>s
+  Mode: conservative # Only strings passed to format/sprintf/%. In aggressive mode any literal containing `%<x>s` is flagged, including prose that lists placeholders (e.g. an AI prompt telling the model which tokens to preserve), where rewriting the token changes the text.
+Style/OptionalBooleanParameter:
+  AllowedMethods:
+    - respond_to_missing?
+    - perform # Sidekiq and ActiveJob serialize `perform` arguments as JSON: keyword arguments are not reliably supported, and jobs already enqueued keep their positional shape.
 Style/NumericPredicate:
   EnforcedStyle: comparison # No `.zero?` `.negative?` `.positive?`
 Style/StringLiterals:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: immosquare-cleaner
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - immosquare
@@ -149,9 +149,11 @@ dependencies:
     - - "<="
       - !ruby/object:Gem::Version
         version: '1000.0'
-description: Immosquare-cleaner streamlines Rails applications by running tools like
-  RuboCop, ERBLint, Stylelint and more. It ensures code quality, readability, and
-  consistency across the application.
+description: immosquare-cleaner formats Ruby, ERB, JS/TS, Rust, Go, TOML, Markdown,
+  Shell, JSON, YAML and CSS files with one consistent house style, delegating each
+  format to the right tool (RuboCop, erb_lint, ESLint, rustfmt, gofmt, taplo, shfmt,
+  Prettier). Run it on a file, a whole repository, on save, or as a Claude Code, Cursor
+  or Gemini CLI hook so every file an AI agent writes comes out formatted.
 email:
 - jules@immosquare.com
 executables:
@@ -160,13 +162,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".erb_linters"
+- LICENSE
 - bin/immosquare-cleaner
 - lib/immosquare-cleaner.rb
 - lib/immosquare-cleaner/configuration.rb
 - lib/immosquare-cleaner/directory_cleaner.rb
+- lib/immosquare-cleaner/hook.rb
 - lib/immosquare-cleaner/markdown.rb
 - lib/immosquare-cleaner/processors/base.rb
 - lib/immosquare-cleaner/processors/erb.rb
+- lib/immosquare-cleaner/processors/go.rb
 - lib/immosquare-cleaner/processors/javascript.rb
 - lib/immosquare-cleaner/processors/json.rb
 - lib/immosquare-cleaner/processors/markdown.rb
@@ -201,10 +206,13 @@ files:
 - linters/rubocop/cop/custom_cops/style/kwarg_priority_order.rb
 - linters/rubocop/cop/style/method_call_with_args_parentheses_override.rb
 - package.json
-homepage: https://github.com/immosquare/Immosquare-cleaner
+homepage: https://github.com/immosquare/immosquare-cleaner
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/immosquare/immosquare-cleaner
+  changelog_uri: https://github.com/immosquare/immosquare-cleaner/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/immosquare/immosquare-cleaner/issues
 rdoc_options: []
 require_paths:
 - lib
@@ -222,5 +230,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.22
 specification_version: 4
-summary: A gem to lint and organize files in a Rails application.
+summary: One command to format every file of a repository, built to run as an AI agent
+  hook.
 test_files: []