immosquare-cleaner 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe48e81e3af7200a3967f640a3f3a34f7632a32d71323b2829841516ad5f8cb8
-  data.tar.gz: 571422d60f872ce01a3e3896260b4fee7d0e2282f16978fe7cfd18e2530a1a23
+  metadata.gz: 7665690ab0d77f314f9feaa5a957d405e6180b886bc6ec0f8489984e4bb32b96
+  data.tar.gz: f8879a8bdbf932fd97f984ecac4a22b36e7ba223b6db7ef1f0f213375c34d785
 SHA512:
-  metadata.gz: 9f9ec67de3055d93376abc0df67abcc4368e661a4f46a0bd702c9d679407407119364f3b4a68817e39b8ec8ae888ae3365eeb3e692b453317396e21abd0ab875
-  data.tar.gz: e32bd136ee29441e48f17af89cac59741e11e931b7d335da8a8ccf8be3914deb4f4c558b75a99f85c108c66f18189ad23f3bca93cd7bfa354a25679f1af3a084
+  metadata.gz: 952cac84543b75a8bf42cd2adf738bd702e2d0c424b069103aedc9145b522f10ad8aa5883e03b9532b6232ff605213f3e4c1bc781420fc35b5b21da693723cb0
+  data.tar.gz: 761039c215cf757e82f24b02e302dac4195f22a2233d336e94940d71ca2345eaea72c305bd3a8ace4658441f7bf3e9615bef7da2a1614c8050661b3ea989607a

data/lib/immosquare-cleaner/directory_cleaner.rb

@@ -66,6 +66,17 @@ module ImmosquareCleaner
 
     attr_reader :root
 
+    ##============================================================##
+    ## Everything under `generators/**/templates/` is raw template
+    ## content, usually ERB behind the target file's extension: any
+    ## formatter would mangle its tags. Shared with
+    ## ImmosquareCleaner.clean so a single-file clean skips it too
+    ##============================================================##
+    def self.generator_template?(folders)
+      generators = folders.index("generators")
+      !generators.nil? && folders.drop(generators + 1).include?("templates")
+    end
+
     def initialize(root)
       @root = File.expand_path(root)
     end
@@ -139,6 +150,7 @@ module ImmosquareCleaner
       segments = path.split("/")
       folders  = directory ? segments : segments[0..-2]
       return true if folders.intersect?(EXCLUDED_DIRS) || "#{path}/".start_with?(*EXCLUDED_PATHS.map {|excluded| "#{excluded}/" })
+      return true if self.class.generator_template?(folders)
 
       !directory && (EXCLUDED_FILES.include?(segments.last) || segments.last.end_with?(*EXCLUDED_SUFFIXES))
     end

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

@@ -3,6 +3,7 @@ require "json"
 module ImmosquareCleaner
   module Processors
     class Json < Base
+
       def self.match?(file_path)
         file_path.end_with?(".json")
       end
@@ -14,6 +15,7 @@ module ImmosquareCleaner
         File.write(file_path, formatted)
         normalize_last_line
       end
+
     end
   end
 end

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

@@ -1,6 +1,7 @@
 module ImmosquareCleaner
   module Processors
     class Markdown < Base
+
       def self.match?(file_path)
         file_path.end_with?(".md", ".md.erb")
       end
@@ -10,6 +11,7 @@ module ImmosquareCleaner
         File.write(file_path, formatted_md)
         normalize_last_line
       end
+
     end
   end
 end

data/lib/immosquare-cleaner/version.rb

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

data/lib/immosquare-cleaner.rb

@@ -70,10 +70,13 @@ module ImmosquareCleaner
       setup_linter_configs!
 
       ##============================================================##
-      ## Return if the file is in the exclusion list
+      ## Return if the file is in the exclusion list or is a generator
+      ## template. With `-p`, file_path is a /tmp copy: the template
+      ## check runs on origin_path
       ##============================================================##
       exclude_files = configuration.exclude_files.map {|file| File.join(Dir.pwd, file) }
       return if exclude_files.include?(file_path)
+      return if DirectoryCleaner.generator_template?(File.dirname(origin_path || file_path).split("/"))
 
       begin
         processor = processor_for(file_path)
@@ -96,8 +99,6 @@ module ImmosquareCleaner
       File.expand_path("..", __dir__)
     end
 
-    private
-
     ##============================================================##
     ## Processor registry — order matters.
     ##
@@ -125,6 +126,8 @@ module ImmosquareCleaner
       Processors::Toml
     ].freeze
 
