@fabriziosalmi/slopless 1.5.0 → 1.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fabriziosalmi/slopless",
-  "version": "1.5.0",
+  "version": "1.7.0",
   "description": "",
   "main": "dist/index.js",
   "bin": {
@@ -22,7 +22,7 @@
     "verify:bundle": "node scripts/verify-bundle.js",
     "verify:action": "bash scripts/run-action-locally.sh . 'src/**/*.ts'",
     "release:prep": "npm run docs:gen && npm run build && npm test && npm run verify:bundle",
-    "version": "npm run build && git add dist"
+    "version": "node scripts/check-changelog.js && npm run docs:gen && npm run build && git add dist docs README.md"
   },
   "keywords": [
     "linter",
@@ -42,14 +42,14 @@
   },
   "type": "commonjs",
   "devDependencies": {
-    "@types/glob": "^8.1.0",
+    "@types/glob": "^9.0.0",
     "@types/js-yaml": "^4.0.9",
-    "@types/node": "^25.3.0",
+    "@types/node": "^26.4.0",
     "@vitest/coverage-v8": "^4.0.18",
-    "commander": "^14.0.3",
+    "commander": "^15.0.0",
     "glob": "^13.0.6",
     "ignore": "^7.0.5",
-    "js-yaml": "^4.1.1",
+    "js-yaml": "^5.4.1",
     "minimatch": "^10.2.6",
     "ts-node": "^10.9.2",
     "tsup": "^8.5.1",

package/rules/VBC-003.yaml

@@ -10,6 +10,9 @@ match:
     - sh
     - py
     - js
+  # The same decision as the paths below, for languages that keep their
+  # tests in the file they test.
+  exclude_test_code: true
   exclude_files:
     - '**/test/**'
     - '**/tests/**'

package/rules/VBC-015.yaml

@@ -11,6 +11,9 @@ match:
     - js
     - ts
     - py
+  # The same decision as the paths below, for languages that keep their
+  # tests in the file they test.
+  exclude_test_code: true
   exclude_files:
     - '**/test/**'
     - '**/tests/**'

package/rules/VBC-019.yaml

@@ -13,6 +13,9 @@ match:
     - ts
     - py
     - sh
+  # The same decision as the paths below, for languages that keep their
+  # tests in the file they test.
+  exclude_test_code: true
   exclude_files:
     - '**/test/**'
     - '**/tests/**'

package/rules/VBC-034.yaml

@@ -13,6 +13,9 @@ match:
     - ts
     - py
     - html
+  # The same decision as the paths below, for languages that keep their
+  # tests in the file they test.
+  exclude_test_code: true
   exclude_files:
     - '**/test/**'
     - '**/tests/**'

package/rules/VBC-042.yaml

@@ -9,6 +9,7 @@ match:
   flags: m
   multiline: true
   scan: all
+  exclude_doc_comments: true
   file_types:
     - js
     - ts
@@ -17,10 +18,37 @@ message: >-
   Too many consecutive comment lines at line {line}. Code should be self-documenting.
 tests:
   fire:
-    - code: |
-        // filler comment line
-      repeat: 12
+    # Below the first line of code, so it is commentary rather than a header.
+    - |
+      const answer = 42;
+      // filler comment line
+      // filler comment line
+      // filler comment line
+      // filler comment line
+      // filler comment line
+      // filler comment line
+      // filler comment line
+      // filler comment line
+      // filler comment line
+      // filler comment line
+      // filler comment line
+      // filler comment line
   quiet:
     - |
       // one explanatory comment
       const answer = 42;
+    # A banner at the top of a file explains what the file is. Counting it as
+    # excess commentary reported 79 module headers in one project.
+    - |
+      // ─────────────────────────────
+      // Wasm Core Bridge
+      //
+      // Lazy-loads the Rust module.
+      // All functions go through this singleton.
+      //
+      // Usage:
+      //   import { core } from './bridge';
+      //   const c = await core();
+      //
+      // ─────────────────────────────
+      import { core } from './bridge';

package/rules/VBC-049.yaml

@@ -16,6 +16,9 @@ match:
     - py
     - go
     - rs
+  # The same decision as the paths below, for languages that keep their
+  # tests in the file they test.
+  exclude_test_code: true
   exclude_files:
     - '**/test/**'
     - '**/tests/**'

package/rules/VBC-056.yaml

@@ -15,6 +15,15 @@ match:
     - ts
     - py
     - sh
+    - go
+    - rs
+    - java
+    - c
+    - cpp
+    - cs
+    - kt
+    - swift
+    - rb
 supersedes:
   - VBC-907
   - VBC-150

package/rules/VBC-090.yaml

@@ -18,6 +18,13 @@ match:
     - c
     - cpp
     - md
+    - go
+    - rs
+    - java
+    - cs
+    - kt
+    - swift
+    - rb
 message: >-
   Passive-aggressive or helpless comment '{match}' detected at line {line}. Replace with a
   technical explanation of the actual constraint or a link to the relevant issue tracker ticket.

package/rules/VBC-096.yaml

@@ -6,6 +6,9 @@ tags:
   - clean-code
 match:
   regex: /(?:[^/\n\\]|\\.){30,}/[dgimsuvy]*
+  # Regular expression literals and nothing else. Reading strings found the
+  # slashes in a translation file; reading code found the ones in a division.
+  scan: regex
   file_types:
     - js
     - ts

package/rules/VBC-103.yaml

@@ -10,26 +10,44 @@ match:
     (?:^[ \t]*(?:#|//)(?=[^\nA-Za-z0-9]*$)[^\n]*[-=*#_|/\\+~^]{6,}[^\n]*$\n){3,}
   flags: m
   multiline: true
+  scan: comments
   file_types:
     - js
     - ts
     - py
     - sh
+    - go
+    - rs
+    - java
+    - c
+    - cpp
+    - cs
+    - kt
+    - swift
+    - rb
 message: >-
   Block of decoration at line {line}: three or more comment lines that are shape and nothing
   else. A rule around a section heading is punctuation and is not reported; a banner is furniture
   that has to be maintained.
 tests:
   fire:
+    # A `#` banner needs a file where `#` opens a comment.
+    - file: a.py
+      code: |
+        # ####################
+        # ####################
+        # ####################
     - |
-      # ####################
-      # ####################
-      # ####################
+      // ####################
+      // ####################
+      // ####################
   quiet:
-    - |
-      # --------------------------------
-      # Shared fixtures from public data
-      # --------------------------------
-    - |
-      # ------------------------------
-    - '# - handles retries'
+    - file: a.py
+      code: |
+        # --------------------------------
+        # Shared fixtures from public data
+        # --------------------------------
+    - file: a.py
+      code: |
+        # ------------------------------
+    - { file: a.py, code: '# - handles retries' }

package/rules/VBC-150.yaml

@@ -15,6 +15,13 @@ match:
     - sh
     - c
     - cpp
+    - go
+    - rs
+    - java
+    - cs
+    - kt
+    - swift
+    - rb
 message: >-
   Tracked debt marker still in the code at line {line}. It is attributed, so close the ticket
   or delete the marker before shipping.

package/rules/VBC-334.yaml

@@ -10,9 +10,26 @@ match:
     (As an AI language model|It's important to remember that|In conclusion,|Let's dive into|the
     landscape of|tapestry of|delve into|unleash|unlocking|delving into|testament to)
   flags: i
+  scan: comments
   file_types:
     - md
     - txt
+    - go
+    - rs
+    - java
+    - c
+    - cpp
+    - cs
+    - kt
+    - swift
+    - rb
+    - html
+    - js
+    - ts
+    - tsx
+    - jsx
+    - py
+    - sh
 message: >-
   Potential AI-generated fluff or overused cliché '{match}' detected at line {line}. Keep
   documentation concise and human-centric.

package/rules/VBC-901.yaml

@@ -16,6 +16,9 @@ match:
     - java
     - json
     - env
+  # The same decision as the paths below, for languages that keep their
+  # tests in the file they test.
+  exclude_test_code: true
   exclude_files:
     - '**/test/**'
     - '**/tests/**'

package/rules/VBC-906.yaml

@@ -16,6 +16,15 @@ match:
     - py
     - sh
     - css
+    - go
+    - rs
+    - java
+    - c
+    - cpp
+    - cs
+    - kt
+    - swift
+    - rb
 supersedes:
   - VBC-907
   - VBC-150

package/rules/VBC-907.yaml

@@ -5,20 +5,36 @@ category: clean-code
 tags:
   - clean-code
 match:
+  # The marker has to open the comment. Matching it mid-sentence read prose
+  # about TODOs as a TODO: `// a TODO. Sites that DO build a header ...`
   regex: >-
-    \b(?:TODO|FIXME|HACK|XXX)\b(?!\s*[\(\[][^)\]\n]+[\)\]])(?!\s*:?\s*(?:#\d+|[A-Z][A-Z0-9]+-\d+))
+    ^[^\n\w]*(?:TODO|FIXME|HACK|XXX)\b(?!\s*[\(\[][^)\]\n]+[\)\]])(?!\s*:?\s*(?:#\d+|[A-Z][A-Z0-9]+-\d+))
+  flags: m
   scan: comments
   file_types:
     - js
     - ts
     - py
     - sh
+    - go
+    - rs
+    - java
+    - c
+    - cpp
+    - cs
+    - kt
+    - swift
+    - rb
 message: >-
   Unattributed debt marker at line {line}. Nobody owns it, so nobody will fix it. Use TODO(owner):
   or reference an issue such as TODO: #123.
 tests:
   fire:
     - '// TODO: wire up retries'
+    - '// TODO: drain the queue before closing'
   quiet:
+    # Prose about a TODO is not a TODO.
+    - '// a TODO. Sites that build a header from dynamic data need one'
+    - '/// Reviewer note: `?` used to be a TODO no-op'
     - '// TODO(fab): wire up retries'
     - '// TODO: #123 wire up retries'

package/rules/VBC-921.yaml

@@ -18,6 +18,9 @@ match:
     - go
     - rs
     - html
+  # The same decision as the paths below, for languages that keep their
+  # tests in the file they test.
+  exclude_test_code: true
   exclude_files:
     - '**/test/**'
     - '**/tests/**'

package/rules/VBC-928.yaml

@@ -20,6 +20,14 @@ match:
     - rs
     - java
     - sh
+    - tsx
+    - jsx
+    - c
+    - cpp
+    - cs
+    - kt
+    - swift
+    - rb
 message: >-
   Placeholder text 'Lorem ipsum' detected at line {line}. Replace with real content before
   committing.

package/rules/VBC-933.yaml

@@ -8,9 +8,19 @@ tags:
 match:
   regex: (coming soon|under construction|not yet written|🚧\s*wip|todo:\s*write)
   flags: i
+  scan: comments
   file_types:
     - md
     - txt
+    - go
+    - rs
+    - java
+    - c
+    - cpp
+    - cs
+    - kt
+    - swift
+    - rb
 message: >-
   Placeholder documentation content '{match}' at line {line}. Documentation stubs with "coming
   soon" text signal an abandoned project to new contributors. Either write the section or