@timmo001/oxlint-rules 0.1.3 → 0.2.0

package/dist/generic/index.js

@@ -0,0 +1,70 @@
+// src/generic/index.ts
+import { eslintCompatPlugin } from "@oxlint/plugins";
+
+// src/generic/rules/prefer-event-parameter-type.ts
+import { defineRule } from "@oxlint/plugins";
+function nearestEnclosingFunction(node) {
+  let current = node.parent;
+  while (current) {
+    if (current.type === "FunctionDeclaration" || current.type === "FunctionExpression" || current.type === "ArrowFunctionExpression") {
+      return current;
+    }
+    current = current.parent;
+  }
+  return null;
+}
+function assertedEventParameter(node) {
+  const expression = node.expression;
+  if (expression.type !== "MemberExpression" || expression.computed || expression.object.type !== "Identifier" || expression.property.type !== "Identifier" || expression.property.name !== "currentTarget" && expression.property.name !== "target") {
+    return null;
+  }
+  const parameterName = expression.object.name;
+  const property = expression.property.name;
+  const owner = nearestEnclosingFunction(node);
+  if (!owner?.params.some((parameter) => parameter.type === "Identifier" && parameter.name === parameterName)) {
+    return null;
+  }
+  return {
+    parameter: parameterName,
+    property
+  };
+}
+var preferEventParameterTypeRule = defineRule({
+  meta: {
+    type: "suggestion",
+    docs: {
+      description: "Prefer typing event target properties in the handler parameter instead of asserting them at use sites."
+    },
+    messages: {
+      typeEventParameter: "Type `{{parameter}}.{{property}}` in the function signature instead of asserting it at the use site."
+    }
+  },
+  create(context) {
+    const checkAssertion = (node) => {
+      const eventParameter = assertedEventParameter(node);
+      if (!eventParameter)
+        return;
+      context.report({
+        node,
+        messageId: "typeEventParameter",
+        data: eventParameter
+      });
+    };
+    return {
+      TSAsExpression: checkAssertion,
+      TSTypeAssertion: checkAssertion
+    };
+  }
+});
+
+// src/generic/index.ts
+var timmoPlugin = eslintCompatPlugin({
+  meta: { name: "timmo" },
+  rules: {
+    "prefer-event-parameter-type": preferEventParameterTypeRule
+  }
+});
+var generic_default = timmoPlugin;
+export {
+  generic_default as default
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@timmo001/oxlint-rules",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "Shared Oxlint plugins and configs with optional Effect rules.",
   "type": "module",
   "license": "Apache-2.0",
@@ -14,17 +14,21 @@
   "exports": {
     "./upstream/anti-slop": "./dist/upstream/anti-slop.js",
     "./upstream/effect": "./dist/upstream/effect.js",
+    "./generic": "./dist/generic/index.js",
     "./effect": "./dist/effect/index.js",
     "./configs/recommended": "./dist/configs/recommended.js",
     "./configs/effect": "./dist/configs/effect.js"
   },
   "files": [
     "dist",
-    "src",
-    "!src/**/*.test.ts",
+    "src/effect",
+    "src/generic",
+    "!src/generic/**/*.test.ts",
+    "!src/effect/**/*.test.ts",
     "vendor/anti-slop/src",
     "vendor/anti-slop/LICENSE",
     "!vendor/anti-slop/src/**/*.test.ts",
+    "!vendor/anti-slop/README.md",
     "skills",
     "README.md",
     "THIRD_PARTY_NOTICES.md",
@@ -37,7 +41,7 @@
     "format:check": "prettier --check \"{src,scripts}/**/*.ts\" \"skills/**/*.{md,mjs}\" \"*.md\" \"*.json\"",
     "lint": "oxlint src scripts",
     "skills:validate": "bunx skills-ref validate skills/install-timmo-oxlint-rules && bunx skills-ref validate skills/add-oxlint-rule",
-    "test": "node --experimental-strip-types src/effect/rules/no-try-catch-in-effect-generators.test.ts && bun test src/install/copy.test.ts",
+    "test": "node --experimental-strip-types scripts/test.ts",
     "typecheck": "tsc --noEmit"
   },
   "peerDependencies": {

package/skills/add-oxlint-rule/SKILL.md

@@ -21,8 +21,10 @@ description: >-
 5. Put generic upstream-independent rules under the appropriate locally owned
    plugin. Never modify `vendor/anti-slop`; propose an upstream contribution
    separately when Dylan Mulroy's plugin should own the behaviour.
-6. Register the rule in its plugin and matching config, then update the README
-   rule list and behaviour description.
+6. Register the rule in its plugin. Verify the matching config and copy command
+   discover it from the plugin's `rules` map, then update the README rule list
+   and behaviour description. Keep skills workflow-only; do not duplicate rule
+   or plugin inventories or counts in them.
 7. Run `mise run check`, `mise run build`, `npm pack --dry-run`, and
    `bunx jsr@0.14.3 publish --dry-run` in the central checkout.
 

package/skills/install-timmo-oxlint-rules/SKILL.md

@@ -23,9 +23,9 @@ description: >-
 2. Detect Bun, npm, pnpm, or Yarn from the target's package manager declaration
    and lockfile. Add an exact development dependency through that package
    manager.
-3. Extend `@timmo001/oxlint-rules/configs/recommended`. Use `/configs/effect`
-   instead only when `effect` is a direct dependency or the user explicitly
-   requests it.
+3. Extend `@timmo001/oxlint-rules/configs/recommended`. The config owns plugin
+   registration and recommended severities. Use `/configs/effect` instead only
+   when `effect` is a direct dependency or the user explicitly requests it.
 4. Keep dependency and config edits visible. Do not delegate them to a script.
 
 ## Copy rules
@@ -36,9 +36,11 @@ description: >-
    meaningful differences before asking whether replacement is intended.
 3. Run `node scripts/copy.mjs <bun|npm|pnpm|yarn> <destination>`. Add `--force`
    only after explicit replacement approval.
-4. Register the three entry points printed by the command as `anti-slop`,
-   `anti-slop-effect`, and `timmo-effect`. Enable `timmo-effect` only for direct
-   Effect use or an explicit request.
+4. Register every plugin entry point printed by the command. Merge every printed
+   general rule setting into the target config. Merge every printed Effect rule
+   setting only for direct Effect use or an explicit request. Treat the command
+   output as authoritative rather than maintaining plugin or rule inventories
+   in this skill.
 
 Run the target repository's normal lint, typecheck, tests, and build. Report
 package-manager changes, preserved local configuration, enabled rule groups,

package/src/generic/index.ts

@@ -0,0 +1,12 @@
+import { eslintCompatPlugin } from "@oxlint/plugins";
+
+import { preferEventParameterTypeRule } from "./rules/prefer-event-parameter-type.ts";
+
+const timmoPlugin = eslintCompatPlugin({
+  meta: { name: "timmo" },
+  rules: {
+    "prefer-event-parameter-type": preferEventParameterTypeRule,
+  },
+});
+
+export default timmoPlugin;

package/src/generic/rules/prefer-event-parameter-type.ts

@@ -0,0 +1,83 @@
+import { defineRule } from "@oxlint/plugins";
+
+import type { ESTree } from "@oxlint/plugins";
+
+type FunctionNode = ESTree.Function | ESTree.ArrowFunctionExpression;
+type TypeAssertion = ESTree.TSAsExpression | ESTree.TSTypeAssertion;
+
+function nearestEnclosingFunction(node: ESTree.Node): FunctionNode | null {
+  let current: ESTree.Node | null = node.parent;
+  while (current) {
+    if (
+      current.type === "FunctionDeclaration" ||
+      current.type === "FunctionExpression" ||
+      current.type === "ArrowFunctionExpression"
+    ) {
+      return current;
+    }
+    current = current.parent;
+  }
+  return null;
+}
+
+function assertedEventParameter(node: TypeAssertion): {
+  readonly parameter: string;
+  readonly property: "currentTarget" | "target";
+} | null {
+  const expression = node.expression;
+  if (
+    expression.type !== "MemberExpression" ||
+    expression.computed ||
+    expression.object.type !== "Identifier" ||
+    expression.property.type !== "Identifier" ||
+    (expression.property.name !== "currentTarget" &&
+      expression.property.name !== "target")
+  ) {
+    return null;
+  }
+  const parameterName = expression.object.name;
+  const property = expression.property.name;
+  const owner = nearestEnclosingFunction(node);
+  if (
+    !owner?.params.some(
+      (parameter) =>
+        parameter.type === "Identifier" && parameter.name === parameterName,
+    )
+  ) {
+    return null;
+  }
+  return {
+    parameter: parameterName,
+    property,
+  };
+}
+
+/** Prefer expressing an event target type in its handler parameter signature. */
+export const preferEventParameterTypeRule = defineRule({
+  meta: {
+    type: "suggestion",
+    docs: {
+      description:
+        "Prefer typing event target properties in the handler parameter instead of asserting them at use sites.",
+    },
+    messages: {
+      typeEventParameter:
+        "Type `{{parameter}}.{{property}}` in the function signature instead of asserting it at the use site.",
+    },
+  },
+  create(context) {
+    const checkAssertion = (node: TypeAssertion) => {
+      const eventParameter = assertedEventParameter(node);
+      if (!eventParameter) return;
+      context.report({
+        node,
+        messageId: "typeEventParameter",
+        data: eventParameter,
+      });
+    };
+    return {
+      TSAsExpression: checkAssertion,
+      TSTypeAssertion: checkAssertion,
+    };
+  },
+});

package/src/cli.ts

@@ -1,35 +0,0 @@
-#!/usr/bin/env node
-import { resolve } from "node:path";
-
-import { copyRules, DEFAULT_COPY_DESTINATION } from "./install/copy.ts";
-
-function usage() {
-  return "Usage: oxlint-rules copy [destination] [--force]";
-}
-
-const [command, ...arguments_] = process.argv.slice(2);
-if (command === "--help" || command === "-h") {
-  console.log(usage());
-} else if (command !== "copy") {
-  console.error(usage());
-  process.exitCode = 1;
-} else {
-  const force = arguments_.includes("--force");
-  const positional = arguments_.filter((argument) => argument !== "--force");
-  if (positional.length > 1) {
-    console.error(usage());
-    process.exitCode = 1;
-  } else {
-    try {
-      const destination = resolve(positional[0] ?? DEFAULT_COPY_DESTINATION);
-      const entries = await copyRules(destination, { force });
-      console.log("Copied Oxlint plugins:");
-      console.log(`  anti-slop: ${entries.antiSlop}`);
-      console.log(`  anti-slop-effect: ${entries.antiSlopEffect}`);
-      console.log(`  timmo-effect: ${entries.timmoEffect}`);
-    } catch (error) {
-      console.error(error instanceof Error ? error.message : String(error));
-      process.exitCode = 1;
-    }
-  }
-}

package/src/configs/effect.ts

@@ -1,20 +0,0 @@
-import { defineConfig } from "oxlint";
-
-import recommended from "./recommended.ts";
-
-const effect = defineConfig({
-  extends: [recommended],
-  jsPlugins: [
-    {
-      name: "anti-slop-effect",
-      specifier: "@timmo001/oxlint-rules/upstream/effect",
-    },
-    { name: "timmo-effect", specifier: "@timmo001/oxlint-rules/effect" },
-  ],
-  rules: {
-    "anti-slop-effect/no-service-constructor-imports": "error",
-    "timmo-effect/no-try-catch-in-effect-generators": "error",
-  },
-});
-
-export default effect;

package/src/configs/recommended.ts

@@ -1,29 +0,0 @@
-import { defineConfig } from "oxlint";
-
-const recommended = defineConfig({
-  jsPlugins: [
-    {
-      name: "anti-slop",
-      specifier: "@timmo001/oxlint-rules/upstream/anti-slop",
-    },
-  ],
-  rules: {
-    "anti-slop/no-chained-type-assertions": "error",
-    "anti-slop/no-conditional-empty-object-spread": "error",
-    "anti-slop/no-known-value-widening": "error",
-    "anti-slop/no-module-mocking": "error",
-    "anti-slop/no-object-parameters": "error",
-    "anti-slop/no-reflect-apply": "error",
-    "anti-slop/no-reflect-get": "error",
-    "anti-slop/no-runtime-typeof": "error",
-    "anti-slop/no-shape-in-symbol-names": "error",
-    "anti-slop/no-unknown-parameters": "error",
-    "anti-slop/no-unknown-returns": "error",
-    "anti-slop/no-unknown-type-aliases": "error",
-    "anti-slop/no-unsafe-dictionary-type": "error",
-    "anti-slop/no-widen-then-assert": "error",
-    "anti-slop/require-safety-comment-for-type-assertion": "error",
-  },
-});
-
-export default recommended;

package/src/install/copy.ts

@@ -1,77 +0,0 @@
-import { cp, mkdir, readdir, rm } from "node:fs/promises";
-import { dirname, join, relative, resolve, sep } from "node:path";
-import { fileURLToPath } from "node:url";
-
-export const DEFAULT_COPY_DESTINATION = "tools/oxlint/timmo-rules";
-
-export interface CopyRulesOptions {
-  readonly force?: boolean;
-  readonly sourceRoot?: string;
-}
-
-export interface CopiedRuleEntryPoints {
-  readonly antiSlop: string;
-  readonly antiSlopEffect: string;
-  readonly timmoEffect: string;
-}
-
-function packageRoot() {
-  const current = dirname(fileURLToPath(import.meta.url));
-  return current.endsWith(join("src", "install"))
-    ? resolve(current, "../..")
-    : resolve(current, "..");
-}
-
-async function copyTree(source: string, destination: string) {
-  await cp(source, destination, {
-    recursive: true,
-    filter: (path) =>
-      !path.endsWith(".test.ts") && !path.includes(`${join("", ".git")}`),
-  });
-}
-
-export async function copyRules(
-  destination: string,
-  options: CopyRulesOptions = {},
-): Promise<CopiedRuleEntryPoints> {
-  const target = resolve(destination);
-  const entries = await readdir(dirname(target), { withFileTypes: true }).catch(
-    () => [],
-  );
-  if (entries.some((entry) => entry.name === target.split(/[\\/]/u).at(-1))) {
-    if (!options.force) {
-      throw new Error(
-        `Destination already exists: ${target}. Pass --force to replace it.`,
-      );
-    }
-    await rm(target, { force: true, recursive: true });
-  }
-
-  const root = options.sourceRoot ?? packageRoot();
-  await mkdir(join(target, "upstream"), { recursive: true });
-  await copyTree(
-    join(root, "vendor/anti-slop/src"),
-    join(target, "upstream/anti-slop"),
-  );
-  await cp(
-    join(root, "vendor/anti-slop/LICENSE"),
-    join(target, "upstream/anti-slop/LICENSE"),
-  );
-  await rm(join(target, "upstream/anti-slop/effect"), {
-    force: true,
-    recursive: true,
-  });
-  await copyTree(
-    join(root, "vendor/anti-slop/src/effect"),
-    join(target, "upstream/effect"),
-  );
-  await copyTree(join(root, "src/effect"), join(target, "effect"));
-
-  const displayRoot = relative(process.cwd(), target) || ".";
-  const entryPoint = (path: string) => `./${path.split(sep).join("/")}`;
-  return {
-    antiSlop: entryPoint(join(displayRoot, "upstream/anti-slop/index.ts")),
-    antiSlopEffect: entryPoint(join(displayRoot, "upstream/effect/index.ts")),
-    timmoEffect: entryPoint(join(displayRoot, "effect/index.ts")),
-  };
-}

package/src/jsr/effect-config.ts

@@ -1,7 +0,0 @@
-import type { OxlintConfig } from "oxlint";
-
-import bundledConfig from "../../dist/configs/effect.js";
-
-const config: OxlintConfig = bundledConfig;
-
-export default config;

package/src/jsr/effect.ts

@@ -1,7 +0,0 @@
-import type { Plugin } from "@oxlint/plugins";
-
-import bundledPlugin from "../../dist/effect/index.js";
-
-const plugin: Plugin = bundledPlugin;
-
-export default plugin;

package/src/jsr/recommended.ts

@@ -1,7 +0,0 @@
-import type { OxlintConfig } from "oxlint";
-
-import bundledConfig from "../../dist/configs/recommended.js";
-
-const config: OxlintConfig = bundledConfig;
-
-export default config;

package/src/jsr/upstream-anti-slop.ts

@@ -1,7 +0,0 @@
-import type { Plugin } from "@oxlint/plugins";
-
-import bundledPlugin from "../../dist/upstream/anti-slop.js";
-
-const plugin: Plugin = bundledPlugin;
-
-export default plugin;

package/src/jsr/upstream-effect.ts

@@ -1,7 +0,0 @@
-import type { Plugin } from "@oxlint/plugins";
-
-import bundledPlugin from "../../dist/upstream/effect.js";
-
-const plugin: Plugin = bundledPlugin;
-
-export default plugin;

package/src/upstream/anti-slop.ts

@@ -1 +0,0 @@
-export { default } from "../../vendor/anti-slop/src/index.ts";

package/src/upstream/effect.ts

@@ -1 +0,0 @@
-export { default } from "../../vendor/anti-slop/src/effect/index.ts";