+    private
+
     def processor_for(file_path)
       PROCESSORS.find {|p| p.match?(file_path) } || Processors::Prettier
     end

data/linters/erb_lint/custom_html_to_content_tag.rb

@@ -286,7 +286,9 @@ module ERBLint
       ##============================================================##
       def extract_erb_code(erb_node)
         code_node = erb_node.children.find {|c| c&.type == :code }
-        code_node&.loc&.source&.strip
+        return nil unless code_node
+
+        code_node.loc&.source&.strip
       end
 
       ##============================================================##

data/linters/eslint-plugins/align-assignments.mjs

@@ -0,0 +1,188 @@
+//============================================================//
+// Local fork of eslint-plugin-align-assignments (v1.1.2, by
+// Lucas Florio, MIT). Upstream is unmaintained since 2019.
+//
+// Differences with upstream:
+// - reads `context.sourceCode` (ESLint 10 removed
+// `context.getSourceCode()`);
+// - knows the ES2021 logical assignment operators `||=`, `&&=`
+// and `??=`. Without them the rule locates the `=` one column
+// off, reports the group forever and its autofix never settles
+// ("Circular fixes detected").
+//============================================================//
+
+//============================================================//
+// MIT License
+//
+// Copyright (c) Lucas Florio <lucasefe@gmail.com>
+//
+// 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.
+//============================================================//
+const hasRequire   = /require\(/
+const spaceMatcher = /(\s*)((?:\|\||&&|\?\?|\+|-|\*|\/|%|&|\^|\||<<|>>|\*\*|>>>)?=)/
+
+const assignmentOperators = ["=", "+=", "-=", "*=", "/=", "%=", "&=", "^=", "|=", "<<=", ">>=", "**=", ">>>=", "||=", "&&=", "??="]
+
+const getLast = (ary) => ary[ary.length - 1]
+
+const isAssignmentExpression = (node) => node.type === "AssignmentExpression"
+
+const isMultiline = (firstToken, assignmentToken) => firstToken.loc.start.line !== assignmentToken.loc.start.line
+
+const rule = {
+  meta: {
+    fixable: "code",
+    schema:  [
+      {
+        type:                 "object",
+        properties:           { requiresOnly: { type: "boolean" } },
+        additionalProperties: false
+      }
+    ]
+  },
+
+  create: (context) => {
+    const { options }    = context
+    const requiresOnly   = options && options.length > 0 && options[0].requiresOnly
+    const { sourceCode } = context
+    const groups         = []
+    let previousNode
+
+    const shouldStartNewGroup = (node) => {
+      //============================================================//
+      // First line of all
+      //============================================================//
+      if (!previousNode) return true
+
+      //============================================================//
+      // Switching parent nodes
+      //============================================================//
+      if (node.parent !== previousNode.parent) return true
+
+      //============================================================//
+      // If previous node was a for and included the declarations,
+      // new group
+      //============================================================//
+      if (previousNode.parent.type === "ForStatement" && previousNode.declarations) return true
+
+      //============================================================//
+      // Previous line was blank
+      //============================================================//
+      const lineOfNode = sourceCode.getFirstToken(node).loc.start.line
+      const lineOfPrev = sourceCode.getLastToken(previousNode).loc.start.line
+      return lineOfNode - lineOfPrev !== 1
+    }
+
+    const addNode = (groupNode, node) => {
+      if (shouldStartNewGroup(groupNode)) groups.push([node])
+      else getLast(groups).push(node)
+
+      previousNode = groupNode
+    }
+
+    const getPrefix = (node) => {
+      const nodeBefore = isAssignmentExpression(node) ? node.left : node.declarations.find((dcl) => dcl.type === "VariableDeclarator").id
+      return nodeBefore.loc.end.column - nodeBefore.loc.start.column
+    }
+
+    const findAssigment = (node) => {
+      const prefix = getPrefix(node)
+      const source = sourceCode.getText(node)
+      const match  = source.slice(prefix).match(spaceMatcher)
+      return match ? match.index + prefix + match[2].length : null
+    }
+
+    const assignmentOnFirstLine = (node) => {
+      if (isAssignmentExpression(node)) return node.left.loc.start.line === node.right.loc.start.line
+
+      const source = sourceCode.getText(node)
+      const lines  = source.split("\n")
+      return lines[0].includes("=")
+    }
+
+    const areAligned = (maxPos, nodes) => nodes
+      .filter(assignmentOnFirstLine)
+      .map((node) => sourceCode.getText(node))
+      .every((source) => source.charAt(maxPos) === "=")
+
+    const getMaxPos = (nodes) => nodes
+      .filter(assignmentOnFirstLine)
+      .map(findAssigment)
+      .reduce((last, current) => Math.max(last, current), [])
+
+    const check = (group) => {
+      const maxPos = getMaxPos(group)
+
+      if (areAligned(maxPos, group)) return
+
+      context.report({
+        loc: {
+          start: group[0].loc.start,
+          end:   getLast(group).loc.end
+        },
+        message: "This group of assignments is not aligned",
+        fix:     (fixer) => group.map((node) => {
+          const tokens          = sourceCode.getTokens(node)
+          const firstToken      = tokens[0]
+          const assignmentToken = tokens.find((token) => assignmentOperators.includes(token.value))
+          const line            = sourceCode.getText(node)
+          const lineIsAligned   = line.charAt(maxPos) === "="
+
+          if (lineIsAligned || !assignmentToken || isMultiline(firstToken, assignmentToken)) return fixer.replaceText(node, line)
+
+          //============================================================//
+          // Source line may include spaces, we need to accomodate
+          // for that.
+          //============================================================//
+          const spacePrefix    = firstToken.loc.start.column
+          const startDelimiter = assignmentToken.loc.start.column - spacePrefix
+          const endDelimiter   = assignmentToken.loc.end.column - spacePrefix
+          const start          = line.slice(0, startDelimiter).replace(/\s+$/m, "")
+          const ending         = line.slice(endDelimiter).replace(/^\s+/m, "")
+          const spacesRequired = maxPos - start.length - assignmentToken.value.length + 1
+          const spaces         = " ".repeat(spacesRequired)
+          return fixer.replaceText(node, `${start}${spaces}${assignmentToken.value} ${ending}`)
+        })
+      })
+    }
+
+    return {
+      VariableDeclaration: (node) => {
+        const source = sourceCode.getText(node)
+        if (requiresOnly && !hasRequire.test(source)) return
+
+        addNode(node, node)
+      },
+
+      ExpressionStatement: (node) => {
+        if (node.expression.type !== "AssignmentExpression") return
+
+        addNode(node, node.expression)
+      },
+
+      "Program:exit": () => groups.forEach(check)
+    }
+  }
+}
+
+export default rule

data/linters/eslint-plugins/eslint10-compat.mjs

@@ -1,27 +1,26 @@
 //============================================================//
 // ESLint 10 compatibility shim for unmaintained plugins.
 //
-// Context: we rely on two npm plugins to enforce our JS style
-// (see rules/javascript.md — alignment of assignments and
-// imports is mandatory):
-// - eslint-plugin-align-assignments (last release: 2019)
-// - eslint-plugin-align-import      (last release: 2020)
+// Context: alignment of imports is mandatory in our JS style
+// (see rules/javascript.md) and relies on
+// eslint-plugin-align-import (last release: 2020). Assignment
+// alignment uses the local fork in ./align-assignments.mjs.
 //
-// Both plugins call `context.getSourceCode()` inside their
-// rule `create()`. ESLint 10 removed that method: the source
-// code is now exposed as the `context.sourceCode` property.
-// Loading either plugin as-is throws:
+// The plugin calls `context.getSourceCode()` inside its rules'
+// `create()`. ESLint 10 removed that method: the source code
+// is now exposed as the `context.sourceCode` property.
+// Loading it as-is throws:
 // TypeError: context.getSourceCode is not a function
 //
-// Since neither plugin is maintained and no drop-in
-// replacement exists (Prettier/Biome don't align `=`), we wrap
-// each rule with a Proxy that re-injects `getSourceCode()` on
-// the context before delegating to the original `create()`.
-// The upstream packages stay untouched — when a maintained
+// Since it is not maintained and no drop-in replacement
+// exists, we wrap each rule with a Proxy that re-injects
+// `getSourceCode()` on the context before delegating to the
+// original `create()`.
+// The upstream package stays untouched — when a maintained
 // alternative surfaces, delete this file and import directly.
 //============================================================//
-import alignAssignmentsPlugin from "eslint-plugin-align-assignments"
-import alignImportPlugin      from "eslint-plugin-align-import"
+import alignAssignmentsRule from "./align-assignments.mjs"
+import alignImportPlugin    from "eslint-plugin-align-import"
 
 
 const withLegacyContext = (rule) => ({
@@ -35,7 +34,7 @@ const withLegacyContext = (rule) => ({
 
 export const alignAssignments = {
   rules: {
-    "align-assignments": withLegacyContext(alignAssignmentsPlugin.rules["align-assignments"])
+    "align-assignments": alignAssignmentsRule
   }
 }
 

data/linters/normalize-comments.mjs

@@ -1,5 +1,5 @@
 import { readFileSync, writeFileSync } from "fs"
-import * as babelParser from "@babel/parser"
+import * as babelParser                from "@babel/parser"
 
 //============================================================//
 // Constants
@@ -36,7 +36,7 @@ const normalizeComments = (filePath) => {
   // Process blocks in reverse order to avoid line number shifts
   //============================================================//
   const blocksReversed = [...commentBlocks].reverse()
-  let hasChanges = false
+  let hasChanges       = false
 
   blocksReversed.forEach((block) => {
     const normalized = normalizeCommentBlock(block, lines)
@@ -111,7 +111,7 @@ const groupConsecutiveComments = (comments, originalLines) => {
     // Check if this is a standalone comment (line starts with //)
     // Skip end-of-line comments (e.g., const x = 1 // comment)
     //============================================================//
-    const lineContent = originalLines[comment.loc.start.line - 1]
+    const lineContent  = originalLines[comment.loc.start.line - 1]
     const isStandalone = lineContent.trim().startsWith("//")
 
     if (!isStandalone) {

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

@@ -32,7 +32,7 @@ module RuboCop
 
           extend AutoCorrector
 
-          MSG = "Collapse multi-line `%<name>s` call into a single line.".freeze
+          MSG = "Collapse multi-line `%{name}` call into a single line.".freeze
 
           DEFAULT_METHODS = ["link_to"].freeze
 

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

@@ -24,7 +24,7 @@ module RuboCop
 
           extend AutoCorrector
 
-          MSG = "Move priority kwargs (%<keys>s) to the front of the call.".freeze
+          MSG = "Move priority kwargs (%{keys}) to the front of the call.".freeze
 
           DEFAULT_METHODS = ["link_to"].freeze
           DEFAULT_PRIORITY_KEYS = ["remote", "method"].freeze

data/linters/rubocop/cop/style/method_call_with_args_parentheses_override.rb

@@ -39,14 +39,14 @@ module RuboCop
             ##============================================================##
             jbuilder_block_node = node.each_ancestor(:block).find do |ancestor_node|
               block_method_name = ancestor_node.children.first.method_name
-              (block_method_name == :encode || block_method_name == :new) && ancestor_node.children.first.receiver&.const_name == "Jbuilder"
+              [:encode, :new].include?(block_method_name) && ancestor_node.children.first.receiver&.const_name == "Jbuilder"
             end
 
             ##============================================================##
             ## Source Name is the name of the method called. Here in our
             ## block it will be "json" but it can be any value put in the
             ## Jbuilder.encode do |name|
-            ## ----
+            ## ---------
             ## In .json.jbuilder files, it will always be "json"
             ##============================================================##
             source_name   = receiver.loc.expression.source

data/linters/rubocop-4.0.7.yml

@@ -217,3 +217,5 @@ CustomCops/Style/KwargPriorityOrder:
   - method
 Gemspec/RequireMFA:
   Enabled: false
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/linters/rubocop.yml

@@ -247,3 +247,5 @@ CustomCops/Style/KwargPriorityOrder:
 #################### GEM ###########################
 Gemspec/RequireMFA:
   Enabled: false # Don't require MFA to push a gem
+Gemspec/RequiredRubyVersion:
+  Enabled: false # TargetRubyVersion is always set to the Ruby running the cleaner, so it never matches the minimum a gemspec declares (`>= 3.2.6` vs 4.0.x): the cop would flag every gemspec.

data/package.json

@@ -13,7 +13,6 @@
     "@typescript-eslint/parser":        "^8.71.0",
     "@typescript/native":               "npm:typescript@^7.0.2",
     "eslint":                           "^10.11.0",
-    "eslint-plugin-align-assignments":  "^1.1.2",
     "eslint-plugin-align-import":       "^1.0.0",
     "eslint-plugin-erb":                "^2.1.1",
     "eslint-plugin-prefer-arrow":       "^1.2.3",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: immosquare-cleaner
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - immosquare
@@ -183,6 +183,7 @@ files:
 - linters/erb_lint/custom_align_consecutive_calls.rb
 - linters/erb_lint/custom_html_to_content_tag.rb
 - linters/erb_lint/custom_single_line_if_modifier.rb
+- linters/eslint-plugins/align-assignments.mjs
 - linters/eslint-plugins/eslint10-compat.mjs
 - linters/eslint.config.mjs
 - linters/js-erb-lint-4.0.6.yml