@arcgis/eslint-config 5.2.0-next.6 → 5.2.0-next.60

package/dist/config/index.js

@@ -7,9 +7,12 @@ import { globalIgnores } from "eslint/config";
 import markdown from "@eslint/markdown";
 import packageJson from "eslint-plugin-package-json";
 import { importX } from "eslint-plugin-import-x";
+import { createTypeScriptImportResolver } from "eslint-import-resolver-typescript";
 const packageJsonSortableCollections = packageJson.rules["sort-collections"].meta.defaultOptions[0].filter(
   (collection) => !["scripts", "exports"].includes(collection)
 ) ?? [];
+const importXTypeScriptSettings = { ...importX.flatConfigs.typescript.settings };
+delete importXTypeScriptSettings["import-x/resolver"];
 const config = [
   globalIgnores(["**/www", "**/dist", "**/assets", "**/coverage", "**/.docs"]),
   {
@@ -24,7 +27,13 @@ const config = [
     ...webgisPlugin.configs.recommended,
     files: ["**/*.ts", "**/*.tsx"]
   },
-  importX.flatConfigs.typescript,
+  {
+    ...importX.flatConfigs.typescript,
+    settings: {
+      ...importXTypeScriptSettings,
+      "import-x/resolver-next": [createTypeScriptImportResolver()]
+    }
+  },
   {
     files: ["**/*.ts", "**/*.tsx"],
     linterOptions: {
@@ -145,8 +154,10 @@ const config = [
        * consider refactoring to less confusing syntax instead
        *
        */
-      // Might be intentional, so only a warning
-      "no-await-in-loop": "warn",
+      // Too many false positives. Some cases require sequential execution of
+      // async code for correctness, cleaner output, or to avoid performance
+      // constraints
+      "no-await-in-loop": "off",
       "no-constructor-return": "warn",
       "no-fallthrough": ["error", { reportUnusedFallthroughComment: true }],
       // This mis-fires for anonymous functions when not wrapped in {}
@@ -181,11 +192,11 @@ const config = [
         "index",
         {
           name: "isNaN",
-          message: "Use Number.isNaN instead as it has more predictable behavior. See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/isNaN#description"
+          message: "Use Number.isNaN instead as it has more predictable behavior. See https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/isNaN#description"
         },
         {
           name: "isFinite",
-          message: "Use Number.isFinite instead as it has more predictable behavior. See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/isNaN#description (same applies to isFinite)"
+          message: "Use Number.isFinite instead as it has more predictable behavior. See https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/isNaN#description (same applies to isFinite)"
         },
         {
           name: "parseInt",
@@ -464,7 +475,10 @@ const config = [
       // rule - give it more time to catch the bug cases. Also, this rule
       // changes runtime behavior, and may lead to breaking changes.
       "@typescript-eslint/no-useless-default-assignment": "off",
-      "@typescript-eslint/no-unnecessary-type-assertion": ["warn"],
+      // Since https://devtopia.esri.com/WebGIS/arcgis-web-components/pull/17821,
+      // this rule has more true positives, but also many more false positives.
+      // The autofix often causes TypeScript errors, and new ESLint errors
+      "@typescript-eslint/no-unnecessary-type-assertion": "off",
       "@typescript-eslint/prefer-includes": ["warn"],
       "@typescript-eslint/prefer-reduce-type-parameter": ["warn"],
       "@typescript-eslint/prefer-return-this-type": ["warn"],

package/dist/{makePlugin-CsjR4Cb9.js → makePlugin-MXVxg4Ss.js}

@@ -1,10 +1,11 @@
 import { ESLintUtils } from "@typescript-eslint/utils";
-const version = "5.2.0-next.6";
+const version = "5.2.0-next.60";
 const packageJson = {
   version
 };
 function makeEslintPlugin(pluginName, urlCreator) {
   const rules = [];
+  const typeCheckedRules = /* @__PURE__ */ new Set();
   const creator = ESLintUtils.RuleCreator(urlCreator);
   return {
     // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
@@ -13,6 +14,9 @@ function makeEslintPlugin(pluginName, urlCreator) {
       const docs = { ...meta.docs, name };
       const ruleModule = creator({ ...rest, meta: { ...meta, docs }, name });
       rules.push(ruleModule);
+      if (meta.docs.isTypeChecked) {
+        typeCheckedRules.add(`${pluginName}/${name}`);
+      }
       return ruleModule;
     },
     // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
@@ -23,7 +27,7 @@ function makeEslintPlugin(pluginName, urlCreator) {
         )
       };
       const plugin = {
-        meta: { name: `@arcgis/eslint-plugin-${pluginName}`, version: packageJson.version },
+        meta: { name: `@arcgis/eslint-plugin-${pluginName}`, version: packageJson.version, typeCheckedRules },
         configs: {
           recommended: config
         },

package/dist/plugins/core/index.js

@@ -1,7 +1,9 @@
-import { m as makeEslintPlugin } from "../../makePlugin-CsjR4Cb9.js";
+import { m as makeEslintPlugin } from "../../makePlugin-MXVxg4Ss.js";
 import { AST_NODE_TYPES, AST_TOKEN_TYPES } from "@typescript-eslint/utils";
 import { generateDifferences, showInvisibles } from "prettier-linter-helpers";
 import path, { relative, win32, posix, normalize } from "path";
+import { dirname, join } from "node:path";
+import { existsSync } from "node:fs";
 import { execSync } from "child_process";
 const plugin = makeEslintPlugin(
   "core",
@@ -12,7 +14,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: "Checks that glsl tagged template strings don't have extra whitespace.",
-      defaultLevel: "error"
+      defaultLevel: "error",
+      isTypeChecked: false
     },
     messages: {
       delete: "Delete `{{ deleteText }}`",
@@ -93,20 +96,26 @@ function removeLeadingBlankLines(text) {
 function removeTrailingBlankLines(text) {
   return text.replace(/(\r?\n)(\r?\n)*([ \t]*)`$/gu, "$1$3`");
 }
+const projectMarker = "/src/";
+let projectRoot = void 0;
 function findProjectRoot(filename) {
   const normalized = filename.replaceAll("\\", "/");
-  let minimumIndex = Number.POSITIVE_INFINITY;
-  for (const marker of ["src/", "tests/", "test-apps/", "esri/"]) {
-    const index = normalized.indexOf(marker);
-    if (index === 0) {
-      return ".";
-    } else if (index > 0 && normalized.charCodeAt(index - 1) === slashCharCode) {
-      minimumIndex = Math.min(minimumIndex, index);
+  const isProjectFile = normalized.includes(projectMarker);
+  if (isProjectFile && projectRoot) {
+    return projectRoot;
+  }
+  const fileToFind = "package.json";
+  for (let root = dirname(filename), previousRoot = filename; root !== previousRoot; previousRoot = root, root = dirname(root)) {
+    const filepath = join(root, fileToFind);
+    if (existsSync(filepath)) {
+      if (isProjectFile) {
+        projectRoot = root;
+      }
+      return root;
     }
   }
-  return minimumIndex === Number.POSITIVE_INFINITY ? void 0 : normalized.slice(0, minimumIndex);
+  return;
 }
-const slashCharCode = 47;
 const isWindows = process.platform === "win32";
 const collator = new Intl.Collator("en-US");
 plugin.createRule({
@@ -114,7 +123,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: "Checks that imports are sorted and grouped",
-      defaultLevel: "error"
+      defaultLevel: "error",
+      isTypeChecked: false
     },
     messages: {
       importFormat: "Imports are incorrectly sorted and/or grouped",
@@ -226,7 +236,7 @@ function groupImportsByPath(imports, absImportPath, basePath) {
   });
 }
 function importStatementPathName(importStatement, absImportPath, basePath) {
-  return importPathName(importStatementPathString(importStatement), absImportPath, basePath);
+  return normalizeImportPath(importPathName(importStatementPathString(importStatement), absImportPath, basePath));
 }
 function importStatementPathString(importStatement) {
   return importStatement.source.value;
@@ -248,10 +258,25 @@ function importPathName(importPath, absImportPath, basePath) {
   return path.dirname(relative(basePath, importPath));
 }
 function formatGroupedImports(sourceCode, groupedImports, newLine) {
-  const importHeader = `// ${groupedImports.path.replace(/[\\/]/gu, ".")}`;
+  const importHeader = `// ${formatImportHeaderPath(groupedImports.path)}`;
   const imports = groupedImports.imports.map((importDeclaration) => sourceCode.getText(importDeclaration).trim()).join(newLine).trim();
   return `${importHeader}${newLine}${imports}`;
 }
+function formatImportHeaderPath(importPath) {
+  return normalizeImportPath(importPath).replace(/[\\/]/gu, ".");
+}
+function normalizeImportPath(importPath) {
+  const parts = importPath.split(/[\\/]/gu);
+  if (parts[0] === "src") {
+    parts[0] = "esri";
+  } else if (parts[0] === "tests") {
+    const srcPart = parts.indexOf("src");
+    if (srcPart !== -1) {
+      parts[srcPart] = "esri";
+    }
+  }
+  return parts.join(path.sep);
+}
 function getAttachedCommentStart(sourceCode, statement) {
   const comments = sourceCode.getCommentsBefore(statement);
   let start = statement.range[0];
@@ -326,7 +351,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: "Checks for duplicate comments before the first import declaration.",
-      defaultLevel: "error"
+      defaultLevel: "error",
+      isTypeChecked: false
     },
     messages: { duplicate: "Delete duplicate comment" },
     schema: [],
@@ -368,7 +394,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: "Checks for `todo` JSDoc tags with missing descriptions.",
-      defaultLevel: "error"
+      defaultLevel: "error",
+      isTypeChecked: false
     },
     messages: { empty: "JSDoc `todo` tag description required" },
     schema: [],
@@ -393,7 +420,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: "Enforces the declared class name passed to the @subclass() decorator",
-      defaultLevel: "error"
+      defaultLevel: "error",
+      isTypeChecked: false
     },
     messages: {
       invalidPath: "Invalid path passed to @subclass(). It should be a string literal matching the file path, without the extension and with path separators replaced with `.`"
@@ -452,7 +480,7 @@ function getDeclaredClass(filename) {
   if (!root) {
     return;
   }
-  const relativePath = relative(root, filename).replaceAll(win32.sep, ".").replaceAll(posix.sep, ".").replace(/\.[^/.]+$/u, "");
+  const relativePath = relative(root, filename).replaceAll(win32.sep, ".").replaceAll(posix.sep, ".").replace(/^src\./u, "esri.").replace(/\.[^/.]+$/u, "");
   return relativePath;
 }
 const tsRe = /\.tsx?$/u;
@@ -476,7 +504,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: "Checks that files redundant to TypeScript implementation files are not checked in.",
-      defaultLevel: "error"
+      defaultLevel: "error",
+      isTypeChecked: false
     },
     messages: {
       js: "Redundant JavaScript file detected. Please `git rm -f {{file}}`",
@@ -492,16 +521,16 @@ plugin.createRule({
     return {
       Program(node) {
         if (!filePath.endsWith(".d.ts") && tsRe.test(filePath)) {
-          const projectRoot = findProjectRoot(filePath);
-          if (!projectRoot) {
+          const projectRoot2 = findProjectRoot(filePath);
+          if (!projectRoot2) {
             context.report({ node, messageId: "missingProjectRoot" });
             return;
           }
-          const gitIndexFiles2 = getGitIndexFiles(projectRoot);
+          const gitIndexFiles2 = getGitIndexFiles(projectRoot2);
           if (!gitIndexFiles2) {
             return;
           }
-          filePath = relative(projectRoot, filePath);
+          filePath = relative(projectRoot2, filePath);
           const jsFilename = filePath.replace(tsRe, ".js");
           if (gitIndexFiles2.has(jsFilename)) {
             context.report({ node, messageId: "js", data: { file: jsFilename } });
@@ -520,7 +549,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: "Checks that whenever possible import and export paths are relative instead of absolute.",
-      defaultLevel: "error"
+      defaultLevel: "error",
+      isTypeChecked: false
     },
     messages: {
       importFormat: 'Prefer relative ("{{relPath}}") over absolute path',
@@ -562,8 +592,15 @@ plugin.createRule({
   }
 });
 function pathRoot(p) {
-  const dirName = path.dirname(p);
-  return dirName === "." ? p : pathRoot(dirName);
+  const pathImplementation = win32.isAbsolute(p) && !posix.isAbsolute(p) ? win32 : path;
+  let root = p;
+  while (true) {
+    const parent = pathImplementation.dirname(root);
+    if (parent === "." || parent === root) {
+      return root;
+    }
+    root = parent;
+  }
 }
 function verifyRelativeImport(context, node, absImportPath, basePath, importRoot) {
   const modulePath = node.value;
@@ -591,7 +628,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: "Checks that the corresponding calcite component import exists for each calcite component tag used.  It also checks that there are no extra unnecessary imports.",
-      defaultLevel: "error"
+      defaultLevel: "error",
+      isTypeChecked: false
     },
     messages: {
       missingImport: 'Import missing: import("@esri/calcite-components/dist/components/{{tag}}")',
@@ -640,7 +678,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: "Enforce filenames to be part of spec (test) top-level suites.",
-      defaultLevel: "error"
+      defaultLevel: "error",
+      isTypeChecked: false
     },
     messages: {
       name: "Suite name must be the name of the spec file",
@@ -694,7 +733,7 @@ function getToplevelSuiteName(filename) {
     return;
   }
   const relativePath = relative(root, filename).replaceAll(win32.sep, posix.sep);
-  return relativePath.replace(/^tests\/(.*)\.spec\.ts/u, "$1");
+  return relativePath.replace(/^tests\/(.*)\.spec\.ts/u, "$1").replace("src/", "esri/");
 }
 const corePlugin = plugin.finalize();
 export {

package/dist/plugins/lumina/index.js

@@ -1,4 +1,4 @@
-import { m as makeEslintPlugin } from "../../makePlugin-CsjR4Cb9.js";
+import { m as makeEslintPlugin } from "../../makePlugin-MXVxg4Ss.js";
 import { AST_NODE_TYPES, ESLintUtils, AST_TOKEN_TYPES } from "@typescript-eslint/utils";
 import { 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-CDc-die8.js";
 import ts from "typescript";
@@ -14,7 +14,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: description$m,
-      defaultLevel: "error"
+      defaultLevel: "error",
+      isTypeChecked: false
     },
     messages: {
       addMissingJsxImport: description$m
@@ -80,7 +81,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: description$l,
-      defaultLevel: "warn"
+      defaultLevel: "warn",
+      isTypeChecked: true
     },
     messages: {
       addType: `This property is of {{ type }} type, yet the type is not trivially inferrable from the AST without type-checking. Such properties require a { type: {{ type }} } annotation.
@@ -249,7 +251,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: "This rule helps ban or warn against listened event types",
-      defaultLevel: "off"
+      defaultLevel: "off",
+      isTypeChecked: false
     },
     messages: {
       default: "{{message}}"
@@ -319,7 +322,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: description$k,
-      defaultLevel: "error"
+      defaultLevel: "error",
+      isTypeChecked: false
     },
     messages: {
       fileFolderNameMismatch: "Lumina component must be declared in a file whose name (without extension) matches the parent folder name.\n\nCreating components in nested folders is supported as long as the file name matches the immediate parent folder name.",
@@ -369,7 +373,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: description$j,
-      defaultLevel: "warn"
+      defaultLevel: "warn",
+      isTypeChecked: false
     },
     messages: {
       eventNamespaceError: `Custom event name must start with one of the following prefixes: {{ prefixes }}.
@@ -476,7 +481,8 @@ plugin.createRule({
     docs: {
       description: description$i,
       // TODO: enable this by default
-      defaultLevel: "off"
+      defaultLevel: "off",
+      isTypeChecked: false
     },
     messages: {
       consistentNullabilityError: `For consistency, use {{propertyName}}?:{{newType}} to denote property as optional, rather than {{propertyName}}:{{oldType}}.`,
@@ -556,7 +562,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: description$h,
-      defaultLevel: "error"
+      defaultLevel: "error",
+      isTypeChecked: false
     },
     messages: {
       publicApiMustBePublic: `@property(), @method() and createEvent() members must not have private or protected modifier.
@@ -664,7 +671,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: description$g,
-      defaultLevel: "error"
+      defaultLevel: "error",
+      isTypeChecked: true
     },
     messages: {
       explicitSetterType: description$g,
@@ -1051,7 +1059,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: baseDescription$2,
-      defaultLevel: "warn"
+      defaultLevel: "warn",
+      isTypeChecked: false
     },
     messages: {
       memberOrdering: "Component member ordering is not consistent. Run ESLint autofix to sort members.",
@@ -1173,7 +1182,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: "This rule ensures that components are not created with `document.createElement()` to ensure imports are tracked by the compiler.",
-      defaultLevel: "error"
+      defaultLevel: "error",
+      isTypeChecked: false
     },
     fixable: "code",
     messages: {
@@ -1219,7 +1229,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: description$f,
-      defaultLevel: "error"
+      defaultLevel: "error",
+      isTypeChecked: false
     },
     messages: {
       noIgnoreJsDocTag: description$f
@@ -1257,7 +1268,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: description$e,
-      defaultLevel: "error"
+      defaultLevel: "error",
+      isTypeChecked: true
     },
     messages: {
       incorrectDynamicTagName: `This is using incorrect dynamic tag name syntax. See documentation on how to use dynamic tag in Lumina's JSX: https://webgis.esri.com/references/lumina/jsx#dynamic-tag-name`
@@ -1307,7 +1319,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: description$d,
-      defaultLevel: "warn"
+      defaultLevel: "warn",
+      isTypeChecked: false
     },
     messages: {
       errorInlineArrow: description$d
@@ -1342,7 +1355,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: description$c,
-      defaultLevel: "error"
+      defaultLevel: "error",
+      isTypeChecked: false
     },
     messages: {
       inlineExposure: description$c
@@ -1387,7 +1401,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: description$b,
-      defaultLevel: "error"
+      defaultLevel: "error",
+      isTypeChecked: false
     },
     messages: {
       noJsDocXrefLinks: description$b
@@ -1430,7 +1445,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: description$a,
-      defaultLevel: "error"
+      defaultLevel: "error",
+      isTypeChecked: false
     },
     messages: {
       noInvalidDirectivesProp: description$a
@@ -1476,7 +1492,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: description$9,
-      defaultLevel: "error"
+      defaultLevel: "error",
+      isTypeChecked: false
     },
     messages: {
       noJsxSpread: description$9
@@ -1521,7 +1538,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: baseDescription$1,
-      defaultLevel: "error"
+      defaultLevel: "error",
+      isTypeChecked: false
     },
     messages: {
       errorListenInConnectedCallback: description$8
@@ -1565,7 +1583,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: description$7,
-      defaultLevel: "warn"
+      defaultLevel: "warn",
+      isTypeChecked: false
     },
     messages: {
       noNonComponentExports: description$7,
@@ -1654,7 +1673,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: description$6,
-      defaultLevel: "error"
+      defaultLevel: "error",
+      isTypeChecked: false
     },
     messages: {
       noPropertyNameStartWithOn: description$6
@@ -1699,7 +1719,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: baseDescription,
-      defaultLevel: "warn"
+      defaultLevel: "warn",
+      isTypeChecked: true
     },
     messages: {
       errorFalseRendered: description$5
@@ -1750,7 +1771,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: description$4,
-      defaultLevel: "warn"
+      defaultLevel: "warn",
+      isTypeChecked: false
     },
     messages: {
       needlessInlineJsxEventTypeAnnotation: "There is no need for this type annotation as JSX types already define event types.",
@@ -1840,7 +1862,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: description$3,
-      defaultLevel: "warn"
+      defaultLevel: "warn",
+      isTypeChecked: false
     },
     messages: {
       noUnnecessaryAttributeName: description$3
@@ -1893,7 +1916,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: description$2,
-      defaultLevel: "warn"
+      defaultLevel: "warn",
+      isTypeChecked: false
     },
     messages: {
       noUnnecessaryBindThis: description$2
@@ -1956,7 +1980,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: description$1,
-      defaultLevel: "warn"
+      defaultLevel: "warn",
+      isTypeChecked: false
     },
     messages: {
       noUnnecessaryKey: description$1
@@ -2022,7 +2047,8 @@ plugin.createRule({
   meta: {
     docs: {
       description,
-      defaultLevel: "error"
+      defaultLevel: "error",
+      isTypeChecked: false
     },
     messages: {
       requireNamespace: "Custom element tag names in this project must start with one of the following namespaces: {{namespaces}}",

package/dist/plugins/utils/makePlugin.d.ts

@@ -2,10 +2,22 @@ import type { RuleModule } from "@typescript-eslint/utils/ts-eslint";
 import type { TSESLint } from "@typescript-eslint/utils";
 
 export interface EslintPlugin extends TSESLint.FlatConfig.Plugin {
+  meta: EslintPluginMeta;
   configs: { recommended: TSESLint.FlatConfig.Config; };
   rules: Record<string, RuleModule<string, readonly unknown[], CommonDocs>>;
 }
 
+export interface EslintPluginMeta extends TSESLint.FlatConfig.PluginMeta {
+  /**
+   * A set of rule names from current plugin that require type information.
+   *
+   * Generally, type checked rules are much slower as they need type checking.
+   * But once the first typed rule does the type checking, the other type
+   * checked rules don't add as much overhead.
+   */
+  typeCheckedRules: ReadonlySet<string>;
+}
+
 export type CommonDocs = {
   /** Rule description */
   description: string;
@@ -13,4 +25,9 @@ export type CommonDocs = {
   defaultLevel: "error" | "off" | "warn";
   /** Short rule name - inherited from the createRule`s name property */
   name: string;
+  /**
+   * Whether the rule needs type information (whether it calls
+   * ESLintUtils.getParserServices).
+   */
+  isTypeChecked: boolean;
 };