slop-police 0.3.2 → 0.3.4

package/README.md

@@ -34,15 +34,8 @@ slop-police reads `slop-police.json` from the current directory:
   "testFiles": ["**/*.test.{ts,tsx}", "**/*.spec.{ts,tsx}"],
   "rules": {
     "unused-methods": ["error", { "includePrivate": true }],
-    "unused-object-keys": "error",
     "no-identity-type-alias": "warn",
-    "no-pass-through-getter": "error",
-    "no-redundant-value-alias": "error",
-    "no-single-string-cn": "off",
-    "no-pass-through-wrapper": "error",
-    "no-duplicate-function": "warn",
-    "no-placeholder-comment": "error",
-    "no-stringified-unknown-error": "warn"
+    "no-single-string-cn": "off"
   }
 }
 ```
@@ -50,7 +43,7 @@ slop-police reads `slop-police.json` from the current directory:
 - `projects`: tsconfig files to analyze. Usages are counted across all of them, so a method used only by another package still counts as used.
 - `ignore`: glob patterns (relative to the config) for files to skip entirely.
 - `testFiles`: glob patterns for tests. Usages inside tests count, but declarations inside tests are not reported.
-- `rules`: `"error"`, `"warn"` or `"off"`, or `[severity, options]`. Rules that aren't listed are off.
+- `rules`: every built-in rule runs as an error with its default options. List a rule here to change that: `"error"`, `"warn"` or `"off"`, or `[severity, options]`. Plugin rules run only when they're listed.
 - `plugins`: modules with [custom rules](#custom-rules), as paths relative to the config or package names.
 
 Exit code is `1` when there are errors, `2` for an invalid config, `0` otherwise.
@@ -152,6 +145,26 @@ function parse(input: string) {
 }
 ```
 
+### no-duplicate-code
+
+Copy-pasted code: at least 50 tokens in a row that repeat earlier code (in the same file or one before it by path) and span at least 11 lines. Tokens are compared by their text, types included, so a renamed variable or a different type ends a copy, but comments, formatting and imports are left out. Test files are neither reported nor compared. `// slop-police-ignore no-duplicate-code` above a statement, class member or object property takes it out of the comparison, so it is not reported as a copy or as the original. Options: `minLines` (default `11`, counting every line a copy spans) and `minTokens` (default `50`).
+
+```ts
+// update-card.ts and delete-card.ts both check the card the same way:
+const userId = ctx.userId;
+assert(userId);
+
+const cards = await getCardsWithDeck(ctx.db, [input.id]);
+if (cards.length === 0) {
+  throw notFound("Card not found");
+}
+const card = cards[0];
+if (card.deckAuthorId !== userId) {
+  throw forbidden("You don't own this card");
+}
+// delete-card.ts:6:5  Lines 6-16 duplicate update-card.ts:6-16
+```
+
 ### no-duplicate-function
 
 A function whose body has the same shape as functions in at least two other files: a helper that was rewritten instead of reused. Shapes ignore the names of parameters and locals and the values of literals, but not the names of what the body calls or reads. Bodies with fewer than 2 statements or 16 syntax nodes, and functions in test files, don't count. Option: `minFiles` (default `3`, at least `2`), the number of files a shape has to appear in.
@@ -180,7 +193,7 @@ try {
 
 ## Custom rules
 
-Write rules in TypeScript or JavaScript, list their modules in `plugins` and enable them in `rules` like built-in ones:
+Write rules in TypeScript or JavaScript, list their modules in `plugins` and turn them on in `rules`:
 
 ```json
 {

package/lib/testing.js

@@ -17,9 +17,9 @@ const tsconfig = {
   include: ["**/*.ts", "**/*.tsx"],
 };
 
-// lint runs rule alone on source (as index.ts) or on files (paths to
-// contents, with a default strict tsconfig.json unless one is given) and
-// returns its findings.
+// lint runs rule on source (as index.ts) or on files (paths to contents, with
+// a default strict tsconfig.json unless one is given) and returns its
+// findings, leaving out those of the built-in rules.
 export function lint(rule, source, options) {
   const files = typeof source === "string" ? { "index.ts": source } : source;
   const root = fs.mkdtempSync(path.join(os.tmpdir(), "slop-police-test-"));
@@ -31,7 +31,9 @@ export function lint(rule, source, options) {
       fs.mkdirSync(path.dirname(file), { recursive: true });
       fs.writeFileSync(file, content);
     }
-    return lintWithRules(findBinary(), root, [rule]).results.map(({ file, line, column, message }) => ({ file, line, column, message }));
+    return lintWithRules(findBinary(), root, [rule])
+      .results.filter((result) => result.rule === rule.name)
+      .map(({ file, line, column, message }) => ({ file, line, column, message }));
   } finally {
     fs.rmSync(root, { recursive: true, force: true });
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "slop-police",
-  "version": "0.3.2",
+  "version": "0.3.4",
   "description": "Type-aware TypeScript linter for the dead code and needless indirection AI agents leave behind",
   "keywords": [
     "typescript",
@@ -41,9 +41,9 @@
     "node": ">=22.18"
   },
   "optionalDependencies": {
-    "slop-police-darwin-arm64": "0.3.2",
-    "slop-police-darwin-x64": "0.3.2",
-    "slop-police-linux-arm64": "0.3.2",
-    "slop-police-linux-x64": "0.3.2"
+    "slop-police-darwin-arm64": "0.3.4",
+    "slop-police-darwin-x64": "0.3.4",
+    "slop-police-linux-arm64": "0.3.4",
+    "slop-police-linux-x64": "0.3.4"
   }
 }