slop-police 0.1.0 → 0.2.0

package/README.md

@@ -1,6 +1,6 @@
 # slop-police
 
-A fast, type-aware linter for TypeScript that catches the dead code and needless indirection AI coding agents tend to leave behind: methods nobody calls, object keys nobody reads, getters and aliases that only rename something.
+A fast, type-aware linter for TypeScript that catches the dead code and needless indirection AI coding agents tend to leave behind: methods nobody calls, object keys nobody reads, getters, aliases and wrappers that only rename or forward something, helpers copied instead of reused, comments that only promise future work, and errors swallowed or flattened into strings.
 
 It runs the TypeScript 7 compiler in-process, so rules resolve symbols the same way `tsc` does, across all of your tsconfig projects at once.
 
@@ -31,7 +31,12 @@ slop-police reads `slop-police.json` from the current directory:
     "no-identity-type-alias": "warn",
     "no-pass-through-getter": "error",
     "no-redundant-value-alias": "error",
-    "no-single-string-cn": "off"
+    "no-single-string-cn": "off",
+    "no-pass-through-wrapper": "error",
+    "no-duplicate-function": "warn",
+    "no-placeholder-comment": "error",
+    "no-promise-default-fallback": "error",
+    "no-stringified-unknown-error": "warn"
   }
 }
 ```
@@ -91,6 +96,24 @@ class Store {
 }
 ```
 
+### no-pass-through-wrapper
+
+A function or method whose body only returns a call (awaited or not) to a named function, passing its own parameters on as they are.
+
+```ts
+function loadUser(id: string) { // Function loadUser only forwards to api.loadUser
+  return api.loadUser(id);
+}
+```
+
+It uses types to skip wrappers that do something:
+
+- the shape is required: a method of a typed object literal (a `Proxy` handler, a Worker's `fetch`), a method that implements or overrides an inherited member, or a function assigned to a variable with a declared type. An override that only calls `super`'s method of the same name is still reported.
+- the wrapper adds types: type parameters, overloads, or parameter and return types declared differently from the callee's, like `t(key: TranslationKey)` around `translate(key: string)`.
+- it delegates to a private or protected member, like `get(key) { return this.items.get(key); }`.
+
+Calls on computed values (`getDay(date).getTime()`, `/^\s*$/.test(text)`) aren't forwarding, so they don't count.
+
 ### no-redundant-value-alias
 
 A local `const` that only renames another `const`, when using the original directly means the same thing.
@@ -111,47 +134,76 @@ function render() {
 <div className={cn("flex gap-2")} /> // Use the class string directly instead of wrapping it in cn()
 ```
 
-## Ignoring findings
+### no-placeholder-comment
 
-A `// slop-police-ignore` comment directly above a statement, class member or object property silences findings in it, including everything nested inside. List rule names to silence only those, and add a reason after `--`:
+A comment that only promises future work instead of describing the code: "add more validation", "handle more cases", "can be extended in the future", "extend this logic", "customize this behavior", "future enhancement", "implement … here". Ordinary TODOs don't match.
 
 ```ts
-class Store {
-  // slop-police-ignore unused-methods -- called from the devtools console
-  debug() {}
+function parse(input: string) {
+  // Add more validation here
+  return JSON.parse(input);
 }
+```
 
-// slop-police-ignore
-export const legacyLinks = { a: "/a", b: "/b" };
+### 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.
+
+```ts
+// users.ts, posts.ts and teams.ts each have:
+export async function loadUsers(id: string) {
+  const response = await fetchJson("/users/" + id);
+  if (!response.ok) throw new Error("failed to load users");
+  return response.data;
+}
+// Function loadUsers has the same body shape as loadPosts (posts.ts:1), loadTeams (teams.ts:1)
 ```
 
-## Platforms
+### no-promise-default-fallback
 
-Prebuilt binaries cover macOS and Linux on arm64 and x64. On Windows, use WSL.
+A promise `.catch()` handler that hides the rejection: an empty handler, or one that only returns `null`, `undefined`, `false`, `0`, `""`, `[]` or `{}`, optionally after `console.*` or `logger.*` calls. Only `.catch` on promises and other thenables counts.
 
-## TypeScript version
+```ts
+const config = await fetchConfig().catch(() => null); // Promise rejection is replaced with null
+navigator.clipboard.writeText(text).catch(() => {}); // Promise rejection is swallowed by an empty catch handler
+const enabled = await fetchFlag().catch((error) => { // Promise rejection is logged and replaced with false
+  console.error("flag load failed", error);
+  return false;
+});
+```
 
-The binary embeds the TypeScript 7.0.2 compiler (typescript-go), so it doesn't use the `typescript` package from your project. Your tsconfigs need to work with TypeScript 7.
+### no-stringified-unknown-error
 
-## Development
+`error instanceof Error ? error.message : String(error)` (in either order), which flattens a caught value into a string and drops its type, stack and cause. A plain `instanceof Error` check counts when the variable is named `error`, `err`, `e` or `cause`; an `||` of `instanceof` checks counts for any name.
 
-```sh
-go test ./...
-go build ./cmd/slop-police
+```ts
+try {
+  await sendMessage(chatId, text);
+} catch (error) {
+  return { ok: false, error: error instanceof Error ? error.message : String(error) }; // Caught value error is flattened into a string
+}
 ```
 
-The Go module path is `github.com/microsoft/typescript-go/x/slop-police`. That's on purpose: it lets the linter import typescript-go's internal packages (checker, find-all-references, project loading), which Go only allows from paths under the same prefix. `go.mod` pins typescript-go to the exact commit a TypeScript release was built from; to upgrade, bump that pin and fix what breaks.
+## Ignoring findings
 
-### Releasing
+A `// slop-police-ignore` comment directly above a statement, class member or object property silences findings in it, including everything nested inside. List rule names to silence only those, and add a reason after `--`:
 
-Bump `version` in `npm/slop-police/package.json`, commit, then push a matching tag:
+```ts
+class Store {
+  // slop-police-ignore unused-methods -- called from the devtools console
+  debug() {}
+}
 
-```sh
-git tag v0.1.0 && git push origin v0.1.0
+// slop-police-ignore
+export const legacyLinks = { a: "/a", b: "/b" };
 ```
 
-CI builds the binaries for macOS and Linux (arm64 and x64) and publishes `slop-police` plus one `slop-police-<os>-<cpu>` package per platform, which npm installs as an optional dependency. Publishing needs an `NPM_TOKEN` repository secret.
+For `no-placeholder-comment`, put the ignore comment on the line directly above the reported comment.
+
+## Requirements
+
+macOS or Linux on arm64 or x64 (on Windows, use WSL). The linter bundles its own TypeScript 7 compiler, so your tsconfigs need to work with TypeScript 7.
 
 ## License
 
-MIT. The published binaries include the TypeScript compiler and other dependencies; their licenses ship in `THIRD_PARTY_NOTICES.txt`.
+MIT

package/package.json

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