@arcgis/eslint-config 5.1.0-next.98 → 5.2.0-next.0

package/README.md

@@ -8,5 +8,5 @@ It is not intended to be used directly, but rather used as a dependency by other
 
 ## License
 
-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.
+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.1/LICENSE.txt.
+For third party notices, see https://js.arcgis.com/5.1/third-party-notices.txt.

package/dist/{estree-M1-bSnaj.js → estree-D4NC8KvY.js}

@@ -1,5 +1,5 @@
 import { ESLintUtils, AST_NODE_TYPES } from "@typescript-eslint/utils";
-const version = "5.1.0-next.98";
+const version = "5.2.0-next.0";
 const packageJson = {
   version
 };

package/dist/plugins/lumina/index.js

@@ -1,4 +1,4 @@
-import { m as makeEslintPlugin, l as luminaJsxExportName, a as luminaEntrypointName, b as luminaTestEntrypointName, s as sourceCodeDeclaresComponent, p as parsePropertyDecorator, c as getProperty, i as isGetterWithoutSetter, e as extractDeclareElementsInterface, d as isCreateEvent, h as hasDecorator, f as getName, j as checkForLuminaJsx, k as isBindThisCallee, g as getComponentDeclaration, u as unwrapExpression } from "../../estree-M1-bSnaj.js";
+import { m as makeEslintPlugin, l as luminaJsxExportName, a as luminaEntrypointName, b as luminaTestEntrypointName, s as sourceCodeDeclaresComponent, p as parsePropertyDecorator, c as getProperty, i as isGetterWithoutSetter, e as extractDeclareElementsInterface, d as isCreateEvent, h as hasDecorator, f as getName, j as checkForLuminaJsx, k as isBindThisCallee, g as getComponentDeclaration, u as unwrapExpression } from "../../estree-D4NC8KvY.js";
 import { AST_NODE_TYPES, ESLintUtils, AST_TOKEN_TYPES } from "@typescript-eslint/utils";
 import ts from "typescript";
 import { camelToKebab } from "@arcgis/toolkit/string";
@@ -7,16 +7,16 @@ const plugin = makeEslintPlugin(
   (rule) => `https://devtopia.esri.com/WebGIS/arcgis-web-components/tree/main/packages/support-packages/eslint-config/src/plugins/lumina/rules/${rule}.ts`
 );
 const importDeclaration = `import { ${luminaJsxExportName} } from "${luminaEntrypointName}";`;
