immosquare-cleaner 1.0.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7165a24bce4d5074d6c51081764a2689116e996bafa14ed85ddc1fc43ea50e29
-  data.tar.gz: a8b504859e4cfe9f9f1ecf552a058fad07a773b54639630601feee28c5038aeb
+  metadata.gz: c24a5c00bdd269b3943555309f236e4a854d0b6bef7f21956dd3f16d4a28e6b2
+  data.tar.gz: 692f7f8c8f1bed757e9b60e9d5f9e0a999258d730c77e3103f4d44a5e43ce253
 SHA512:
-  metadata.gz: b6dbd75516dc30b9cecc8c6400597ec6b75c99a70882c9d2bc18523b7dada2d670ecd20287c4de7cdd6e0ad2a2949c64254f6a37b2856ca2cfa434427008809b
-  data.tar.gz: 69c695dc0204e4ef7a7ebfeaec6d1fcad0f5ba8adb8622d33dfc983a31b1453c8c668d149f31dfc344a17083a12c052bffa608c8d4dbd39b3545a6fc3d631f81
+  metadata.gz: ef79d787125d74355d3302375d313a2503e5c2ba6c2db67d46889dc9e7cb5d40a2fb0c242d8e1fa8a3240182d6b18c39ff4c68ccc24a0904f14e5fc46fc816c4
+  data.tar.gz: 73c13585ea4f87adb46b7a2712ac861e9c596b4f501e9027a7d8bd19be4f378fff498c17ff9c86e96fcd5332ada215cfa9b2fb1c01de81bce2a78b6c7b9fc382

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,35 @@ 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 files come from the agent's JSON payload
+## (one file, or several for a Codex patch). Linters write their
+## reports on stdout, which some agents (Gemini CLI, Codex) parse
+## as the hook's JSON answer: everything goes to stderr instead.
+## No supported file ends the hook silently with exit 0, so the
+## agent is never blocked.
+##============================================================##
+if options[:hook]
+  hook_files = ImmosquareCleaner::Hook.file_paths($stdin.read)
+  exit(0) if hook_files.empty?
+  $stdout.reopen($stderr)
+  file_path = hook_files.first
+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)
@@ -78,7 +97,9 @@ end
 ## We can now call the clean method, passing the file absolute path and options
 ##============================================================##
 file_path = File.expand_path(file_path)
-if File.directory?(file_path)
+if options[:hook]
+  hook_files.each {|path| ImmosquareCleaner.clean(path) }
+elsif File.directory?(file_path)
   ##============================================================##
   ## Run from the cleaned directory: the project's
   ## config/initializers/immosquare-cleaner.rb (exclude_files) is

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,60 @@
+require "json"
+
+module ImmosquareCleaner
+  ##============================================================##
+  ## `immosquare-cleaner --hook` : the files to clean come from the
+  ## JSON an AI agent pipes on stdin after an edit, not from ARGV.
+  ##
+  ## Each agent describes the edit 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
+  ## - Codex (apply_patch)     : tool_input.command holds the patch,
+  ##                             one `*** Update File: <path>` (or
+  ##                             Add File / Move to) line per file
+  ## Relative paths are resolved against tool_input.workdir (Codex),
+  ## then the payload's `cwd`.
+  ##
+  ## A hook must never block the agent: anything that is not a
+  ## supported file (deleted file, directory, symlink, LICENSE,
+  ## .env...) is dropped instead of reported. A symlink is never
+  ## followed, so an edit cannot reformat a file outside the project.
+  ##============================================================##
+  module Hook
+    PAYLOAD_KEYS = ["tool_input", "toolInput"].freeze
+    PATH_KEYS    = ["file_path", "path", "target_file"].freeze
+    PATCH_LINE   = /^\*\*\* (?:Add File|Update File|Move to): (.+)$/
+
+    def self.file_paths(raw_payload)
+      payload = JSON.parse(raw_payload.to_s)
+      return [] if !payload.is_a?(Hash)
+
+      sources  = PAYLOAD_KEYS.map {|key| payload[key] }.grep(Hash)
+      cwd      = payload["cwd"].is_a?(String) && !payload["cwd"].empty? ? payload["cwd"] : Dir.pwd
+      workdir  = sources.map {|source| source["workdir"] }.find {|value| value.is_a?(String) && !value.empty? }
+      base_dir = workdir ? File.expand_path(workdir, cwd) : cwd
+
+      paths = patch_paths(sources)
+      paths = [direct_path(sources + [payload])].compact if paths.empty?
+      paths.map {|path| File.expand_path(path, base_dir) }.uniq.select {|path| File.file?(path) && !File.symlink?(path) && ImmosquareCleaner.supported?(path) }
+    rescue JSON::ParserError
+      []
+    end
+
+    def self.direct_path(sources)
+      sources.lazy.flat_map {|source| PATH_KEYS.map {|key| source[key] } }.find {|value| value.is_a?(String) && !value.empty? }
+    end
+
+    ##============================================================##
+    ## Codex sends the patch as a string, older versions as an argv
+    ## array (`["apply_patch", "*** Begin Patch..."]`)
+    ##============================================================##
+    def self.patch_paths(sources)
+      patch = sources.map {|source| source["command"] }.find {|value| value.is_a?(String) || value.is_a?(Array) }
+      Array(patch).grep(String).join("\n").scan(PATCH_LINE).flatten.map(&:strip)
+    end
+
+    private_class_method(:direct_path, :patch_paths)
+  end
+end

