@fedify/lint 2.5.0-dev.2448 → 2.5.0-dev.2494

package/README.md

@@ -9,7 +9,7 @@
 
 *This package is available since Fedify 2.0.0.*
 
-This package provides [Deno Lint], [ESLint], and [Oxlint] plugins with lint
+This package provides [ESLint], [Oxlint], and [Deno Lint] plugins with lint
 rules specifically designed for [Fedify] applications.  It helps you catch
 common mistakes and enforce best practices when building federated server apps
 with Fedify.
@@ -28,31 +28,11 @@ The plugin includes rules that check for:
 [npm]: https://www.npmjs.com/package/@fedify/lint
 [@fedify@hackers.pub badge]: https://fedi-badge.minhee.org/@fedify@hackers.pub/followers.svg
 [@fedify@hackers.pub]: https://hackers.pub/@fedify
-[Deno Lint]: https://docs.deno.com/runtime/reference/lint_plugins/
 [ESLint]: https://eslint.org/
 [Oxlint]: https://oxc.rs/docs/guide/usage/linter/
+[Deno Lint]: https://docs.deno.com/runtime/reference/lint_plugins/
 [Fedify]: https://fedify.dev/
 
-### Deno Lint configuration example
-
-~~~~ typescript
-// deno.json
-
-{
-  "lint": {
-    "plugins": {
-      "@fedify/lint": "jsr:@fedify/lint"
-    },
-    "rules": {
-      "@fedify/lint/actor-id-required": "error",
-      "@fedify/lint/actor-id-mismatch": "error",
-      "@fedify/lint/actor-inbox-property-required": "warn"
-      // ... other rules
-    }
-  }
-}
-~~~~
-
 ### ESLint configuration example
 
 ~~~~ typescript
@@ -78,6 +58,18 @@ export default fedifyLint;
 }
 ~~~~
 
+### Deno Lint configuration example
+
+~~~~ jsonc
+// deno.json
+
+{
+  "lint": {
+    "plugins": ["jsr:@fedify/lint"]
+  }
+}
+~~~~
+
 
 Features
 --------
@@ -179,61 +171,6 @@ bun add -D @fedify/lint
 :::
 
 
-Usage (Deno Lint)
------------------
-
-### Basic setup
-
-Add the plugin to your *deno.json* configuration file:
-
-~~~~ json
-{
-  "lint": {
-    "plugins": ["jsr:@fedify/lint"]
-  }
-}
-~~~~
-
-By default, this enables all recommended rules.
-
-### Custom configuration
-
-You can customize which rules to enable and their severity levels:
-
-~~~~ json
-{
-  "lint": {
-    "plugins": ["jsr:@fedify/lint"],
-    "rules": {
-      "tags": ["recommended"],
-      "include": [
-        "@fedify/lint/actor-id-required",
-        "@fedify/lint/actor-id-mismatch"
-      ],
-      "exclude": [
-        "@fedify/lint/actor-featured-property-required"
-      ]
-    }
-  }
-}
-~~~~
-
-### Running Deno Lint
-
-After setting up the configuration, run Deno's linter:
-
-~~~~ sh
-deno lint
-~~~~
-
-You can also specify which files to lint:
-
-~~~~ sh
-deno lint federation.ts
-deno lint src/federation/
-~~~~
-
-
 Usage (ESLint)
 --------------
 
