eslint-plugin-harlanzw 0.14.2 → 0.15.0

package/README.md

@@ -50,6 +50,7 @@ The rules are organized into the following categories:
 | [`nuxt-no-redundant-import-meta`](./src/rules/nuxt-no-redundant-import-meta.md) | disallow redundant `import.meta.server` or `import.meta.client` checks in scoped components |
 | [`nuxt-no-side-effects-in-async-data-handler`](./src/rules/nuxt-no-side-effects-in-async-data-handler.md) | disallow side effects in async data handlers |
 | [`nuxt-no-side-effects-in-setup`](./src/rules/nuxt-no-side-effects-in-setup.md) | disallow side effects in setup functions |
+| [`nuxt-prefer-layer-alias`](./src/rules/nuxt-prefer-layer-alias.ts) | prefer `#layers/<name>` alias over `~~/layers/<name>` paths |
 | [`nuxt-prefer-navigate-to-over-router-push-replace`](./src/rules/nuxt-prefer-navigate-to-over-router-push-replace.md) | prefer `navigateTo()` over `router.push()` or `router.replace()` |
 | [`nuxt-prefer-nuxt-link-over-router-link`](./src/rules/nuxt-prefer-nuxt-link-over-router-link.md) | prefer `NuxtLink` over `RouterLink` |
 | [`nuxt-ui-prefer-shorthand-css`](./src/rules/nuxt-ui-prefer-shorthand-css.ts) | prefer Nuxt UI shorthand CSS classes over verbose `var()` syntax |

package/dist/index.mjs

@@ -4,7 +4,7 @@ import process from 'node:process';
 import { TextSourceCodeBase, ConfigCommentParser, Directive, VisitNodeStep } from '@eslint/plugin-kit';
 import { AST_NODE_TYPES } from '@typescript-eslint/utils';
 