data/lib/immosquare-cleaner/markdown.rb

@@ -144,6 +144,33 @@ module ImmosquareCleaner
         nil
       end
 
+      ##============================================================##
+      ## Splits a table row on its delimiting pipes. A pipe escaped as
+      ## `\|` is cell content (GFM), not a delimiter: splitting on it
+      ## would add a column to the whole table. A trailing empty field
+      ## only exists when the row ends with a delimiting pipe, which
+      ## closes the row rather than opening an extra cell.
+      ##============================================================##
+      def table_cells(line)
+        cells   = [+""]
+        escaped = false
+        line.strip.delete_prefix("|").each_char do |char|
+          if escaped
+            cells.last << char
+            escaped = false
+          elsif char == "\\"
+            cells.last << char
+            escaped = true
+          elsif char == "|"
+            cells << +""
+          else
+            cells.last << char
+          end
+        end
+        cells.pop if cells.size > 1 && cells.last.empty?
+        cells.map(&:strip)
+      end
+
       ##============================================================##
       ## we want to clean the markdown files to have a uniform style
       ## for the tables.
@@ -161,9 +188,9 @@ module ImmosquareCleaner
           ## above a column of row labels, a value that does not apply).
           ## Rejecting empty cells would shift every following cell one
           ## column to the left and silently file values under the wrong
-          ## header. `split("|", -1)` keeps trailing empty fields.
+          ## header.
           ##============================================================##
-          cells = line.strip.delete_prefix("|").delete_suffix("|").split("|", -1).map(&:strip)
+          cells = table_cells(line)
 
           ##============================================================##
           ## We increase the size of the array if needed

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.2".freeze
+  VERSION = "1.2.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/eslint.config.mjs

@@ -134,6 +134,20 @@ export default [
       "no-undef": 0
     }
   },
+  //============================================================//
+  // JSX files: ESLint only lints .js/.mjs/.cjs by default, so a
+  // .jsx file matched by no `files` pattern is skipped with
+  // "File ignored because no matching configuration was supplied".
+  // The common rules above carry no `files` key and apply here too.
+  //============================================================//
+  {
+    files:           ["**/*.jsx"],
+    languageOptions: {
+      parserOptions: {
+        ecmaFeatures: { jsx: true }
+      }
+    }
+  },
   erb.configs.recommended,
   {
     linterOptions: {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: immosquare-cleaner
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.2.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: []