@studiometa/eslint-plugin-js-toolkit 4.0.0-alpha.1 → 4.0.0-alpha.3

package/README.md

@@ -14,6 +14,16 @@ Oxlint/ESLint plugin enforcing best practices for [@studiometa/js-toolkit](https
 npm install --save-dev @studiometa/eslint-plugin-js-toolkit
 ```
 
+## Agent skills
+
+The package ships the `studiometa-eslint-plugin-js-toolkit` [agent skill](https://agentskills.io). The skill teaches coding agents how to use the package, and it matches the installed version. Link the skills of your dependencies into your project with the [`skills` CLI](https://github.com/vercel-labs/skills):
+
+```bash
+npx skills experimental_sync
+```
+
+The command links each skill from `node_modules` into the agent folders (`.agents/skills/`, `.claude/skills/`…). When you update the package, the linked skill updates too.
+
 ## Configuration
 
 ### Oxlint

package/dist/index.d.ts

@@ -1,7 +1,5 @@
-//#region src/index.d.ts
 declare const plugin: import("@oxlint/plugins").Plugin & {
   configs: Record<string, object>;
 };
-//#endregion
 export { plugin as default, plugin as jsToolkit };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,5 +1,5 @@
 import { eslintCompatPlugin } from "@oxlint/plugins";
-//#region src/utils/ast.ts
+// src/utils/ast.ts
 function createRule(rule) {
 	return rule;
 }
@@ -250,8 +250,7 @@ function getProperty(node, name) {
 	}
 	return null;
 }
-//#endregion
-//#region src/rules/require-config.ts
+// src/rules/require-config.ts
 const requireConfig = createRule({
 	meta: {
 		type: "problem",
@@ -289,8 +288,7 @@ function check$9(node, context) {
 		messageId: "missingName"
 	});
 }
-//#endregion
-//#region src/rules/require-config-name-pascal-case.ts
+// src/rules/require-config-name-pascal-case.ts
 const requireConfigNamePascalCase = createRule({
 	meta: {
 		type: "problem",
@@ -324,8 +322,7 @@ function check$8(node, context) {
 		fix: (fixer) => fixer.replaceText(nameProp.value, `'${toPascalCase(nameValue)}'`)
 	});
 }
-//#endregion
-//#region src/rules/refs-camel-case.ts
+// src/rules/refs-camel-case.ts
 const refsCamelCase = createRule({
 	meta: {
 		type: "problem",
@@ -366,8 +363,7 @@ function check$7(node, context) {
 		}
 	}
 }
-//#endregion
-//#region src/rules/options-camel-case.ts
+// src/rules/options-camel-case.ts
 const optionsCamelCase = createRule({
 	meta: {
 		type: "problem",
@@ -408,8 +404,7 @@ function check$6(node, context) {
 		}
 	}
 }
-//#endregion
-//#region src/rules/async-lifecycle-methods.ts
+// src/rules/async-lifecycle-methods.ts
 const asyncLifecycleMethods = createRule({
 	meta: {
 		type: "problem",
@@ -433,8 +428,7 @@ const asyncLifecycleMethods = createRule({
 		} };
 	}
 });
-//#endregion
-//#region src/rules/on-handler-naming.ts
+// src/rules/on-handler-naming.ts
 const ON_HANDLER_RE = /^on[A-Z][a-zA-Z0-9]*$/;
 const onHandlerNaming = createRule({
 	meta: {
@@ -458,8 +452,7 @@ const onHandlerNaming = createRule({
 		} };
 	}
 });
-//#endregion
-//#region src/rules/on-global-handler-prefix.ts
+// src/rules/on-global-handler-prefix.ts
 const GLOBAL_ONLY_EVENTS = /* @__PURE__ */ new Set(["Resize"]);
 const onGlobalHandlerPrefix = createRule({
 	meta: {
@@ -488,8 +481,7 @@ const onGlobalHandlerPrefix = createRule({
 		} };
 	}
 });
-//#endregion
-//#region src/rules/no-deprecated-properties.ts
+// src/rules/no-deprecated-properties.ts
 /** Deprecated in v3, still present at runtime. */
 const V3_DEPRECATED = /* @__PURE__ */ new Map([
 	["$parent", "$closest()"],
@@ -605,8 +597,7 @@ const noDeprecatedProperties = createRule({
 		}
 	}
 });
-//#endregion
-//#region src/rules/no-dispatch-event.ts
+// src/rules/no-dispatch-event.ts
 const noDispatchEvent = createRule({
 	meta: {
 		type: "suggestion",
@@ -626,8 +617,7 @@ const noDispatchEvent = createRule({
 		} };
 	}
 });
-//#endregion
-//#region src/rules/no-shadow-dom.ts
+// src/rules/no-shadow-dom.ts
 const noShadowDom = createRule({
 	meta: {
 		type: "problem",
@@ -647,8 +637,7 @@ const noShadowDom = createRule({
 		} };
 	}
 });
-//#endregion
-//#region src/rules/no-create-app.ts
+// src/rules/no-create-app.ts
 const noCreateApp = createRule({
 	meta: {
 		type: "suggestion",
@@ -665,8 +654,7 @@ const noCreateApp = createRule({
 		} };
 	}
 });
-//#endregion
-//#region src/rules/no-event-listener-methods.ts
+// src/rules/no-event-listener-methods.ts
 const FORBIDDEN = /* @__PURE__ */ new Set(["addEventListener", "removeEventListener"]);
 const noEventListenerMethods = createRule({
 	meta: {
@@ -695,8 +683,7 @@ const noEventListenerMethods = createRule({
 		} };
 	}
 });
-//#endregion
-//#region src/rules/refs-plural-multiple.ts
+// src/rules/refs-plural-multiple.ts
 const refsPluralMultiple = createRule({
 	meta: {
 		type: "problem",
@@ -733,8 +720,7 @@ function check$5(node, context) {
 		});
 	}
 }
-//#endregion
-//#region src/rules/no-deep-utils-import.ts
+// src/rules/no-deep-utils-import.ts
 const UTILS_PREFIX = "@studiometa/js-toolkit/utils/";
 /**
 * A published per-symbol subpath: exactly one segment after `utils/`, and no dot in it.
@@ -768,8 +754,7 @@ const noDeepUtilsImport = createRule({
 		} };
 	}
 });
-//#endregion
-//#region src/rules/no-internal-barrel-import.ts
+// src/rules/no-internal-barrel-import.ts
 /** A relative import of a barrel: `'./utils/index.js'`, `'../Base/index.js'`. */
 const RELATIVE_BARREL_RE = /^\.{1,2}\/.*\/index\.js$/;
 const noInternalBarrelImport = createRule({
@@ -790,8 +775,7 @@ const noInternalBarrelImport = createRule({
 		} };
 	}
 });
-//#endregion
-//#region src/rules/refs-no-bracket-access.ts
+// src/rules/refs-no-bracket-access.ts
 function isThisRefs$1(node) {
 	return node.type === "MemberExpression" && node.object?.type === "ThisExpression" && node.property?.name === "$refs";
 }
@@ -826,8 +810,7 @@ const refsNoBracketAccess = createRule({
 		} };
 	}
 });
-//#endregion
-//#region src/rules/no-redundant-with-mount-when-in-view.ts
+// src/rules/no-redundant-with-mount-when-in-view.ts
 const noRedundantWithMountWhenInView = createRule({
 	meta: {
 		type: "suggestion",
@@ -852,8 +835,7 @@ function check$4(node, context) {
 		messageId: "redundant"
 	});
 }
-//#endregion
-//#region src/rules/prefer-ref-over-query-selector.ts
+// src/rules/prefer-ref-over-query-selector.ts
 const QUERY_METHODS = /* @__PURE__ */ new Set(["querySelector", "querySelectorAll"]);
 function isThisEl(node) {
 	return node.type === "MemberExpression" && node.object?.type === "ThisExpression" && node.property?.name === "$el";
@@ -881,8 +863,7 @@ const preferRefOverQuerySelector = createRule({
 		} };
 	}
 });
-//#endregion
-//#region src/rules/require-refs-declared-in-config.ts
+// src/rules/require-refs-declared-in-config.ts
 function collectDeclaredRefs(classNode) {
 	const configProp = (classNode.body?.body ?? []).find((m) => m.type === "PropertyDefinition" && m.static === true && m.key?.name === "config");
 	if (!configProp?.value || configProp.value.type !== "ObjectExpression") return /* @__PURE__ */ new Set();
@@ -938,8 +919,7 @@ function walkNode$3(node, visit) {
 		else if (child && typeof child === "object" && child.type) walkNode$3(child, visit);
 	}
 }
-//#endregion
-//#region src/rules/no-manual-intersection-observer.ts
+// src/rules/no-manual-intersection-observer.ts
 const noManualIntersectionObserver = createRule({
 	meta: {
 		type: "suggestion",
@@ -958,8 +938,7 @@ const noManualIntersectionObserver = createRule({
 		} };
 	}
 });
-//#endregion
-//#region src/rules/no-manual-mutation-observer.ts
+// src/rules/no-manual-mutation-observer.ts
 const noManualMutationObserver = createRule({
 	meta: {
 		type: "suggestion",
@@ -978,8 +957,7 @@ const noManualMutationObserver = createRule({
 		} };
 	}
 });
-//#endregion
-//#region src/rules/emits-kebab-case.ts
+// src/rules/emits-kebab-case.ts
 /**
 * Returns true if the string is kebab-case:
 * all lowercase letters, digits and hyphens, no underscores or uppercase.
@@ -1032,8 +1010,7 @@ const emitsKebabCase = createRule({
 		};
 	}
 });
-//#endregion
-//#region src/rules/emits-multi-word.ts
+// src/rules/emits-multi-word.ts
 function check$2(node, context) {
 	if (!isBaseSubclass(node, context)) return;
 	const configProp = (node.body?.body ?? []).find((member) => member.type === "PropertyDefinition" && member.static === true && member.key?.name === "config");
@@ -1068,8 +1045,7 @@ const emitsMultiWord = createRule({
 		};
 	}
 });
-//#endregion
-//#region src/rules/components-pascal-case.ts
+// src/rules/components-pascal-case.ts
 function check$1(node, context) {
 	if (!isBaseSubclass(node, context)) return;
 	const configProp = (node.body?.body ?? []).find((member) => member.type === "PropertyDefinition" && member.static === true && member.key?.name === "config");
@@ -1110,8 +1086,7 @@ const componentsPascalCase = createRule({
 		};
 	}
 });
-//#endregion
-//#region src/rules/require-emit-declared-in-config.ts
+// src/rules/require-emit-declared-in-config.ts
 function collectDeclaredEmits(classNode) {
 	const configProp = (classNode.body?.body ?? []).find((m) => m.type === "PropertyDefinition" && m.static === true && m.key?.name === "config");
 	if (!configProp?.value || configProp.value.type !== "ObjectExpression") return /* @__PURE__ */ new Set();
@@ -1163,8 +1138,7 @@ function walkNode$2(node, visit) {
 		else if (child && typeof child === "object" && child.type) walkNode$2(child, visit);
 	}
 }
-//#endregion
-//#region src/rules/require-children-declared-in-config.ts
+// src/rules/require-children-declared-in-config.ts
 function collectDeclaredComponents(classNode) {
 	const configProp = (classNode.body?.body ?? []).find((m) => m.type === "PropertyDefinition" && m.static === true && m.key?.name === "config");
 	if (!configProp?.value || configProp.value.type !== "ObjectExpression") return /* @__PURE__ */ new Set();
@@ -1219,8 +1193,7 @@ function walkNode$1(node, visit) {
 		else if (child && typeof child === "object" && child.type) walkNode$1(child, visit);
 	}
 }
-//#endregion
-//#region src/rules/require-options-declared-in-config.ts
+// src/rules/require-options-declared-in-config.ts
 function collectDeclaredOptions(classNode) {
 	const configProp = (classNode.body?.body ?? []).find((m) => m.type === "PropertyDefinition" && m.static === true && m.key?.name === "config");
 	if (!configProp?.value || configProp.value.type !== "ObjectExpression") return /* @__PURE__ */ new Set();
@@ -1275,8 +1248,7 @@ function walkNode(node, visit) {
 		else if (child && typeof child === "object" && child.type) walkNode(child, visit);
 	}
 }
-//#endregion
-//#region src/rules/prefer-destructured-lookups.ts
+// src/rules/prefer-destructured-lookups.ts
 const TRACKED_PROPERTIES = /* @__PURE__ */ new Set([
 	"$refs",
 	"$options",
@@ -1341,8 +1313,7 @@ const preferDestructuredLookups = createRule({
 		};
 	}
 });
-//#endregion
-//#region src/rules/no-dollar-prefix.ts
+// src/rules/no-dollar-prefix.ts
 const noDollarPrefix = createRule({
 	meta: {
 		type: "problem",
@@ -1373,8 +1344,7 @@ function check(node, context) {
 		});
 	}
 }
-//#endregion
-//#region src/rules/require-destroyed-cleanup.ts
+// src/rules/require-destroyed-cleanup.ts
 const SETUP_CALLS = /* @__PURE__ */ new Set([
 	"setTimeout",
 	"setInterval",
@@ -1447,8 +1417,7 @@ function reportIfNeeded(node, context, classTimers, classHasDestroyed) {
 		data: { calls: [...timers].join(", ") }
 	});
 }
-//#endregion
-//#region src/rules/no-write-in-read-phase.ts
+// src/rules/no-write-in-read-phase.ts
 /**
 * Hooks whose service fans its subscribers out inside `defaultScheduler.read()`.
 *
@@ -1754,8 +1723,7 @@ const noWriteInReadPhase = createRule({
 		};
 	}
 });
-//#endregion
-//#region src/rules/no-options-assignment.ts
+// src/rules/no-options-assignment.ts
 /**
 * Returns true if an expression is `this.$options`, or a path reaching into it.
 */
@@ -1811,8 +1779,7 @@ const noOptionsAssignment = createRule({
 		};
 	}
 });
-//#endregion
-//#region src/rules/prefer-instance-scheduler.ts
+// src/rules/prefer-instance-scheduler.ts
 /** The phases a component owns an instance-scoped equivalent of. */
 const PHASES = /* @__PURE__ */ new Map([["read", "$read"], ["write", "$write"]]);
 const preferInstanceScheduler = createRule({
@@ -1842,8 +1809,7 @@ const preferInstanceScheduler = createRule({
 		} };
 	}
 });
-//#endregion
-//#region src/rules/option-default-factory.ts
+// src/rules/option-default-factory.ts
 const optionDefaultFactory = createRule({
 	meta: {
 		type: "problem",
@@ -1886,8 +1852,7 @@ const optionDefaultFactory = createRule({
 		};
 	}
 });
-//#endregion
-//#region src/rules/no-conflicting-negated-option.ts
+// src/rules/no-conflicting-negated-option.ts
 /**
 * Returns true if an option declaration can hold a boolean, in any of the
 * spellings v4 accepts: the shorthand `Boolean`, a union `[Boolean, String]`,
@@ -1938,8 +1903,7 @@ const noConflictingNegatedOption = createRule({
 		};
 	}
 });
-//#endregion
-//#region src/rules/no-destroy-lifecycle.ts
+// src/rules/no-destroy-lifecycle.ts
 /**
 * v4 renamed `$destroy()` to `$unmount()` and `destroyed()` to `unmounted()`.
 *
@@ -2040,8 +2004,7 @@ const noDestroyLifecycle = createRule({
 		};
 	}
 });
-//#endregion
-//#region src/index.ts
+// src/index.ts
 const PLUGIN_NAME = "js-toolkit";
 const rules = {
 	"require-config": requireConfig,
@@ -2149,7 +2112,6 @@ plugin.configs["v4"] = {
 	plugins: { [PLUGIN_NAME]: plugin },
 	rules: v4Rules
 };
-//#endregion
 export { plugin as default, plugin as jsToolkit };
 
 //# sourceMappingURL=index.js.map