slop-police 0.3.0 → 0.3.1

package/README.md

@@ -6,17 +6,19 @@
 A type-aware TypeScript linter for the dead code and needless indirection AI agents leave behind.
 </p>
 
-| | pnpm | npm |
-| --- | --- | --- |
-| Add to the project | `pnpm add -D slop-police` | `npm i -D slop-police` |
-| Run | `pnpm exec slop-police` | `npx slop-police` |
-| Run once, no install | `pnpm dlx slop-police` | `npx slop-police` |
+```sh
+pnpm add slop-police
+# or
+npm i slop-police
+```
+
+Run it with `pnpm exec slop-police` or `npx slop-police`.
 
 Example output:
 
 ```
-packages/frontend/src/store/deck-store.ts:42:3  error  unused-methods      Method DeckStore.reset is never used
-packages/api/src/shared/links/links.ts:30:3     error  unused-object-keys  links.privacyPolicy is never read
+deck-store.ts:42:3  error  unused-methods      Method DeckStore.reset is never used
+links.ts:30:3       error  unused-object-keys  links.privacyPolicy is never read
 
 2 errors, 0 warnings
 ```
@@ -270,7 +272,7 @@ export const noRepeatedUrl = defineRule({
 });
 ```
 
-Test rules with `lint` from `slop-police/testing`, which runs a rule alone on a source string (or on files, given an object of paths to contents) in a strict TypeScript project:
+Test rules with `lint` from `slop-police/testing`, which runs a rule alone on a source string (as `index.ts`) or on files (an object of paths to contents) in a strict TypeScript project:
 
 ```ts
 import { lint } from "slop-police/testing";
@@ -278,12 +280,12 @@ import { noDirectFetch } from "./slop-rules.ts";
 
 test("no-direct-fetch", () => {
   expect(lint(noDirectFetch, `fetch("/users");`)).toEqual([
-    { line: 1, column: 1, message: "Use the API client instead of fetch()" },
+    { file: "index.ts", line: 1, column: 1, message: "Use the API client instead of fetch()" },
   ]);
 });
 ```
 
-Plugins need the npm launcher (`npx slop-police` or `pnpm exec slop-police`), which runs them in Node while the linter serves ASTs and types. TypeScript plugins need Node.js 22.18 or later, and published plugin packages must ship JavaScript.
+Plugins need the npm launcher (`npx slop-police` or `pnpm exec slop-police`), which runs them in Node while the linter serves ASTs and types. Published plugin packages must ship JavaScript, since Node doesn't run TypeScript from `node_modules`.
 
 ## Ignoring findings
 
@@ -303,7 +305,7 @@ For `no-placeholder-comment`, put the ignore comment on the line directly above
 
 ## 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.
+macOS or Linux on arm64 or x64 (on Windows, use WSL), and Node.js 22.18 or later. The linter bundles its own TypeScript 7 compiler, so your tsconfigs need to work with TypeScript 7.
 
 ## License
 

package/lib/runner.js

@@ -38,7 +38,7 @@ async function loadPlugins(root, plugins) {
     try {
       exports = await import(resolvePlugin(root, plugin));
     } catch (error) {
-      throw new LintError(`Unable to load plugin ${plugin}: ${error.message}${loadHint(error, plugin)}`, 2);
+      throw new LintError(`Unable to load plugin ${plugin}: ${error.message}`, 2);
     }
     const found = Object.values(exports).flat().filter(isRule);
     if (found.length === 0) {
@@ -62,13 +62,6 @@ function resolvePlugin(root, plugin) {
   return pathToFileURL(createRequire(path.join(root, "package.json")).resolve(plugin)).href;
 }
 
-function loadHint(error, plugin) {
-  if (error.code === "ERR_UNKNOWN_FILE_EXTENSION" && /\.[cm]?tsx?$/.test(plugin)) {
-    return " (TypeScript plugins need Node.js 22.18 or later)";
-  }
-  return "";
-}
-
 // lint runs the built-in rules enabled in root's config in the binary and the
 // enabled ones among rules here, and returns the binary's report: {results,
 // output, exitCode}. It throws a LintError when the run fails.

package/lib/testing.d.ts

@@ -1,6 +1,8 @@
 import type { Rule, RuleOptions } from "./index.js";
 
 export interface Finding {
+  /** The path relative to the project: index.ts for a source string. */
+  file: string;
   /** 1-based. */
   line: number;
   /** 1-based, in UTF-16 code units. */
@@ -8,14 +10,8 @@ export interface Finding {
   message: string;
 }
 
-/** Runs rule alone on source, as index.ts in a strict TypeScript project. */
-export declare function lint(rule: Rule<any>, source: string, options?: RuleOptions): Finding[];
 /**
- * Runs rule alone on files (paths to contents), in a strict TypeScript project
- * unless files has a tsconfig.json.
+ * Runs rule alone on source (as index.ts) or on files (paths to contents), in
+ * a strict TypeScript project unless files has a tsconfig.json.
  */
-export declare function lint(
-  rule: Rule<any>,
-  files: Record<string, string>,
-  options?: RuleOptions,
-): (Finding & { file: string })[];
+export declare function lint(rule: Rule<any>, source: string | Record<string, string>, options?: RuleOptions): Finding[];

package/lib/testing.js

@@ -17,9 +17,9 @@ const tsconfig = {
   include: ["**/*.ts", "**/*.tsx"],
 };
 
-// lint runs rule alone on source (index.ts) or on files (paths to contents,
-// with a default strict tsconfig.json unless one is given) and returns the
-// findings, with the file of each when given files.
+// 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.
 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,9 +31,7 @@ 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 }) =>
-      typeof source === "string" ? { line, column, message } : { file, line, column, message },
-    );
+    return lintWithRules(findBinary(), root, [rule]).results.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.0",
+  "version": "0.3.1",
   "description": "Type-aware TypeScript linter for the dead code and needless indirection AI agents leave behind",
   "keywords": [
     "typescript",
@@ -38,12 +38,12 @@
     "LICENSE"
   ],
   "engines": {
-    "node": ">=18"
+    "node": ">=22.18"
   },
   "optionalDependencies": {
-    "slop-police-darwin-arm64": "0.3.0",
-    "slop-police-darwin-x64": "0.3.0",
-    "slop-police-linux-arm64": "0.3.0",
-    "slop-police-linux-x64": "0.3.0"
+    "slop-police-darwin-arm64": "0.3.1",
+    "slop-police-darwin-x64": "0.3.1",
+    "slop-police-linux-arm64": "0.3.1",
+    "slop-police-linux-x64": "0.3.1"
   }
 }