@arcgis/eslint-config 5.0.0-next.98 → 5.0.0

package/LICENSE.md

@@ -4,10 +4,14 @@ COPYRIGHT © Esri
 
 All rights reserved under the copyright laws of the United States and applicable international laws, treaties, and conventions.
 
-This material is licensed for use under the Esri Master License Agreement (MLA), and is bound by the terms of that agreement. You may redistribute and use this code without modification, provided you adhere to the terms of the MLA and include this copyright notice.
+This material is licensed for use under the [Esri Master License Agreement (MLA)](https://www.esri.com/content/dam/esrisites/en-us/media/legal/ma-full/ma-full.pdf), and is bound by the terms of that agreement.
+You may redistribute and use this code without modification, provided you adhere to the terms of the MLA and include this copyright notice.
 
-See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
+For additional information, contact:
+Environmental Systems Research Institute, Inc.
+Attn: Contracts and Legal Services Department
+380 New York Street
+Redlands, California, USA 92373
+USA
 
-For additional information, contact: Environmental Systems Research Institute, Inc. Attn: Contracts and Legal Services Department 380 New York Street Redlands, California, USA 92373 USA
-
-email: contracts@esri.com
+email: legal@esri.com

package/README.md

@@ -8,6 +8,5 @@ It is not intended to be used directly, but rather used as a dependency by other
 
 ## License
 
-COPYRIGHT © Esri
-
-This package is licensed under the terms described in the `LICENSE.md` file, located in the root of the package.
+This package is licensed under the terms described in the `LICENSE.md` file, located in the root of the package, and at https://js.arcgis.com/5.0/LICENSE.txt.
+For third party notices, see https://js.arcgis.com/5.0/third-party-notices.txt.

package/dist/config/index.js

@@ -5,6 +5,10 @@ import globals from "globals";
 import { webgisPlugin } from "../plugins/webgis/index.js";
 import { globalIgnores } from "eslint/config";
 import markdown from "@eslint/markdown";
+import packageJson from "eslint-plugin-package-json";
+const packageJsonSortableCollections = packageJson.rules["sort-collections"].meta.defaultOptions[0].filter(
+  (collection) => !["scripts", "exports"].includes(collection)
+) ?? [];
 const defaultConfig = [
   globalIgnores(["**/www", "**/dist", "**/assets", "**/coverage", "**/.docs"]),
   {
@@ -280,7 +284,7 @@ const defaultConfig = [
       "no-loss-of-precision": "error",
       "@typescript-eslint/switch-exhaustiveness-check": "error",
       "default-case-last": "error",
-      "func-style": ["error", "declaration", { allowArrowFunctions: true }],
+      "func-style": ["error", "declaration", { allowArrowFunctions: true, allowTypeAnnotation: true }],
       "no-new-func": "error",
       "no-new-wrappers": "error",
       "@typescript-eslint/no-misused-promises": [
@@ -570,6 +574,52 @@ const defaultConfig = [
     // Don't do type-aware linting for untyped files
     files: ["**/*.js"],
     ...tsEslint.configs.disableTypeChecked
+  },
+  packageJson.configs.recommended,
+  {
+    files: ["**/package.json"],
+    rules: {
+      // We don't want to sort scripts and exports
+      "package-json/sort-collections": ["warn", packageJsonSortableCollections],
+      // Making a warning for now to avoid disrupting current work but we should go to error later
+      "package-json/require-description": "warn",
+      "package-json/bin-name-casing": "warn",
+      // Allow empty "files" field to explicitly indicate that no files
+      // should be included in the package
+      "package-json/no-empty-fields": ["error", { ignoreProperties: ["files"] }],
+      // Enforce a specific property order for better readability and consistency
+      "package-json/order-properties": [
+        "warn",
+        {
+          order: [
+            "name",
+            "version",
+            "description",
+            "keywords",
+            "homepage",
+            "private",
+            "sideEffects",
+            "workspaces",
+            "type",
+            "main",
+            "module",
+            "types",
+            "exports",
+            "files",
+            "bin",
+            "publishConfig",
+            "license",
+            "scripts",
+            "acme:scripts",
+            "dependencies",
+            "devDependencies",
+            "peerDependencies",
+            "peerDependenciesMeta",
+            "packageManager"
+          ]
+        }
+      ]
+    }
   }
 ];
 export {

package/dist/estree-Can6TC4w.js

@@ -0,0 +1,159 @@
+import { ESLintUtils, AST_NODE_TYPES } from "@typescript-eslint/utils";
+const version = "5.0.0";
+const packageJson = {
+  version
+};
+function makeEslintPlugin(pluginName, urlCreator) {
+  const rules = [];
+  const creator = ESLintUtils.RuleCreator(urlCreator);
+  return {
+    // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+    createRule(rule) {
+      const { meta, name, ...rest } = rule;
+      const docs = { ...meta.docs, name };
+      const ruleModule = creator({ ...rest, meta: { ...meta, docs }, name });
+      rules.push(ruleModule);
+      return ruleModule;
+    },
+    // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+    finalize() {
+      const config = {
+        rules: Object.fromEntries(
+          rules.map((rule) => [`${pluginName}/${rule.meta.docs.name}`, rule.meta.docs.defaultLevel])
+        )
+      };
+      const plugin = {
+        meta: { name: `@arcgis/eslint-plugin-${pluginName}`, version: packageJson.version },
+        configs: {
+          recommended: config
+        },
+        rules: Object.fromEntries(rules.map((rule) => [rule.meta.docs.name, rule]))
+      };
+      config.plugins = {
+        [pluginName]: plugin
+      };
+      return plugin;
+    }
+  };
+}
+const unwrapExpression = (expression) => expression.type === AST_NODE_TYPES.TSAsExpression || expression.type === AST_NODE_TYPES.TSNonNullExpression || expression.type === AST_NODE_TYPES.TSSatisfiesExpression ? unwrapExpression(expression.expression) : expression;
+const luminaEntrypointName = "@arcgis/lumina";
+const luminaTestEntrypointName = "@arcgis/lumina-compiler/testing";
+const luminaJsxExportName = "h";
+function checkForLuminaJsx() {
+  const ImportDeclaration = (node) => {
+    if (node.source.value !== luminaEntrypointName) {
+      return;
+    }
+    for (const specifier of node.specifiers) {
+      if (specifier.type === AST_NODE_TYPES.ImportSpecifier && (specifier.imported.type === AST_NODE_TYPES.Identifier && specifier.imported.name === luminaJsxExportName || specifier.imported.type === AST_NODE_TYPES.Literal && specifier.imported.value === luminaJsxExportName)) {
+        withProperty.isLuminaJsx = true;
+        return;
+      }
+    }
+  };
+  const withProperty = ImportDeclaration;
+  return withProperty;
+}
+function hasDecorator(node, decoratorName) {
+  return node.decorators.some(
+    (decorator) => decorator.expression.type === AST_NODE_TYPES.CallExpression && decorator.expression.callee.type === AST_NODE_TYPES.Identifier && decorator.expression.callee.name === decoratorName
+  ) ?? false;
+}
+function extractDeclareElementsInterface(node) {
+  return node.kind === "global" ? node.body.body.find(
+    (node2) => node2.type === AST_NODE_TYPES.TSInterfaceDeclaration && node2.id.name === "DeclareElements"
+  ) : void 0;
+}
+function getComponentDeclaration(node) {
+  for (const member of node.body.body) {
+    if (member.type !== AST_NODE_TYPES.TSPropertySignature) {
+      continue;
+    }
+    const type = member.typeAnnotation?.typeAnnotation;
+    if (type?.type !== AST_NODE_TYPES.TSTypeReference || type.typeName.type !== AST_NODE_TYPES.Identifier) {
+      continue;
+    }
+    if (member.key.type !== AST_NODE_TYPES.Literal) {
+      continue;
+    }
+    return member;
+  }
+  return;
+}
+function isCreateEvent(node) {
+  return node.value?.type === AST_NODE_TYPES.CallExpression && node.value.callee.type === AST_NODE_TYPES.Identifier && node.value.callee.name === "createEvent" && !node.static;
+}
+const getProperty = (properties, name) => properties?.find(
+  (option) => option.type === AST_NODE_TYPES.Property && option.key.type === AST_NODE_TYPES.Identifier && option.key.name === name
+)?.value;
+function isGetterWithoutSetter(node) {
+  const isGetter = node.type === AST_NODE_TYPES.MethodDefinition && node.kind === "get";
+  if (!isGetter) {
+    return false;
+  }
+  const index = node.parent.body.indexOf(node);
+  const previousNode = node.parent.body.at(index - 1);
+  const nextNode = node.parent.body.at(index + 1);
+  const name = getName(node);
+  if (name === void 0) {
+    return false;
+  }
+  const previousIsSetter = previousNode?.type === AST_NODE_TYPES.MethodDefinition && previousNode.kind === "set" && getName(previousNode) === name;
+  if (previousIsSetter) {
+    return false;
+  }
+  const nextIsSetter = nextNode?.type === AST_NODE_TYPES.MethodDefinition && nextNode.kind === "set" && getName(nextNode) === name;
+  return !nextIsSetter;
+}
+function getName(node) {
+  if (node.key.type === AST_NODE_TYPES.Identifier) {
+    return node.key.name;
+  } else if (node.key.type === AST_NODE_TYPES.Literal && typeof node.key.value === "string") {
+    return node.key.value;
+  } else {
+    return void 0;
+  }
+}
+function parsePropertyDecorator(decorator) {
+  const isPropertyDecorator = decorator.expression.type === AST_NODE_TYPES.CallExpression && decorator.expression.callee.type === AST_NODE_TYPES.Identifier && decorator.expression.callee.name === "property";
+  if (!isPropertyDecorator) {
+    return;
+  }
+  const callExpression = decorator?.expression.type === AST_NODE_TYPES.CallExpression ? decorator.expression : void 0;
+  if (callExpression === void 0) {
+    return;
+  }
+  const options = callExpression.arguments[0]?.type === AST_NODE_TYPES.ObjectExpression ? callExpression.arguments[0] : void 0;
+  const properties = options?.properties;
+  return {
+    callExpression,
+    options,
+    properties
+  };
+}
+function isBindThisCallee(callee) {
+  return callee.type === AST_NODE_TYPES.MemberExpression && // expression.identifier(this)
+  callee.property.type === AST_NODE_TYPES.Identifier && // expression.bind(this)
+  callee.property.name === "bind" && // expression.expression.bind(this)
+  callee.object.type === AST_NODE_TYPES.MemberExpression && // expression.identifier.bind(this)
+  callee.object.property.type === AST_NODE_TYPES.Identifier && // this.identifier.bind(this)
+  callee.object.object.type === AST_NODE_TYPES.ThisExpression;
+}
+export {
+  luminaEntrypointName as a,
+  luminaTestEntrypointName as b,
+  getProperty as c,
+  checkForLuminaJsx as d,
+  extractDeclareElementsInterface as e,
+  isCreateEvent as f,
+  getComponentDeclaration as g,
+  hasDecorator as h,
+  isGetterWithoutSetter as i,
+  getName as j,
+  isBindThisCallee as k,
+  luminaJsxExportName as l,
+  makeEslintPlugin as m,
+  parsePropertyDecorator as p,
+  unwrapExpression as u
+};

package/dist/plugins/lumina/index.js

@@ -1,4 +1,4 @@
-import { m as makeEslintPlugin } from "../../makePlugin-DvrrzfxD.js";
+import { m as makeEslintPlugin, l as luminaJsxExportName, a as luminaEntrypointName, b as luminaTestEntrypointName, p as parsePropertyDecorator, c as getProperty, i as isGetterWithoutSetter, d as checkForLuminaJsx, e as extractDeclareElementsInterface, f as isCreateEvent, h as hasDecorator, j as getName, k as isBindThisCallee, g as getComponentDeclaration, u as unwrapExpression } from "../../estree-Can6TC4w.js";
 import { AST_NODE_TYPES, ESLintUtils, AST_TOKEN_TYPES } from "@typescript-eslint/utils";
 import ts from "typescript";
 import { camelToKebab } from "@arcgis/toolkit/string";
@@ -6,94 +6,6 @@ const plugin = makeEslintPlugin(
   "lumina",
   (rule) => `https://devtopia.esri.com/WebGIS/arcgis-web-components/tree/main/packages/support-packages/eslint-config/src/plugins/lumina/rules/${rule}.ts`
 );
-const unwrapExpression = (expression) => expression.type === AST_NODE_TYPES.TSAsExpression || expression.type === AST_NODE_TYPES.TSNonNullExpression || expression.type === AST_NODE_TYPES.TSSatisfiesExpression ? unwrapExpression(expression.expression) : expression;
-const luminaEntrypointName = "@arcgis/lumina";
-const luminaTestEntrypointName = "@arcgis/lumina-compiler/testing";
-const luminaJsxExportName = "h";
-function checkForLuminaJsx() {
-  const ImportDeclaration = (node) => {
-    if (node.source.value !== luminaEntrypointName) {
-      return;
-    }
-    for (const specifier of node.specifiers) {
-      if (specifier.type === AST_NODE_TYPES.ImportSpecifier && (specifier.imported.type === AST_NODE_TYPES.Identifier && specifier.imported.name === luminaJsxExportName || specifier.imported.type === AST_NODE_TYPES.Literal && specifier.imported.value === luminaJsxExportName)) {
-        withProperty.isLuminaJsx = true;
-        return;
-      }
-    }
-  };
-  const withProperty = ImportDeclaration;
-  return withProperty;
-}
-function hasDecorator(node, decoratorName) {
-  return node.decorators.some(
-    (decorator) => decorator.expression.type === AST_NODE_TYPES.CallExpression && decorator.expression.callee.type === AST_NODE_TYPES.Identifier && decorator.expression.callee.name === decoratorName
-  ) ?? false;
-}
-function extractDeclareElementsInterface(node) {
-  return node.kind === "global" ? node.body.body.find(
-    (node2) => node2.type === AST_NODE_TYPES.TSInterfaceDeclaration && node2.id.name === "DeclareElements"
-  ) : void 0;
-}
-function isCreateEvent(node) {
-  return node.value?.type === AST_NODE_TYPES.CallExpression && node.value.callee.type === AST_NODE_TYPES.Identifier && node.value.callee.name === "createEvent" && !node.static;
-}
-const getProperty = (properties, name) => properties?.find(
-  (option) => option.type === AST_NODE_TYPES.Property && option.key.type === AST_NODE_TYPES.Identifier && option.key.name === name
-)?.value;
-function isGetterWithoutSetter(node) {
-  const isGetter = node.type === AST_NODE_TYPES.MethodDefinition && node.kind === "get";
-  if (!isGetter) {
-    return false;
-  }
-  const index = node.parent.body.indexOf(node);
-  const previousNode = node.parent.body.at(index - 1);
-  const nextNode = node.parent.body.at(index + 1);
-  const name = getName(node);
-  if (name === void 0) {
-    return false;
-  }
-  const previousIsSetter = previousNode?.type === AST_NODE_TYPES.MethodDefinition && previousNode.kind === "set" && getName(previousNode) === name;
-  if (previousIsSetter) {
-    return false;
-  }
-  const nextIsSetter = nextNode?.type === AST_NODE_TYPES.MethodDefinition && nextNode.kind === "set" && getName(nextNode) === name;
-  return !nextIsSetter;
-}
-function getName(node) {
-  if (node.key.type === AST_NODE_TYPES.Identifier) {
-    return node.key.name;
-  } else if (node.key.type === AST_NODE_TYPES.Literal && typeof node.key.value === "string") {
-    return node.key.value;
-  } else {
-    return void 0;
-  }
-}
-function parsePropertyDecorator(decorator) {
-  const isPropertyDecorator = decorator.expression.type === AST_NODE_TYPES.CallExpression && decorator.expression.callee.type === AST_NODE_TYPES.Identifier && decorator.expression.callee.name === "property";
-  if (!isPropertyDecorator) {
-    return;
-  }
-  const callExpression = decorator?.expression.type === AST_NODE_TYPES.CallExpression ? decorator.expression : void 0;
-  if (callExpression === void 0) {
-    return;
-  }
-  const options = callExpression.arguments[0]?.type === AST_NODE_TYPES.ObjectExpression ? callExpression.arguments[0] : void 0;
-  const properties = options?.properties;
-  return {
-    callExpression,
-    options,
-    properties
-  };
-}
-function isBindThisCallee(callee) {
-  return callee.type === AST_NODE_TYPES.MemberExpression && // expression.identifier(this)
-  callee.property.type === AST_NODE_TYPES.Identifier && // expression.bind(this)
-  callee.property.name === "bind" && // expression.expression.bind(this)
-  callee.object.type === AST_NODE_TYPES.MemberExpression && // expression.identifier.bind(this)
-  callee.object.property.type === AST_NODE_TYPES.Identifier && // this.identifier.bind(this)
-  callee.object.object.type === AST_NODE_TYPES.ThisExpression;
-}
 const importDeclaration = `import { ${luminaJsxExportName} } from "${luminaEntrypointName}";`;
 const description$k = `To use Lumina's JSX, you need to ${importDeclaration}`;
 plugin.createRule({
@@ -1575,7 +1487,7 @@ plugin.createRule({
   },
   defaultOptions: [],
   create(context) {
-    const declaredComponents = /* @__PURE__ */ new Set();
+    let className;
     const hasLuminaDeclarations = context.sourceCode.text.includes("interface DeclareElements");
     return {
       TSModuleDeclaration(node) {
@@ -1583,20 +1495,10 @@ plugin.createRule({
         if (luminaDeclarationInterface === void 0) {
           return;
         }
-        luminaDeclarationInterface.body.body.forEach((member) => {
-          if (member.type !== AST_NODE_TYPES.TSPropertySignature || member.computed) {
-            return;
-          }
-          const type = member.typeAnnotation?.typeAnnotation;
-          if (type?.type !== AST_NODE_TYPES.TSTypeReference || type.typeName.type !== AST_NODE_TYPES.Identifier) {
-            return;
-          }
-          const className = type.typeName.name;
-          declaredComponents.add(className);
-        });
+        className = getComponentDeclaration(luminaDeclarationInterface)?.typeAnnotation?.typeAnnotation.typeName.name;
       },
       ExportNamedDeclaration(node) {
-        if (!hasLuminaDeclarations && declaredComponents.size === 0) {
+        if (!hasLuminaDeclarations && className === void 0) {
           return;
         }
         if (node.exportKind === "type") {
@@ -1620,7 +1522,7 @@ plugin.createRule({
         ) {
           return;
         } else if (node.declaration?.type === AST_NODE_TYPES.ClassDeclaration) {
-          const isComponent = declaredComponents.has(node.declaration.id?.name ?? "");
+          const isComponent = node.declaration.id?.name === className;
           if (isComponent) {
             return;
           }
@@ -1631,7 +1533,7 @@ plugin.createRule({
         });
       },
       ExportDefaultDeclaration(node) {
-        if (!hasLuminaDeclarations && declaredComponents.size === 0) {
+        if (!hasLuminaDeclarations && className === void 0) {
           return;
         }
         context.report({
@@ -1640,7 +1542,7 @@ plugin.createRule({
         });
       },
       ExportAllDeclaration(node) {
-        if (!hasLuminaDeclarations && declaredComponents.size === 0) {
+        if (!hasLuminaDeclarations && className === void 0) {
           return;
         }
         if (node.exportKind === "type") {

package/dist/plugins/lumina/utils/estree.d.ts

@@ -9,6 +9,14 @@ export declare function checkForLuminaJsx(): LuminaJsxCheck & {
 };
 export declare function hasDecorator(node: Pick<TSESTree.PropertyDefinitionNonComputedName, "decorators">, decoratorName: string): boolean;
 export declare function extractDeclareElementsInterface(node: TSESTree.TSModuleDeclaration): TSESTree.TSInterfaceDeclaration | undefined;
+export declare function getComponentDeclaration(node: TSESTree.TSInterfaceDeclaration): {
+    key: TSESTree.Literal;
+    typeAnnotation: {
+        typeAnnotation: {
+            typeName: TSESTree.Identifier;
+        };
+    };
+} | undefined;
 export declare function isCreateEvent(node: TSESTree.PropertyDefinition): boolean;
 export declare const getProperty: (properties: TSESTree.ObjectLiteralElement[] | undefined, name: string) => TSESTree.Property["value"] | undefined;
 export declare function isGetterWithoutSetter(node: TSESTree.MethodDefinition | TSESTree.PropertyDefinition): boolean;

package/dist/plugins/webgis/index.js

@@ -1,4 +1,4 @@
-import { m as makeEslintPlugin } from "../../makePlugin-DvrrzfxD.js";
+import { m as makeEslintPlugin, e as extractDeclareElementsInterface, g as getComponentDeclaration } from "../../estree-Can6TC4w.js";
 import { resolve } from "path/posix";
 import { AST_NODE_TYPES } from "@typescript-eslint/utils";
 const plugin = makeEslintPlugin(
@@ -7,16 +7,16 @@ const plugin = makeEslintPlugin(
 );
 const isTestFile = (filePath) => filePath.includes("/test") || filePath.includes(".test") || filePath.includes(".spec") || filePath.includes("e2e") || filePath.includes("__") || filePath.includes("/.");
 const isStorybookFile = (filePath) => filePath.includes(".stories");
-const description$4 = `Imports of files outside the src/ folder are not-portable and likely to break for consumers of this package.`;
+const description$5 = `Imports of files outside the src/ folder are not-portable and likely to break for consumers of this package.`;
 plugin.createRule({
   name: "no-import-outside-src",
   meta: {
     docs: {
-      description: description$4,
+      description: description$5,
       defaultLevel: "error"
     },
     messages: {
-      noImportOutsideSrc: description$4
+      noImportOutsideSrc: description$5
     },
     type: "problem",
     schema: []
@@ -50,16 +50,16 @@ plugin.createRule({
     };
   }
 });
-const description$3 = `Having two JSDoc comments next to each other is most likely a mistake - consider combining them into one, or separating them for clarity.`;
+const description$4 = `Having two JSDoc comments next to each other is most likely a mistake - consider combining them into one, or separating them for clarity.`;
 plugin.createRule({
   name: "no-touching-jsdoc",
   meta: {
     docs: {
-      description: description$3,
+      description: description$4,
       defaultLevel: "warn"
     },
     messages: {
-      noTouchingJsDoc: description$3
+      noTouchingJsDoc: description$4
     },
     type: "problem",
     schema: []
@@ -95,17 +95,17 @@ plugin.createRule({
   }
 });
 const reTouchingJsDoc = /\*\/\s+\/\*\*/gu;
-const description$2 = `@arcgis/core imports need to end with .js for better compatibility with ESM CDN builds for @arcgis/core and other packages.`;
+const description$3 = `@arcgis/core imports need to end with .js for better compatibility with ESM CDN builds for @arcgis/core and other packages.`;
 const packagesToEnforce = ["@arcgis/core/", "@amcharts/amcharts4/", "@amcharts/amcharts5/"];
 plugin.createRule({
   name: "require-js-in-imports",
   meta: {
     docs: {
-      description: description$2,
+      description: description$3,
       defaultLevel: "warn"
     },
     messages: {
-      requireJsInCoreImport: description$2
+      requireJsInCoreImport: description$3
     },
     type: "problem",
     fixable: "code",
@@ -139,17 +139,17 @@ plugin.createRule({
     };
   }
 });
-const description$1 = "Using .d.ts files is discouraged. Prefer .ts files instead, as they are type-checked and not in global scope.";
+const description$2 = "Using .d.ts files is discouraged. Prefer .ts files instead, as they are type-checked and not in global scope.";
 const allowedNames = /* @__PURE__ */ new Set(["vite-env.d.ts", "components.d.ts"]);
 plugin.createRule({
   name: "no-dts-files",
   meta: {
     docs: {
-      description: description$1,
+      description: description$2,
       defaultLevel: "warn"
     },
     messages: {
-      avoidDtsFiles: description$1
+      avoidDtsFiles: description$2
     },
     type: "suggestion",
     schema: []
@@ -179,12 +179,12 @@ plugin.createRule({
     };
   }
 });
-const description = `Enforce consistent logging so that ArcGIS developers can easily debug errors or warnings logged by our web components, which may lack a meaningful context in compiled code. See [our documentation on @arcgis/toolkit/log](https://webgis.esri.com/references/toolkit/log).`;
+const description$1 = `Enforce consistent logging so that ArcGIS developers can easily debug errors or warnings logged by our web components, which may lack a meaningful context in compiled code. See [our documentation on @arcgis/toolkit/log](https://webgis.esri.com/references/toolkit/log).`;
 plugin.createRule({
   name: "consistent-logging",
   meta: {
     docs: {
-      description,
+      description: description$1,
       defaultLevel: "off"
       // NOTE: this is turned on conditionally in root eslint config
     },
@@ -217,6 +217,61 @@ plugin.createRule({
     };
   }
 });
+const description = `Do not use links like [](#something) as they are not portable across .d.ts, and are not validated at build time. Use {@link } syntax, or absolute links. See https://webgis.esri.com/webgis/core/core/documenting-api#link`;
+plugin.createRule({
+  name: "no-unsafe-hash-links",
+  meta: {
+    docs: {
+      description,
+      defaultLevel: "warn"
+    },
+    messages: {
+      error: description
+    },
+    type: "problem",
+    schema: [],
+    fixable: "code"
+  },
+  defaultOptions: [],
+  create(context) {
+    let declareElementsInterface;
+    return {
+      "TSModuleDeclaration"(node) {
+        declareElementsInterface = extractDeclareElementsInterface(node);
+      },
+      "Program:exit"() {
+        if (declareElementsInterface === void 0 && !context.sourceCode.text.includes("@public") && !context.sourceCode.text.includes("@internal")) {
+          return;
+        }
+        for (const match of context.sourceCode.text.matchAll(reHashLink)) {
+          const fullMatch = match[0];
+          const anchor = match[2];
+          const replacement = computeReplacement(declareElementsInterface, anchor);
+          context.report({
+            messageId: "error",
+            loc: {
+              start: context.sourceCode.getLocFromIndex(match.index),
+              end: context.sourceCode.getLocFromIndex(match.index + fullMatch.length)
+            },
+            fix: replacement === void 0 ? void 0 : (fixer) => fixer.replaceTextRange([match.index, match.index + fullMatch.length], `{@link ${replacement}}`)
+          });
+        }
+      }
+    };
+  }
+});
+const reHashLink = /\[([^\]\n]+)\]\(#([^)]+)\)/gu;
+function computeReplacement(declareElementsInterface, anchor) {
+  if (declareElementsInterface === void 0) {
+    return;
+  }
+  const declaration = getComponentDeclaration(declareElementsInterface);
+  if (declaration === void 0) {
+    return;
+  }
+  const tagName = declaration.key.value;
+  return `components/${tagName}#${anchor}`;
+}
 const webgisPlugin = plugin.finalize();
 export {
   webgisPlugin

package/dist/plugins/webgis/rules/no-unsafe-hash-links.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('@typescript-eslint/utils/ts-eslint').RuleModule<"error", [], import('../../utils/makePlugin.ts').CommonDocs, import('@typescript-eslint/utils/ts-eslint').RuleListener>;
+export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/eslint-config",
-  "version": "5.0.0-next.98",
+  "version": "5.0.0",
   "description": "ESLint configuration for arcgis-web-components",
   "type": "module",
   "main": "index.js",
@@ -20,16 +20,19 @@
   ],
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "@arcgis/toolkit": "5.0.0-next.98",
     "@eslint/js": "^9.39.1",
     "@eslint/markdown": "^7.5.1",
     "@types/confusing-browser-globals": "^1.0.3",
+    "@typescript-eslint/utils": "^8.46.4",
     "confusing-browser-globals": "^1.0.11",
+    "eslint-plugin-package-json": "^0.88.1",
     "eslint-plugin-storybook": "^0.12.0",
     "globals": "^16.5.0",
+    "jsonc-eslint-parser": "^2.0.0",
     "tslib": "^2.8.1",
     "typescript": "~5.9.3",
-    "typescript-eslint": "^8.46.3"
+    "typescript-eslint": "^8.46.3",
+    "@arcgis/toolkit": "5.0.0"
   },
   "peerDependencies": {
     "eslint": "^9.39.1"

package/dist/makePlugin-DvrrzfxD.js

@@ -1,41 +0,0 @@
-import { ESLintUtils } from "@typescript-eslint/utils";
-const version = "5.0.0-next.98";
-const packageJson = {
-  version
-};
-function makeEslintPlugin(pluginName, urlCreator) {
-  const rules = [];
-  const creator = ESLintUtils.RuleCreator(urlCreator);
-  return {
-    // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-    createRule(rule) {
-      const { meta, name, ...rest } = rule;
-      const docs = { ...meta.docs, name };
-      const ruleModule = creator({ ...rest, meta: { ...meta, docs }, name });
-      rules.push(ruleModule);
-      return ruleModule;
-    },
-    // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-    finalize() {
-      const config = {
-        rules: Object.fromEntries(
-          rules.map((rule) => [`${pluginName}/${rule.meta.docs.name}`, rule.meta.docs.defaultLevel])
-        )
-      };
-      const plugin = {
-        meta: { name: `@arcgis/eslint-plugin-${pluginName}`, version: packageJson.version },
-        configs: {
-          recommended: config
-        },
-        rules: Object.fromEntries(rules.map((rule) => [rule.meta.docs.name, rule]))
-      };
-      config.plugins = {
-        [pluginName]: plugin
-      };
-      return plugin;
-    }
-  };
-}
-export {
-  makeEslintPlugin as m
-};