-const description$l = `To use Lumina's JSX, you need to ${importDeclaration}`;
+const description$m = `To use Lumina's JSX, you need to ${importDeclaration}`;
 plugin.createRule({
   name: "add-missing-jsx-import",
   meta: {
     docs: {
-      description: description$l,
+      description: description$m,
       defaultLevel: "error"
     },
     messages: {
-      addMissingJsxImport: description$l
+      addMissingJsxImport: description$m
     },
     type: "problem",
     schema: [],
@@ -73,12 +73,12 @@ plugin.createRule({
     };
   }
 });
-const description$k = "Auto add { type: Boolean } or { type: Number } where necessary";
+const description$l = "Auto add { type: Boolean } or { type: Number } where necessary";
 plugin.createRule({
   name: "auto-add-type",
   meta: {
     docs: {
-      description: description$k,
+      description: description$l,
       defaultLevel: "warn"
     },
     messages: {
@@ -115,7 +115,7 @@ More information: https://devtopia.esri.com/WebGIS/arcgis-web-components/issues/
         const typeProperty = getProperty(properties, "type");
         const converterProperty = getProperty(properties, "converter");
         const isTrivialType = trivialType === "Number" || trivialType === "Boolean";
-        if (isTrivialType && typeProperty !== void 0 && typeProperty.type === AST_NODE_TYPES.Identifier && (typeProperty.name === "Number" || typeProperty.name === "Boolean")) {
+        if (isTrivialType && typeProperty?.type === AST_NODE_TYPES.Identifier && (typeProperty.name === "Number" || typeProperty.name === "Boolean")) {
           context.report({
             node: typeProperty,
             messageId: "noUnnecessaryType",
@@ -312,12 +312,12 @@ plugin.createRule({
     };
   }
 });
-const description$j = `Lumina component must be declared in a TSX file with a matching folder name located inside of src/components folder.`;
+const description$k = `Lumina component must be declared in a TSX file with a matching folder name located inside of src/components folder.`;
 plugin.createRule({
   name: "component-placement-rules",
   meta: {
     docs: {
-      description: description$j,
+      description: description$k,
       defaultLevel: "error"
     },
     messages: {
@@ -356,7 +356,7 @@ plugin.createRule({
     };
   }
 });
-const description$i = `Enforce consistent event naming.`;
+const description$j = `Enforce consistent event naming.`;
 const defaultOptions$1 = [
   {
     eventNamespaces: ["arcgis"],
@@ -367,7 +367,7 @@ plugin.createRule({
   name: "consistent-event-naming",
   meta: {
     docs: {
-      description: description$i,
+      description: description$j,
       defaultLevel: "warn"
     },
     messages: {
@@ -468,12 +468,12 @@ Discussion: https://devtopia.esri.com/WebGIS/arcgis-web-components/discussions/3
   }
 });
 const capitalAfterLower = /(?<=[a-z\d])[A-Z]/u;
-const description$h = `Enforce consistent usage of ? for marking property as nullable, rather than |null, |undefined or |Nil.`;
+const description$i = `Enforce consistent usage of ? for marking property as nullable, rather than |null, |undefined or |Nil.`;
 plugin.createRule({
   name: "consistent-nullability",
   meta: {
     docs: {
-      description: description$h,
+      description: description$i,
       // TODO: enable this by default
       defaultLevel: "off"
     },
@@ -549,18 +549,18 @@ plugin.createRule({
     };
   }
 });
-const description$g = `Enforce that @property(), @method() and createEvent() members are used in the correct context.`;
+const description$h = `Enforce that @property(), @method() and createEvent() members are used in the correct context.`;
 plugin.createRule({
   name: "decorators-context",
   meta: {
     docs: {
-      description: description$g,
+      description: description$h,
       defaultLevel: "error"
     },
     messages: {
       publicApiMustBePublic: `@property(), @method() and createEvent() members must not have private or protected modifier.
       
-If you wish to hide this member from public documentation, use @private or @protected JSDoc tags instead. Documentation: https://webgis.esri.com/references/lumina/documenting-components#excluding-api-from-public-documentation`,
+If you wish to hide this member from public documentation, use @private or @internal JSDoc tags instead. Documentation: https://webgis.esri.com/references/api-extractor/tags-reference`,
       noPropertyDecoratorOnMethods: `Methods must not have @property() nor @state() decorator. Did you mean @property() instead?`,
       noCombinedPropertyEvent: `Property may either be an event (initialized with createEvent()) or a property (has @property() decorator), but not both`,
       noCombinedPropertyState: `Property may either be a state (initialized with @state()) or a property (has @property() decorator), but not both`,
@@ -651,7 +651,7 @@ function isLuminaJsxType(type) {
 }
 const hasTypeFlag = (type, flag) => type.flags & flag ? true : (type.flags & ts.TypeFlags.Union) !== 0 && type.types.some((t) => hasTypeFlag(t, flag));
 const literalTypeFlag = ts.TypeFlags.StringLike | ts.TypeFlags.NumberLike | ts.TypeFlags.BooleanLike;
-const description$f = `Need to add explicit type annotation: {{ setterType }}
+const description$g = `Need to add explicit type annotation: {{ setterType }}
 
 Explanation:
 Lumina automatically creates an attribute for a property if property type includes a literal type (string|number|boolean).
@@ -662,11 +662,11 @@ plugin.createRule({
   name: "explicit-setter-type",
   meta: {
     docs: {
-      description: description$f,
+      description: description$g,
       defaultLevel: "error"
     },
     messages: {
-      explicitSetterType: description$f,
+      explicitSetterType: description$g,
       addExplicitSetterType: `Add {{ setterType }} type annotation`
     },
     type: "problem",
@@ -1212,16 +1212,16 @@ function isCreateElementComponent(node) {
   }
   return false;
 }
-const description$e = `Use @internal or @private JSDoc tag over @ignore. See https://webgis.esri.com/references/lumina/documenting-components#excluding-api-from-public-documentation`;
+const description$f = `Use @internal or @private JSDoc tag over @ignore. See https://webgis.esri.com/references/api-extractor/tags-reference`;
 plugin.createRule({
   name: "no-ignore-jsdoc-tag",
   meta: {
     docs: {
-      description: description$e,
+      description: description$f,
       defaultLevel: "error"
     },
     messages: {
-      noIgnoreJsDocTag: description$e
+      noIgnoreJsDocTag: description$f
     },
     type: "problem",
     schema: []
@@ -1250,12 +1250,12 @@ plugin.createRule({
   }
 });
 const reIgnore = /\* @ignore/gu;
-const description$d = `Detect incorrect usage of dynamic JSX tag name`;
+const description$e = `Detect incorrect usage of dynamic JSX tag name`;
 plugin.createRule({
   name: "no-incorrect-dynamic-tag-name",
   meta: {
     docs: {
-      description: description$d,
+      description: description$e,
       defaultLevel: "error"
     },
     messages: {
@@ -1298,18 +1298,18 @@ plugin.createRule({
     };
   }
 });
-const description$c = `If inline arrow function is passed to ref, it will be called again on each render.
+const description$d = `If inline arrow function is passed to ref, it will be called again on each render.
 
 If this is not desirable, see alternatives: https://webgis.esri.com/references/lumina/jsx#refs`;
 plugin.createRule({
   name: "no-inline-arrow-in-ref",
   meta: {
     docs: {
-      description: description$c,
+      description: description$d,
       defaultLevel: "warn"
     },
     messages: {
-      errorInlineArrow: description$c
+      errorInlineArrow: description$d
     },
     type: "problem",
     schema: []
@@ -1335,16 +1335,16 @@ plugin.createRule({
     };
   }
 });
-const description$b = `Put @internal and @private on their own JSDoc line, not inline.`;
+const description$c = `Put @internal and @private on their own JSDoc line, not inline.`;
 plugin.createRule({
   name: "no-inline-exposure-jsdoc-tag",
   meta: {
     docs: {
-      description: description$b,
+      description: description$c,
       defaultLevel: "error"
     },
     messages: {
-      inlineExposure: description$b
+      inlineExposure: description$c
     },
     type: "problem",
     schema: []
@@ -1379,6 +1379,50 @@ plugin.createRule({
     };
   }
 });
+const absoluteDocsBaseUrl = "https://next.gha.afd.arcgis.com/";
+const description$b = `xref:// URLs are not supported in JSDoc. Use absolute links to ${absoluteDocsBaseUrl} instead.`;
+plugin.createRule({
+  name: "no-jsdoc-xref-links",
+  meta: {
+    docs: {
+      description: description$b,
+      defaultLevel: "error"
+    },
+    messages: {
+      noJsDocXrefLinks: description$b
+    },
+    type: "problem",
+    schema: []
+  },
+  defaultOptions: [],
+  create(context) {
+    return {
+      "Program:exit"() {
+        const source = context.sourceCode.text;
+        if (!source.includes("xref://")) {
+          return;
+        }
+        for (const comment of context.sourceCode.getAllComments()) {
+          const commentText = source.slice(comment.range[0], comment.range[1]);
+          if (!commentText.startsWith("/**") || !commentText.includes("xref://")) {
+            continue;
+          }
+          for (const match of commentText.matchAll(reXrefUrl)) {
+            const idx = comment.range[0] + (match.index ?? 0);
+            context.report({
+              messageId: "noJsDocXrefLinks",
+              loc: {
+                start: context.sourceCode.getLocFromIndex(idx),
+                end: context.sourceCode.getLocFromIndex(idx + match[0].length)
+              }
+            });
+          }
+        }
+      }
+    };
+  }
+});
+const reXrefUrl = /xref:\/\/[\w./#-]+/gu;
 const description$a = `directives={} prop value must be an array literal. Documentation: https://webgis.esri.com/references/lumina/jsx#lit-directives`;
 plugin.createRule({
   name: "no-invalid-directives-prop",
@@ -1740,7 +1784,7 @@ plugin.createRule({
           return;
         }
         const argument = functionParent.params.at(0);
-        if (argument === void 0 || argument.type !== AST_NODE_TYPES.Identifier || argument.name !== eventVariableName) {
+        if (argument?.type !== AST_NODE_TYPES.Identifier || argument.name !== eventVariableName) {
           return;
         }
         const reportPossiblyUnnecessaryTypeAssertion = () => context.report({

package/dist/plugins/lumina/rules/no-jsdoc-xref-links.d.ts

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

package/dist/plugins/webgis/index.js

@@ -1,4 +1,4 @@
-import { m as makeEslintPlugin, e as extractDeclareElementsInterface, g as getComponentDeclaration } from "../../estree-M1-bSnaj.js";
+import { m as makeEslintPlugin, e as extractDeclareElementsInterface, g as getComponentDeclaration } from "../../estree-D4NC8KvY.js";
 import { resolve } from "path/posix";
 import { AST_NODE_TYPES } from "@typescript-eslint/utils";
 const plugin = makeEslintPlugin(
@@ -29,7 +29,7 @@ plugin.createRule({
       return {};
     }
     const basePath = fileName.slice(0, srcIndex + "/src/".length);
-    if (isTestFile(fileName)) {
+    if (isTestFile(fileName) || isStorybookFile(fileName)) {
       return {};
     }
     return {
@@ -217,7 +217,7 @@ plugin.createRule({
     };
   }
 });
-const description$1 = `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/sdk/contributing/core/core/documenting-api#link`;
+const description$1 = `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/references/api-extractor/tags-reference#link)`;
 plugin.createRule({
   name: "no-unsafe-hash-links",
   meta: {

package/package.json

@@ -1,15 +1,13 @@
 {
   "name": "@arcgis/eslint-config",
-  "version": "5.1.0-next.98",
+  "version": "5.2.0-next.0",
   "description": "ESLint configuration for WebGIS SDK",
   "type": "module",
   "exports": {
     ".": "./dist/config/index.js",
-    "./ts": "./src/config/index.ts",
     "./application": "./dist/config/applications.js",
     "./extra": "./dist/config/extra.js",
     "./lumina": "./dist/config/lumina.js",
-    "./lumina/ts": "./src/config/lumina.ts",
     "./plugins/webgis": "./dist/plugins/webgis/index.js",
     "./plugins/lumina": "./dist/plugins/lumina/index.js",
     "./utils/disable-rules": "./dist/utils/disable-rules.js",
@@ -32,7 +30,7 @@
     "tslib": "^2.8.1",
     "typescript": "~6.0.2",
     "typescript-eslint": "^8.58.0",
-    "@arcgis/toolkit": "5.1.0-next.98"
+    "@arcgis/toolkit": "5.2.0-next.0"
   },
   "peerDependencies": {
     "eslint": "^10.2.0"