-const version = "0.14.2";
+const version = "0.15.0";
 
 const STRENGTH_PATTERNS = {
   strong: ["never", "must", "always", "under no circumstances", "absolutely", "required", "mandatory", "forbidden", "prohibited"],
@@ -3793,9 +3793,9 @@ function createReactivityChecker(vueImports, nonVueImports, options = {}) {
 
 const REGEX_2$4 = /[^\u0020-\u007F]/;
 const REGEX_1$6 = /[^\u0020-\u007F]/;
-const RULE_NAME$t = "link-ascii-only";
+const RULE_NAME$u = "link-ascii-only";
 const linkAsciiOnly = createEslintRule({
-  name: RULE_NAME$t,
+  name: RULE_NAME$u,
   meta: {
     type: "suggestion",
     docs: {
@@ -3871,9 +3871,9 @@ const REGEX_4$1 = /[A-Z]/;
 const REGEX_3$2 = /%[0-9A-F]{2}/i;
 const REGEX_2$3 = /[A-Z]/;
 const REGEX_1$5 = /%[0-9A-F]{2}/i;
-const RULE_NAME$s = "link-lowercase";
+const RULE_NAME$t = "link-lowercase";
 const linkLowercase = createEslintRule({
-  name: RULE_NAME$s,
+  name: RULE_NAME$t,
   meta: {
     type: "suggestion",
     docs: {
@@ -3952,7 +3952,7 @@ const linkLowercase = createEslintRule({
 const REGEX_3$1 = /\/+/g;
 const REGEX_2$2 = /\/{2,}/;
 const REGEX_1$4 = /\/{2,}/;
-const RULE_NAME$r = "link-no-double-slashes";
+const RULE_NAME$s = "link-no-double-slashes";
 function fixDoubleSlashesInUrl(url) {
   if (url.startsWith("//") || url.includes("://"))
     return url;
@@ -3972,7 +3972,7 @@ function fixDoubleSlashesInUrl(url) {
   return `${path.replace(REGEX_3$1, "/")}${search}${hash}`;
 }
 const linkNoDoubleSlashes = createEslintRule({
-  name: RULE_NAME$r,
+  name: RULE_NAME$s,
   meta: {
     type: "problem",
     docs: {
@@ -4048,9 +4048,9 @@ const linkNoDoubleSlashes = createEslintRule({
   }
 });
 
-const RULE_NAME$q = "link-no-underscores";
+const RULE_NAME$r = "link-no-underscores";
 const linkNoUnderscores = createEslintRule({
-  name: RULE_NAME$q,
+  name: RULE_NAME$r,
   meta: {
     type: "suggestion",
     docs: {
@@ -4128,9 +4128,9 @@ const REGEX_4 = /\s/;
 const REGEX_3 = /\s/g;
 const REGEX_2$1 = /\s/;
 const REGEX_1$3 = /\s/g;
-const RULE_NAME$p = "link-no-whitespace";
+const RULE_NAME$q = "link-no-whitespace";
 const linkNoWhitespace = createEslintRule({
-  name: RULE_NAME$p,
+  name: RULE_NAME$q,
   meta: {
     type: "suggestion",
     docs: {
@@ -4204,7 +4204,7 @@ const linkNoWhitespace = createEslintRule({
   }
 });
 
-const RULE_NAME$o = "link-require-descriptive-text";
+const RULE_NAME$p = "link-require-descriptive-text";
 const BAD_LINK_TEXTS = /* @__PURE__ */ new Set([
   "click here",
   "click this",
@@ -4250,7 +4250,7 @@ function getVueLinkUrl(node) {
   return null;
 }
 const linkRequireDescriptiveText = createEslintRule({
-  name: RULE_NAME$o,
+  name: RULE_NAME$p,
   meta: {
     type: "suggestion",
     docs: {
@@ -4326,9 +4326,9 @@ const linkRequireDescriptiveText = createEslintRule({
   }
 });
 
-const RULE_NAME$n = "link-require-href";
+const RULE_NAME$o = "link-require-href";
 const linkRequireHref = createEslintRule({
-  name: RULE_NAME$n,
+  name: RULE_NAME$o,
   meta: {
     type: "problem",
     docs: {
@@ -4396,12 +4396,12 @@ const linkRequireHref = createEslintRule({
   }
 });
 
-const RULE_NAME$m = "link-trailing-slash";
+const RULE_NAME$n = "link-trailing-slash";
 function shouldSkipUrl(url) {
   return url.startsWith("#") || url.includes(":") || url === "/" || url === "";
 }
 const linkTrailingSlash = createEslintRule({
-  name: RULE_NAME$m,
+  name: RULE_NAME$n,
   meta: {
     type: "suggestion",
     docs: {
@@ -4516,7 +4516,7 @@ const linkTrailingSlash = createEslintRule({
   }
 });
 
-const RULE_NAME$l = "no-silent-catch";
+const RULE_NAME$m = "no-silent-catch";
 function isEmptyOrVoid(node) {
   if (node.type === "ArrowFunctionExpression") {
     if (node.body.type === "BlockStatement" && node.body.body.length === 0)
@@ -4536,7 +4536,7 @@ function hasOnlyComments(node, sourceCode) {
   return node.body.length === 0 && sourceCode.getCommentsInside(node).length > 0;
 }
 const noSilentCatch = createEslintRule({
-  name: RULE_NAME$l,
+  name: RULE_NAME$m,
   meta: {
     type: "problem",
     docs: {
@@ -4574,9 +4574,9 @@ const noSilentCatch = createEslintRule({
   }
 });
 
-const RULE_NAME$k = "nuxt-await-navigate-to";
+const RULE_NAME$l = "nuxt-await-navigate-to";
 const nuxtAwaitNavigateTo = createEslintRule({
-  name: RULE_NAME$k,
+  name: RULE_NAME$l,
   meta: {
     type: "problem",
     docs: {
@@ -4732,7 +4732,7 @@ function isInConsequentBranch(node, ternary) {
   return false;
 }
 
-const RULE_NAME$j = "nuxt-no-random";
+const RULE_NAME$k = "nuxt-no-random";
 function isMathRandomCall(node) {
   return node.callee.type === "MemberExpression" && node.callee.object.type === "Identifier" && node.callee.object.name === "Math" && node.callee.property.type === "Identifier" && node.callee.property.name === "random";
 }
@@ -4763,7 +4763,7 @@ function reportRandom(context, node, template) {
   }
 }
 const nuxtNoRandom = createEslintRule({
-  name: RULE_NAME$j,
+  name: RULE_NAME$k,
   meta: {
     type: "problem",
     docs: {
@@ -4802,9 +4802,9 @@ const nuxtNoRandom = createEslintRule({
   }
 });
 
-const RULE_NAME$i = "nuxt-no-redundant-import-meta";
+const RULE_NAME$j = "nuxt-no-redundant-import-meta";
 const nuxtNoRedundantImportMeta = createEslintRule({
-  name: RULE_NAME$i,
+  name: RULE_NAME$j,
   meta: {
     type: "problem",
     docs: {
@@ -4842,7 +4842,7 @@ const nuxtNoRedundantImportMeta = createEslintRule({
 });
 
 const REGEX_1$2 = /\n\s*\n\s*\n/g;
-const RULE_NAME$h = "nuxt-no-side-effects-in-async-data-handler";
+const RULE_NAME$i = "nuxt-no-side-effects-in-async-data-handler";
 const SIDE_EFFECT_PATTERNS = /* @__PURE__ */ new Set([
   // Store/State mutations ($ prefix makes these unambiguous)
   "$patch",
@@ -4952,7 +4952,7 @@ function findSideEffectsInFunction(functionNode) {
   return sideEffects;
 }
 const nuxtNoSideEffectsInAsyncDataHandler = createEslintRule({
-  name: RULE_NAME$h,
+  name: RULE_NAME$i,
   meta: {
     type: "problem",
     docs: {
@@ -5043,9 +5043,9 @@ ${indent}${callOnceBlock}`)
   }
 });
 
-const RULE_NAME$g = "nuxt-no-side-effects-in-setup";
+const RULE_NAME$h = "nuxt-no-side-effects-in-setup";
 const nuxtNoSideEffectsInSetup = createEslintRule({
-  name: RULE_NAME$g,
+  name: RULE_NAME$h,
   meta: {
     type: "problem",
     docs: {
@@ -5136,7 +5136,7 @@ ${indent}})`;
   }
 });
 
-const RULE_NAME$f = "nuxt-no-unsafe-date";
+const RULE_NAME$g = "nuxt-no-unsafe-date";
 function isDateNowCall(node) {
   return node.callee.type === "MemberExpression" && node.callee.object.type === "Identifier" && node.callee.object.name === "Date" && node.callee.property.type === "Identifier" && node.callee.property.name === "now";
 }
@@ -5167,7 +5167,7 @@ function isChainedWithStableMethod(node) {
   return grandparent?.type === "CallExpression" && grandparent.callee === parent;
 }
 const nuxtNoUnsafeDate = createEslintRule({
-  name: RULE_NAME$f,
+  name: RULE_NAME$g,
   meta: {
     type: "problem",
     docs: {
@@ -5231,6 +5231,62 @@ const nuxtNoUnsafeDate = createEslintRule({
   }
 });
 
+const RULE_NAME$f = "nuxt-prefer-layer-alias";
+const LAYER_PATH_RE = /^(?:~~|@@|~|@)\/layers\/([^/]+)\/(.+)$/;
+const nuxtPreferLayerAlias = createEslintRule({
+  name: RULE_NAME$f,
+  meta: {
+    type: "suggestion",
+    docs: {
+      description: "prefer Nuxt #layers/<name> alias over ~~/layers/<name> paths"
+    },
+    fixable: "code",
+    schema: [],
+    messages: {
+      preferLayerAlias: "Prefer Nuxt layer alias '{{replacement}}' over '{{original}}'"
+    }
+  },
+  defaultOptions: [],
+  create: (context) => {
+    function check(node, valueNode) {
+      if (!valueNode || valueNode.type !== "Literal" || typeof valueNode.value !== "string")
+        return;
+      const original = valueNode.value;
+      const match = original.match(LAYER_PATH_RE);
+      if (!match)
+        return;
+      const [, layer, rest] = match;
+      const replacement = `#layers/${layer}/${rest}`;
+      context.report({
+        node: valueNode,
+        messageId: "preferLayerAlias",
+        data: { original, replacement },
+        fix(fixer) {
+          const raw = valueNode.raw ?? `'${original}'`;
+          const quote = raw[0] === '"' ? '"' : "'";
+          return fixer.replaceText(valueNode, `${quote}${replacement}${quote}`);
+        }
+      });
+    }
+    return {
+      ImportDeclaration(node) {
+        check(node, node.source);
+      },
+      ExportNamedDeclaration(node) {
+        if (node.source)
+          check(node, node.source);
+      },
+      ExportAllDeclaration(node) {
+        if (node.source)
+          check(node, node.source);
+      },
+      ImportExpression(node) {
+        check(node, node.source);
+      }
+    };
+  }
+});
+
 const RULE_NAME$e = "nuxt-prefer-navigate-to-over-router-push-replace";
 const nuxtPreferNavigateToOverRouterPushReplace = createEslintRule({
   name: RULE_NAME$e,
@@ -6867,6 +6923,7 @@ const plugin = {
     "nuxt-no-side-effects-in-async-data-handler": nuxtNoSideEffectsInAsyncDataHandler,
     "nuxt-no-side-effects-in-setup": nuxtNoSideEffectsInSetup,
     "nuxt-no-unsafe-date": nuxtNoUnsafeDate,
+    "nuxt-prefer-layer-alias": nuxtPreferLayerAlias,
     "nuxt-prefer-navigate-to-over-router-push-replace": nuxtPreferNavigateToOverRouterPushReplace,
     "nuxt-prefer-nuxt-link-over-router-link": nuxtPreferNuxtLinkOverRouterLink,
     "nuxt-ui-prefer-shorthand-css": nuxtUiPreferShorthandCss,
@@ -7043,6 +7100,7 @@ plugin.configs.nuxt = [
       "harlanzw/nuxt-no-side-effects-in-async-data-handler": "error",
       "harlanzw/nuxt-no-side-effects-in-setup": "error",
       "harlanzw/nuxt-no-unsafe-date": "warn",
+      "harlanzw/nuxt-prefer-layer-alias": "warn",
       "harlanzw/nuxt-prefer-navigate-to-over-router-push-replace": "warn",
       "harlanzw/nuxt-prefer-nuxt-link-over-router-link": "warn",
       "harlanzw/nuxt-ui-prefer-shorthand-css": "warn",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eslint-plugin-harlanzw",
   "type": "module",
-  "version": "0.14.2",
+  "version": "0.15.0",
   "description": "Harlan's opinionated ESLint rules",
   "author": "Harlan Wilton <harlan@harlanzw.com>",
   "license": "MIT",