@@ -314,84 +251,70 @@ export default [{
 ~~~~
 
 
-Example
--------
-
-Here's an example of code that would trigger lint errors:
-
-~~~~ typescript
-// ❌ Wrong: Using relative URL for actor ID
-import { createFederation, Person } from "@fedify/fedify";
+Usage (Oxlint)
+--------------
 
-const federation = createFederation({ /* ... */ });
+[Oxlint] is a fast Rust-based linter that supports ESLint-compatible JS plugins.
+The `@fedify/lint/oxlint` subpath export plugs the Fedify rules into Oxlint's
+[JS plugin API].
 
-federation.setActorDispatcher(
-  "/{identifier}",
-  (_ctx, identifier) => {
-    return new Person({
-      id: new URL(`/${identifier}`),  // ❌ Should use ctx.getActorUri()
-      name: "Example User",
-    });
-  },
-);
-~~~~
+> [!NOTE]
+> Oxlint's JS plugin API is currently in alpha and not subject to semver.
 
-Corrected version:
+[JS plugin API]: https://oxc.rs/docs/guide/usage/linter/writing-js-plugins.html
 
-~~~~ typescript
-// ✅ Correct: Using Context.getActorUri() for actor ID
-import { createFederation, Person } from "@fedify/fedify";
+### Basic setup
 
-const federation = createFederation({ /* ... */ });
+Add the plugin and the rules you want to enable to your *.oxlintrc.json*:
 
-federation.setActorDispatcher(
-  "/{identifier}",
-  (ctx, identifier) => {
-    return new Person({
-      id: ctx.getActorUri(identifier),  // ✅ Correct
-      name: "Example User",
-      inbox: ctx.getInboxUri(identifier),
-      outbox: ctx.getOutboxUri(identifier),
-      followers: ctx.getFollowersUri(identifier),
-      // ... other required properties
-    });
-  },
-);
+~~~~ json
+{
+  "$schema": "https://raw.githubusercontent.com/oxc-project/oxc/main/npm/oxlint/configuration_schema.json",
+  "jsPlugins": ["@fedify/lint/oxlint"],
+  "rules": {
+    "@fedify/lint/actor-id-required": "error",
+    "@fedify/lint/actor-id-mismatch": "error"
+  }
+}
 ~~~~
 
+Rule IDs are namespaced under `@fedify/lint/`, matching the ESLint
+configuration above.
 
-Running the linter
-------------------
-
-### Deno Lint
-
-Run Deno's linter with the plugin enabled:
-
-~~~~ sh
-deno lint
-~~~~
+### Custom configuration
 
-You can also specify which files or directories to lint:
+Enable any subset of the rules listed in the *Features* section above. Each
+rule can be set to `"error"`, `"warn"`, or `"off"`:
 
-~~~~ sh
-deno lint federation.ts
-deno lint src/federation/
+~~~~ json
+{
+  "jsPlugins": ["@fedify/lint/oxlint"],
+  "rules": {
+    "@fedify/lint/actor-id-required": "error",
+    "@fedify/lint/actor-id-mismatch": "error",
+    "@fedify/lint/actor-inbox-property-required": "warn",
+    "@fedify/lint/actor-outbox-property-required": "warn",
+    "@fedify/lint/actor-followers-property-required": "warn",
+    "@fedify/lint/actor-public-key-required": "warn",
+    "@fedify/lint/actor-assertion-method-required": "warn",
+    "@fedify/lint/collection-filtering-not-implemented": "warn"
+  }
+}
 ~~~~
 
-### ESLint
+### Running Oxlint
 
-Set up your ESLint configuration as shown above and add a follwing script on
-`package.json`:
+Add a script to *package.json*:
 
 ~~~~ jsonc
 {
   "scripts": {
-    "lint": "eslint ."
+    "lint": "oxlint ."
   }
 }
 ~~~~
 
-After setting up the configuration, run ESLint on your codebase:
+Then run:
 
 ::: code-group
 
@@ -413,93 +336,150 @@ bun lint
 
 :::
 
-or run the linter directly via command line:
+Or invoke Oxlint directly:
 
 ::: code-group
 
 ~~~~ sh [npm]
-npx eslint .
+npx oxlint .
 ~~~~
 
 ~~~~ sh [pnpm]
-pnpx eslint .
+pnpx oxlint .
 ~~~~
 
 ~~~~ sh [Yarn]
-yarn eslint .
+yarn oxlint .
 ~~~~
 
 ~~~~ sh [Bun]
-bunx eslint .
+bunx oxlint .
 ~~~~
 
 :::
 
 
-Usage (Oxlint)
---------------
-
-[Oxlint] is a fast Rust-based linter that supports ESLint-compatible JS plugins.
-The `@fedify/lint/oxlint` subpath export plugs the Fedify rules into Oxlint's
-[JS plugin API].
-
-> [!NOTE]
-> Oxlint's JS plugin API is currently in alpha and not subject to semver.
-
-[JS plugin API]: https://oxc.rs/docs/guide/usage/linter/writing-js-plugins.html
+Usage (Deno Lint)
+-----------------
 
 ### Basic setup
 
-Add the plugin and the rules you want to enable to your *.oxlintrc.json*:
+Add the plugin to your *deno.json* configuration file:
 
 ~~~~ json
 {
-  "$schema": "https://raw.githubusercontent.com/oxc-project/oxc/main/npm/oxlint/configuration_schema.json",
-  "jsPlugins": ["@fedify/lint/oxlint"],
-  "rules": {
-    "@fedify/lint/actor-id-required": "error",
-    "@fedify/lint/actor-id-mismatch": "error"
+  "lint": {
+    "plugins": ["jsr:@fedify/lint"]
   }
 }
 ~~~~
 
-Rule IDs are namespaced under `@fedify/lint/`, matching the ESLint
-configuration above.
+This enables every rule provided by the plugin. Deno reports plugin rules
+as errors; it does not support a recommended subset or configurable severity
+levels for plugin rules.
 
 ### Custom configuration
 
-Enable any subset of the rules listed in the *Features* section above. Each
-rule can be set to `"error"`, `"warn"`, or `"off"`:
+Disable individual plugin rules through `lint.rules.exclude`, using the
+plugin name `fedify-lint` as the prefix:
 
 ~~~~ json
 {
-  "jsPlugins": ["@fedify/lint/oxlint"],
-  "rules": {
-    "@fedify/lint/actor-id-required": "error",
-    "@fedify/lint/actor-id-mismatch": "error",
-    "@fedify/lint/actor-inbox-property-required": "warn",
-    "@fedify/lint/actor-outbox-property-required": "warn",
-    "@fedify/lint/actor-followers-property-required": "warn",
-    "@fedify/lint/actor-public-key-required": "warn",
-    "@fedify/lint/actor-assertion-method-required": "warn",
-    "@fedify/lint/collection-filtering-not-implemented": "warn"
+  "lint": {
+    "plugins": ["jsr:@fedify/lint"],
+    "rules": {
+      "exclude": [
+        "fedify-lint/actor-featured-property-required"
+      ]
+    }
   }
 }
 ~~~~
 
-### Running Oxlint
+`rules.tags` and `rules.include` apply to Deno's built-in rules, not plugin
+rules. See the [linting manual] for more details.
 
-Add a script to *package.json*:
+[linting manual]: https://fedify.dev/manual/lint#turning-rules-off
+
+### Running Deno Lint
+
+After setting up the configuration, run Deno's linter:
+
+~~~~ sh
+deno lint
+~~~~
+
+You can also specify which files to lint:
+
+~~~~ sh
+deno lint federation.ts
+deno lint src/federation/
+~~~~
+
+
+Example
+-------
+
+Here's an example of code that would trigger lint errors:
+
+~~~~ typescript
+// ❌ Wrong: Using relative URL for actor ID
+import { createFederation, Person } from "@fedify/fedify";
+
+const federation = createFederation({ /* ... */ });
+
+federation.setActorDispatcher(
+  "/{identifier}",
+  (_ctx, identifier) => {
+    return new Person({
+      id: new URL(`/${identifier}`),  // ❌ Should use ctx.getActorUri()
+      name: "Example User",
+    });
+  },
+);
+~~~~
+
+Corrected version:
+
+~~~~ typescript
+// ✅ Correct: Using Context.getActorUri() for actor ID
+import { createFederation, Person } from "@fedify/fedify";
+
+const federation = createFederation({ /* ... */ });
+
+federation.setActorDispatcher(
+  "/{identifier}",
+  (ctx, identifier) => {
+    return new Person({
+      id: ctx.getActorUri(identifier),  // ✅ Correct
+      name: "Example User",
+      inbox: ctx.getInboxUri(identifier),
+      outbox: ctx.getOutboxUri(identifier),
+      followers: ctx.getFollowersUri(identifier),
+      // ... other required properties
+    });
+  },
+);
+~~~~
+
+
+Running the linter
+------------------
+
+### ESLint
+
+Set up your ESLint configuration as shown above and add a follwing script on
+`package.json`:
 
 ~~~~ jsonc
 {
   "scripts": {
-    "lint": "oxlint ."
+    "lint": "eslint ."
   }
 }
 ~~~~
 
-Then run:
+After setting up the configuration, run ESLint on your codebase:
 
 ::: code-group
 
@@ -521,28 +501,43 @@ bun lint
 
 :::
 
-Or invoke Oxlint directly:
+or run the linter directly via command line:
 
 ::: code-group
 
 ~~~~ sh [npm]
-npx oxlint .
+npx eslint .
 ~~~~
 
 ~~~~ sh [pnpm]
-pnpx oxlint .
+pnpx eslint .
 ~~~~
 
 ~~~~ sh [Yarn]
-yarn oxlint .
+yarn eslint .
 ~~~~
 
 ~~~~ sh [Bun]
-bunx oxlint .
+bunx eslint .
 ~~~~
 
 :::
 
+### Deno Lint
+
+Run Deno's linter with the plugin enabled:
+
+~~~~ sh
+deno lint
+~~~~
+
+You can also specify which files or directories to lint:
+
+~~~~ sh
+deno lint federation.ts
+deno lint src/federation/
+~~~~
+
 
 See also
 --------

package/deno.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/lint",
-  "version": "2.5.0-dev.2448+756933d0",
+  "version": "2.5.0-dev.2494+f2e9b5d3",
   "license": "MIT",
   "exports": {
     ".": "./src/mod.ts",

package/dist/index.cjs

@@ -24,7 +24,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 	enumerable: true
 }) : target, mod));
 //#endregion
-const require_outbox_listener_delivery_required = require("./outbox-listener-delivery-required-BXugMxgN.cjs");
+const require_outbox_listener_delivery_required = require("./outbox-listener-delivery-required-8iV7ON-1.cjs");
 let _fxts_core = require("@fxts/core");
 let _typescript_eslint_parser = require("@typescript-eslint/parser");
 _typescript_eslint_parser = __toESM(_typescript_eslint_parser, 1);

package/dist/index.js

@@ -1,4 +1,4 @@
-import { A as name, C as eslint$5, D as eslint$11, E as eslint$10, O as eslint$21, S as eslint$4, T as eslint$13, _ as eslint$15, a as eslint$23, b as eslint$2, c as eslint$16, d as eslint$22, f as eslint$6, g as eslint$14, h as eslint$9, i as eslint$27, j as version, k as RULE_IDS, l as eslint$17, m as eslint$8, n as eslint$25, o as eslint$18, p as eslint$7, r as eslint$26, s as eslint$19, t as eslint$24, u as eslint$20, v as eslint$1, w as eslint$12, x as eslint$3, y as eslint } from "./outbox-listener-delivery-required-D1aEvkJ_.js";
+import { A as name, C as eslint$5, D as eslint$11, E as eslint$10, O as eslint$21, S as eslint$4, T as eslint$13, _ as eslint$15, a as eslint$23, b as eslint$2, c as eslint$16, d as eslint$22, f as eslint$6, g as eslint$14, h as eslint$9, i as eslint$27, j as version, k as RULE_IDS, l as eslint$17, m as eslint$8, n as eslint$25, o as eslint$18, p as eslint$7, r as eslint$26, s as eslint$19, t as eslint$24, u as eslint$20, v as eslint$1, w as eslint$12, x as eslint$3, y as eslint } from "./outbox-listener-delivery-required-0GyaFx8t.js";
 import { fromEntries, keys, map, pipe } from "@fxts/core";
 import parser from "@typescript-eslint/parser";
 //#region src/index.ts

package/dist/{outbox-listener-delivery-required-D1aEvkJ_.js → outbox-listener-delivery-required-0GyaFx8t.js}

@@ -1,7 +1,7 @@
 import { always, every, head, isEmpty, isObject, negate, pipe, pipeLazy, prop, some, toArray, unless, when } from "@fxts/core";
 //#region deno.json
 var name = "@fedify/lint";
-var version = "2.5.0-dev.2448+756933d0";
+var version = "2.5.0-dev.2494+f2e9b5d3";
 //#endregion
 //#region src/lib/const.ts
 /**

package/dist/{outbox-listener-delivery-required-BXugMxgN.cjs → outbox-listener-delivery-required-8iV7ON-1.cjs}

@@ -1,7 +1,7 @@
 let _fxts_core = require("@fxts/core");
 //#region deno.json
 var name = "@fedify/lint";
-var version = "2.5.0-dev.2448+756933d0";
+var version = "2.5.0-dev.2494+f2e9b5d3";
 //#endregion
 //#region src/lib/const.ts
 /**

package/dist/oxlint.cjs

@@ -1,4 +1,4 @@
-const require_outbox_listener_delivery_required = require("./outbox-listener-delivery-required-BXugMxgN.cjs");
+const require_outbox_listener_delivery_required = require("./outbox-listener-delivery-required-8iV7ON-1.cjs");
 //#region src/oxlint.ts
 const rules = {
 	[require_outbox_listener_delivery_required.RULE_IDS.actorIdMismatch]: require_outbox_listener_delivery_required.eslint$18,

package/dist/oxlint.js

@@ -1,4 +1,4 @@
-import { A as name, C as eslint$5, D as eslint$11, E as eslint$10, O as eslint$21, S as eslint$4, T as eslint$13, _ as eslint$15, a as eslint$23, b as eslint$2, c as eslint$16, d as eslint$22, f as eslint$6, g as eslint$14, h as eslint$9, i as eslint$27, j as version, k as RULE_IDS, l as eslint$17, m as eslint$8, n as eslint$25, o as eslint$18, p as eslint$7, r as eslint$26, s as eslint$19, t as eslint$24, u as eslint$20, v as eslint$1, w as eslint$12, x as eslint$3, y as eslint } from "./outbox-listener-delivery-required-D1aEvkJ_.js";
+import { A as name, C as eslint$5, D as eslint$11, E as eslint$10, O as eslint$21, S as eslint$4, T as eslint$13, _ as eslint$15, a as eslint$23, b as eslint$2, c as eslint$16, d as eslint$22, f as eslint$6, g as eslint$14, h as eslint$9, i as eslint$27, j as version, k as RULE_IDS, l as eslint$17, m as eslint$8, n as eslint$25, o as eslint$18, p as eslint$7, r as eslint$26, s as eslint$19, t as eslint$24, u as eslint$20, v as eslint$1, w as eslint$12, x as eslint$3, y as eslint } from "./outbox-listener-delivery-required-0GyaFx8t.js";
 //#region src/oxlint.ts
 const rules = {
 	[RULE_IDS.actorIdMismatch]: eslint,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/lint",
-  "version": "2.5.0-dev.2448+756933d0",
+  "version": "2.5.0-dev.2494+f2e9b5d3",
   "description": "Fedify linting rules and plugins",
   "keywords": [
     "Fedify",
@@ -51,7 +51,7 @@
   ],
   "peerDependencies": {
     "eslint": ">=9.0.0",
-    "@fedify/fedify": "^2.5.0-dev.2448+756933d0"
+    "@fedify/fedify": "^2.5.0-dev.2494+f2e9b5d3"
   },
   "peerDependenciesMeta": {
     "eslint": {
@@ -71,7 +71,7 @@
     "tsdown": "^0.22.0",
     "typescript": "^6.0.0",
     "@fedify/fixture": "2.0.0",
-    "@fedify/vocab": "2.5.0-dev.2448+756933d0"
+    "@fedify/vocab": "2.5.0-dev.2494+f2e9b5d3"
   },
   "scripts": {
     "build:self": "tsdown",