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

package/dist/plugins/webgis/index.js

@@ -1,4 +1,4 @@
-import { m as makeEslintPlugin } from "../../makePlugin-CsjR4Cb9.js";
+import { m as makeEslintPlugin } from "../../makePlugin-MXVxg4Ss.js";
 import { TSESTree, AST_TOKEN_TYPES, AST_NODE_TYPES, TSESLint } from "@typescript-eslint/utils";
 import path from "node:path";
 import { resolve } from "path/posix";
@@ -27,7 +27,8 @@ plugin.createRule({
       // Disabled by default because the rule is most relevant for autocasting
       // and only on public classes. We are discouraging autocasting in new
       // code.
-      defaultLevel: "off"
+      defaultLevel: "off",
+      isTypeChecked: false
     },
     messages: {
       name: `By convention, the first parameter on an Accessor-based class must be called "properties". This is needed for autocasting - https://webgis.esri.com/references/api-extractor/api-node-kinds#constructor. If your class has constructors overloads, at least one of them must have a "properties" parameter.`,
@@ -77,7 +78,8 @@ If you wish to use a loose type like any/object, create a type alias \`type {{ e
             return;
           }
           const extendsText = node.superClass ? context.sourceCode.getText(node.superClass) : "";
-          const isCollectionClass = extendsText.includes("Collection.ofType") || extendsText.includes("(Collection)") || extendsText === "Collection" || extendsText === "OwningCollection" || context.filename.endsWith(`esri${path.sep}core${path.sep}Collection.ts`);
+          const isCollectionClass = extendsText.includes("Collection.ofType") || extendsText.includes("(Collection)") || extendsText === "Collection" || extendsText === "OwningCollection" || // TODO: drop the esri/ case once core is in the monorepo
+          context.filename.endsWith(`esri${path.sep}core${path.sep}Collection.ts`) || context.filename.endsWith(`src${path.sep}core${path.sep}Collection.ts`);
           if (isCollectionClass) {
             return;
           }
@@ -110,13 +112,14 @@ If you wish to use a loose type like any/object, create a type alias \`type {{ e
     };
   }
 });
-const description$6 = `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$7 = `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$6,
-      defaultLevel: "off"
+      description: description$7,
+      defaultLevel: "off",
+      isTypeChecked: false
     },
     messages: {
       consistentLoggingWarning: `For consistency, use the log utility from @arcgis/toolkit/log instead of console.{{logMethodName}}.`
@@ -154,7 +157,8 @@ plugin.createRule({
       description: "Enforce consistent mixin pattern. See https://webgis.esri.com/sdk/contributing/core/core/mixins",
       // Enabled by default because the rule targets a very specific pattern
       // and that pattern is tricky to get right without this rule.
-      defaultLevel: "error"
+      defaultLevel: "error",
+      isTypeChecked: false
     },
     messages: {
       updateMixinCode: "Mixin typings need to be updated.",
@@ -479,17 +483,18 @@ function expressionToTypeString(expression, context, asConst) {
   }
   return;
 }
-const description$5 = "Using .d.ts files is discouraged. Prefer .ts files instead, as they are type-checked and not in global scope.";
+const description$6 = "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$5,
-      defaultLevel: "warn"
+      description: description$6,
+      defaultLevel: "warn",
+      isTypeChecked: false
     },
     messages: {
-      avoidDtsFiles: description$5
+      avoidDtsFiles: description$6
     },
     type: "suggestion",
     schema: []
@@ -525,7 +530,8 @@ plugin.createRule({
     docs: {
       description: "Disallow empty catch calls since empty catch calls in a promise chain don't catch any exceptions",
       // Enabled by default because this caught real bugs and has autofix
-      defaultLevel: "error"
+      defaultLevel: "error",
+      isTypeChecked: false
     },
     messages: { emptyCatch: "no empty catch calls" },
     schema: [],
@@ -546,16 +552,17 @@ plugin.createRule({
     };
   }
 });
-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,
-      defaultLevel: "error"
+      description: description$5,
+      defaultLevel: "error",
+      isTypeChecked: false
     },
     messages: {
-      noImportOutsideSrc: description$4
+      noImportOutsideSrc: description$5
     },
     type: "problem",
     schema: []
@@ -597,7 +604,8 @@ plugin.createRule({
       // Disabling by default because this matters for
       // lower-level libraries more than higher-level libraries or applications.
       // Also, many false-positives.
-      defaultLevel: "off"
+      defaultLevel: "off",
+      isTypeChecked: false
     },
     schema: [
       {
@@ -683,6 +691,59 @@ function isClassDefinition(definition) {
   }
   return variableNode.init?.type === AST_NODE_TYPES.ClassExpression;
 }
+const description$4 = "For Node.js compatibility, when TypeScript file imports another TypeScript file, use .ts extension over .js";
+plugin.createRule({
+  name: "no-js-in-ts-imports",
+  meta: {
+    docs: {
+      description: description$4,
+      defaultLevel: "off",
+      isTypeChecked: false
+    },
+    messages: {
+      noJsInTsImports: description$4
+    },
+    type: "problem",
+    fixable: "code",
+    schema: []
+  },
+  defaultOptions: [],
+  create(context) {
+    if (!/\.tsx?$/u.test(context.filename)) {
+      return {};
+    }
+    function checkSpecifier(node) {
+      const specifier = node.value;
+      if (!(specifier.startsWith("./") || specifier.startsWith("../")) || !specifier.endsWith(".js")) {
+        return;
+      }
+      context.report({
+        node,
+        messageId: "noJsInTsImports",
+        data: { specifier },
+        fix: (fixer) => fixer.replaceTextRange([node.range[1] - 3, node.range[1] - 1], "ts")
+      });
+    }
+    return {
+      ImportDeclaration(node) {
+        checkSpecifier(node.source);
+      },
+      ImportExpression(node) {
+        if (node.source.type === AST_NODE_TYPES.Literal && typeof node.source.value === "string") {
+          checkSpecifier(node.source);
+        }
+      },
+      ExportAllDeclaration(node) {
+        checkSpecifier(node.source);
+      },
+      ExportNamedDeclaration(node) {
+        if (node.source) {
+          checkSpecifier(node.source);
+        }
+      }
+    };
+  }
+});
 plugin.createRule({
   name: "no-kebab-case-props",
   meta: {
@@ -691,7 +752,8 @@ plugin.createRule({
       // Off by default till
       // https://devtopia.esri.com/WebGIS/arcgis-web-components/issues/5364#issuecomment-6321339
       // is resolved
-      defaultLevel: "off"
+      defaultLevel: "off",
+      isTypeChecked: false
     },
     messages: {
       kebab: "JSX props should use camelCase instead of kebab-case, except for data- or aria- attributes"
@@ -748,7 +810,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: description$3,
-      defaultLevel: "off"
+      defaultLevel: "off",
+      isTypeChecked: false
     },
     messages: {
       noStoryRenderArgsTypeAnnotation: "Do not annotate `render(args)` in stories. Type the story with `Meta<T>` or `StoryObj<T>` and let `args` infer from that."
@@ -789,7 +852,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: description$2,
-      defaultLevel: "warn"
+      defaultLevel: "warn",
+      isTypeChecked: false
     },
     messages: {
       noTouchingJsDoc: description$2
@@ -834,7 +898,8 @@ plugin.createRule({
   meta: {
     docs: {
       description: description$1,
-      defaultLevel: "warn"
+      defaultLevel: "warn",
+      isTypeChecked: false
     },
     messages: {
       error: description$1
@@ -889,7 +954,8 @@ plugin.createRule({
     docs: {
       description: "Async tests must await a screenshot assertion.",
       // Enabled by default because it targets a specific pattern and has autofix
-      defaultLevel: "error"
+      defaultLevel: "error",
+      isTypeChecked: false
     },
     messages: { asyncAssert: "Async tests must await a screenshot assertion." },
     schema: [],
@@ -922,7 +988,8 @@ plugin.createRule({
       // presumably work correctly today) so enabling it is a bit too disruptive.
       // We should coordinate enabling it with enabling other lint rules to
       // announce at once.
-      defaultLevel: "off"
+      defaultLevel: "off",
+      isTypeChecked: false
     },
     messages: { missingType: "An explicit type attribute is required on buttons" },
     schema: [],
@@ -944,17 +1011,18 @@ plugin.createRule({
     };
   }
 });
-const description = `@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/"];
+const description = `Imports of certain packages need to end with .js for better compatibility with CDN and bundlers.`;
+const packagesToEnforce = ["@arcgis/core/", "@amcharts/amcharts4/", "@amcharts/amcharts5/", "@vaadin/grid/"];
 plugin.createRule({
   name: "require-js-in-imports",
   meta: {
     docs: {
       description,
-      defaultLevel: "warn"
+      defaultLevel: "warn",
+      isTypeChecked: false
     },
     messages: {
-      requireJsInCoreImport: description
+      requireJsInImports: description
     },
     type: "problem",
     fixable: "code",
@@ -978,7 +1046,7 @@ plugin.createRule({
       }
       context.report({
         node: node.source,
-        messageId: "requireJsInCoreImport",
+        messageId: "requireJsInImports",
         fix: (fixer) => fixer.replaceText(node.source, `"${specifier}.js"`)
       });
     }
@@ -988,6 +1056,63 @@ plugin.createRule({
     };
   }
 });
+plugin.createRule({
+  name: "require-ts-in-imports",
+  meta: {
+    docs: {
+      description: "Require configured packages to be imported through their TypeScript source entrypoints when built output may be unavailable.",
+      defaultLevel: "off",
+      isTypeChecked: false
+    },
+    messages: {
+      requireTsInImports: "Import '{{specifier}}' through its '/ts' source entrypoint because built output for '{{packageName}}' may not yet be available when current package is invoked."
+    },
+    type: "problem",
+    schema: [
+      {
+        type: "array",
+        items: { type: "string" },
+        uniqueItems: true
+      }
+    ]
+  },
+  defaultOptions: [[]],
+  create(context) {
+    const packageNames = context.options[0];
+    function checkSpecifier(node) {
+      const specifier = node.value;
+      const packageName = packageNames.find(
+        (candidate) => specifier === candidate || specifier.startsWith(`${candidate}/`)
+      );
+      if (packageName === void 0 || specifier === `${packageName}/package.json` || specifier.endsWith("/ts")) {
+        return;
+      }
+      context.report({
+        node,
+        messageId: "requireTsInImports",
+        data: { packageName, specifier }
+      });
+    }
+    return {
+      ImportDeclaration(node) {
+        checkSpecifier(node.source);
+      },
+      ImportExpression(node) {
+        if (node.source.type === AST_NODE_TYPES.Literal && typeof node.source.value === "string") {
+          checkSpecifier(node.source);
+        }
+      },
+      ExportAllDeclaration(node) {
+        checkSpecifier(node.source);
+      },
+      ExportNamedDeclaration(node) {
+        if (node.source) {
+          checkSpecifier(node.source);
+        }
+      }
+    };
+  }
+});
 const webgisPlugin = plugin.finalize();
 export {
   webgisPlugin

package/dist/utils/disableRules.d.ts

@@ -4,7 +4,8 @@ import type { TSESLint } from "@typescript-eslint/utils";
  * A utility for temporary running ESLint with only specific rules enabled.
  *
  * @param config - flat config
- * @param enabledRules - exceptions
+ * @param enabledRules - exceptions. Set a rule to `true` to preserve existing
+ * configuration
  * @param disableTypeChecking - make ESLint much faster by temporary disabling
  * type-aware linting.
  * @returns a new flat config array where every rule is disabled,
@@ -21,4 +22,4 @@ import type { TSESLint } from "@typescript-eslint/utils";
  *   true,
  * );
  */
-export function disableAllRulesExcept(config: TSESLint.FlatConfig.ConfigArray, enabledRules: Record<string, TSESLint.FlatConfig.RuleLevel>, disableTypeChecking: boolean): TSESLint.FlatConfig.ConfigArray;
+export function disableAllRulesExcept(config: TSESLint.FlatConfig.ConfigArray, enabledRules: Partial<Record<string, TSESLint.FlatConfig.RuleEntry | true>>, disableTypeChecking: boolean): TSESLint.FlatConfig.ConfigArray;

package/dist/utils/disableRules.js

@@ -10,7 +10,7 @@ function applyRulesAndOptions(entry, enabledRules, disableTypeChecking) {
     rules: Object.fromEntries(
       Object.keys(entry.rules).map((ruleName) => {
         const override = enabledRules[ruleName];
-        return [ruleName, override ?? "off"];
+        return [ruleName, override === true ? entry.rules[ruleName] : override ?? "off"];
       })
     )
   } : entry;

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@arcgis/eslint-config",
-  "version": "5.2.0-next.6",
+  "version": "5.2.0-next.60",
   "description": "ESLint configuration for WebGIS SDK",
   "type": "module",
   "exports": {
     ".": "./dist/config/index.js",
     "./application": "./dist/config/applications.js",
+    "./core": "./dist/config/core.js",
     "./extra": "./dist/config/extra.js",
     "./lumina": "./dist/config/lumina.js",
     "./plugins/core": "./dist/plugins/core/index.js",
@@ -21,23 +22,28 @@
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
     "@eslint/js": "^10.0.1",
-    "@eslint/markdown": "^8.0.1",
+    "@eslint/markdown": "^8.0.3",
     "@types/confusing-browser-globals": "^1.0.3",
-    "@typescript-eslint/utils": "^8.58.0",
+    "@typescript-eslint/utils": "^8.63.0",
     "confusing-browser-globals": "^1.0.11",
-    "eslint-import-resolver-typescript": "^4.4.4",
-    "eslint-plugin-import-x": "^4.16.2",
+    "eslint-import-resolver-typescript": "^4.4.5",
+    "eslint-plugin-import-x": "^4.17.1",
+    "eslint-plugin-jsdoc": "~63.0.13",
     "eslint-plugin-package-json": "~0.91.1",
+    "eslint-plugin-perfectionist": "~5.10.0",
+    "eslint-plugin-react-jsx": "~5.11.2",
+    "eslint-plugin-regexp": "~3.1.1",
     "eslint-plugin-storybook": "^10.3.4",
+    "eslint-plugin-unicorn": "~64.0.0",
     "globals": "^16.5.0",
     "jsonc-eslint-parser": "^3.1.0",
     "prettier-linter-helpers": "^1.0.1",
     "tslib": "^2.8.1",
-    "typescript": "~6.0.2",
-    "typescript-eslint": "^8.58.0",
-    "@arcgis/toolkit": "5.2.0-next.6"
+    "typescript": "~6.0.3",
+    "typescript-eslint": "^8.63.0",
+    "@arcgis/toolkit": "5.2.0-next.60"
   },
   "peerDependencies": {
-    "eslint": "^10.2.0"
+    "eslint": "^10.6.0"
   }
 }