@arcgis/eslint-config 4.33.0-next.98 → 4.34.0-next.0

package/dist/config/applications.d.ts

@@ -0,0 +1,5 @@
+import { TSESLint } from '@typescript-eslint/utils';
+declare const _default: (TSESLint.FlatConfig.Config | import("eslint").Linter.Config<import("eslint").Linter.RulesRecord> | {
+    readonly rules: Readonly<import("eslint").Linter.RulesRecord>;
+})[];
+export default _default;

package/dist/config/applications.js

@@ -0,0 +1,40 @@
+import defaultConfig from "./index.js";
+const applications = [
+  ...defaultConfig,
+  {
+    rules: {
+      // Not autofixable. Can be annoying
+      "@typescript-eslint/ban-ts-comment": "off",
+      // Less important in apps than in libraries
+      // Though, explicit return type improve TypeScript performance
+      "@typescript-eslint/explicit-function-return-type": "off",
+      // Less important for non-public APIs.
+      // And can be tedious to refactor existing code.
+      "@typescript-eslint/max-params": "off",
+      // No big harm in letting people do this if they want to
+      "@typescript-eslint/no-extraneous-class": "off",
+      // A convenient lazy variant, but less safe
+      "@typescript-eslint/no-unsafe-function-type": "off",
+      // Non-customer-facing code can handle Errors in what way is most convenient
+      "@typescript-eslint/only-throw-error": "off",
+      // Non-customer-facing code can handle Errors in what way is most convenient
+      "@typescript-eslint/prefer-promise-reject-errors": "off",
+      // A trade off between developer convenience and code quality
+      "@typescript-eslint/no-floating-promises": "off",
+      // A trade off between developer convenience and code quality
+      "@typescript-eslint/promise-function-async": "off",
+      // Let developer decide to add or omit it. If not present, creates
+      // worse exception messages.
+      "func-names": "off",
+      // This rule is for consistency between library developers - less important for monolith apps.
+      "id-denylist": "off",
+      // Some cases actually require sequential async loops
+      "no-await-in-loop": "off",
+      // More important for library-exposed symbols than apps
+      "symbol-description": "off"
+    }
+  }
+];
+export {
+  applications as default
+};

package/dist/config/index.d.ts

@@ -1,5 +1,5 @@
 import { TSESLint } from '@typescript-eslint/utils';
-declare const _default: (TSESLint.FlatConfig.Config | {
+declare const _default: (TSESLint.FlatConfig.Config | import("eslint").Linter.Config<import("eslint").Linter.RulesRecord> | {
     readonly rules: Readonly<import("eslint").Linter.RulesRecord>;
 })[];
 export default _default;

package/dist/config/index.js

@@ -3,10 +3,9 @@ import tsEslint from "typescript-eslint";
 import restrictedGlobals from "confusing-browser-globals";
 import globals from "globals";
 import { webgisPlugin } from "../plugins/webgis/index.js";
-const index = [
-  {
-    ignores: ["**/www", "**/dist", "**/assets", "**/coverage", "**/.docs"]
-  },
+import { globalIgnores } from "eslint/config";
+const defaultConfig = [
+  globalIgnores(["**/www", "**/dist", "**/assets", "**/coverage", "**/.docs"]),
   eslint.configs.recommended,
   ...tsEslint.configs.strictTypeChecked,
   ...tsEslint.configs.stylisticTypeChecked,
@@ -17,7 +16,8 @@ const index = [
   {
     files: ["**/*.ts", "**/*.tsx"],
     linterOptions: {
-      reportUnusedDisableDirectives: "error"
+      reportUnusedDisableDirectives: "error",
+      reportUnusedInlineConfigs: "error"
     },
     languageOptions: {
       globals: {
@@ -74,6 +74,13 @@ const index = [
       "valid-typeof": "off",
       // TypeScript reports this
       "@typescript-eslint/prefer-namespace-keyword": "off",
+      // TypeScript should catch most cases where this can cause issues
+      "@typescript-eslint/no-confusing-void-expression": "off",
+      // Many exceptions. Error causes caught by TypeScript. Non-error cases
+      // create minor code naming inconsistency only.
+      "new-cap": "off",
+      // TypeScript reports this
+      "no-unreachable": "off",
       //#endregion
       //#region Disable rules Redundant with Prettier
       /**
@@ -145,8 +152,8 @@ const index = [
       "no-extra-bind": "warn",
       "no-multi-assign": "error",
       // Not an error as some external APIs require calling "new" even if we don't
-      // care about the retune time
-      "no-new": "warn",
+      // care about the retune time. Controllers also use this pattern
+      "no-new": "off",
       "no-useless-computed-key": ["warn", { enforceForClassMembers: true }],
       "no-useless-concat": "error",
       "no-unneeded-ternary": "warn",
@@ -161,14 +168,18 @@ const index = [
         "error",
         "i",
         "index",
-        { name: "Infinity", message: "Use Number.POSITIVE_INFINITY instead" },
-        { name: "NaN", message: "Use Number.NaN instead" },
-        { name: "isNaN", message: "Use Number.isNaN instead" },
-        { name: "isFinite", message: "Use Number.isFinite instead" },
-        { name: "parseFloat", message: "Use Number.parseFloat instead" },
-        { name: "parseInt", message: "Use Number.parseInt instead" },
-        { name: "keys", message: "Use Object.keys instead" },
-        { name: "values", message: "Use Object.values instead" },
+        {
+          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"
+        },
+        {
+          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)"
+        },
+        {
+          name: "parseInt",
+          message: "Use Number.parseInt instead for more predicable parsing behavior. Also, radix=10 is the default for Number.parseInt, so you can omit it."
+        },
         ...restrictedGlobals
       ],
       "@typescript-eslint/no-useless-empty-export": "warn",
@@ -252,16 +263,7 @@ const index = [
       "prefer-object-has-own": "warn",
       // Lots of false positives
       "@typescript-eslint/no-base-to-string": "off",
-      "@typescript-eslint/no-confusing-void-expression": [
-        "error",
-        {
-          ignoreArrowShorthand: true,
-          ignoreVoidOperator: true
-        }
-      ],
-      // Conflicts with @typescript-eslint/no-confusing-void-expression
-      // See https://github.com/typescript-eslint/typescript-eslint/issues/4507
-      "@typescript-eslint/no-meaningless-void-operator": "off",
+      "@typescript-eslint/no-meaningless-void-operator": "warn",
       "@typescript-eslint/no-empty-function": [
         // There can be use cases for this (when providing a callback is required
         // but you don't want to do anything)
@@ -292,6 +294,9 @@ const index = [
           }
         }
       ],
+      // Generally this should be avoided, but some patterns require it
+      // (type-only getters/setters, or mixins)
+      "@typescript-eslint/no-unsafe-declaration-merging": "off",
       //#endregion
       //#region Report consistency issues
       // TODO: make these more or less strict as needed
@@ -311,26 +316,8 @@ const index = [
       // Rationale: https://devtopia.esri.com/WebGIS/arcgis-web-components/issues/289
       // TODO: replace with unicorn/prevent-abbreviations
       "id-denylist": ["error", "elt", "elem", "evt", "ev", "cb"],
-      "complexity": ["warn", { max: 30 }],
-      "new-cap": [
-        "warn",
-        {
-          capIsNewExceptions: [
-            // Exclude Stencil decorators
-            "Component",
-            "Element",
-            "Event",
-            "AttachInternals",
-            "Listen",
-            "Method",
-            "Prop",
-            "State",
-            "Watch",
-            // Exclude Angular decorator
-            "NgModule"
-          ]
-        }
-      ],
+      // Leave it to developer to decide when it is time to refactor-out
+      "complexity": "off",
       // TODO: discuss (this avoids longer lines, improves readability)
       // "no-inline-comments": "error",
       // TODO: discuss (similar to the rule above, might be redundant).
@@ -344,48 +331,6 @@ const index = [
        * ```
        */
       "@typescript-eslint/no-this-alias": "off",
-      // ENUM values like "1<<0" ... "1<<9" are very useful
-      "@typescript-eslint/prefer-literal-enum-member": "off",
-      "no-magic-numbers": "off",
-      "@typescript-eslint/no-magic-numbers": [
-        // Error on code like:
-        //   switch (code) { case 9: // '\t' ...
-        // refactor to:
-        //   export const charCodes = { tab: 9 };
-        //   switch (code) { case charCodes.tab: ...
-        //
-        // Benefits:
-        // - charCodes can be exported and reused in the codebase
-        // - no need for '\t' comment anymore
-        //   - comment can be wrong or get out of data
-        // - easy to find all usages of charCodes.tab (harder to search for usages
-        //   of 9)
-        //
-        // Similarly, you can define a dictionary of all HTTP status codes and
-        // other special numbers. Example:
-        // https://github.com/specify/specify7/blob/xml-editor/specifyweb/frontend/js_src/lib/utils/ajax/definitions.ts
-        // And now it's trivial to see all the places in the code that handle a
-        // particular http status code.
-        // Similarly, in that file further down you can see how by using
-        // [Http.Conflict] rather than 409:, the code is more self-documenting
-        "warn",
-        {
-          ignore: [
-            // Don't know why these aren't ignored by default
-            -1,
-            0,
-            1,
-            2
-          ],
-          ignoreDefaultValues: true,
-          ignoreClassFieldInitialValues: true,
-          detectObjects: false,
-          ignoreEnums: true,
-          ignoreNumericLiteralTypes: true,
-          ignoreReadonlyClassProperties: true,
-          ignoreTypeIndexes: true
-        }
-      ],
       "no-warning-comments": [
         // TODO: consider forbidding TODO in favor of BUG, HACK, REFACTOR, FEATURE,
         //   LOW, TEST, PERF. Then can configure IDE to assign different colors to
@@ -572,12 +517,6 @@ const index = [
       // TODO: replace with perfectionist/sort-intersection-types and perfectionist/sort-union-types rules.
       // Autofixable, so only a warning to be less disruptive
       "@typescript-eslint/sort-type-constituents": "warn",
-      "@typescript-eslint/prefer-nullish-coalescing": [
-        "warn",
-        {
-          ignorePrimitives: { string: true }
-        }
-      ],
       // The string.match() is more intuitive than the RegExp.exec()
       "@typescript-eslint/prefer-regexp-exec": "off",
       // Both types and interfaces have uses in the edge cases. In the common
@@ -589,7 +528,18 @@ const index = [
       // deprecated.
       "@typescript-eslint/no-deprecated": "warn",
       // For can be useful in support packages and hot paths
-      "@typescript-eslint/prefer-for-of": "off"
+      "@typescript-eslint/prefer-for-of": "off",
+      // Enums are generally discouraged. Not much harm in this particular issue though
+      "@typescript-eslint/no-mixed-enums": "off",
+      // ENUM values like "1<<0" ... "1<<9" are very useful
+      "@typescript-eslint/prefer-literal-enum-member": "off",
+      // We discourage enums, so little added value in this check
+      "@typescript-eslint/no-duplicate-enum-values": "off",
+      // We discourage enums, so little added value in this check
+      "@typescript-eslint/no-unsafe-enum-comparison": "off",
+      // Developer may actually mean to use ||
+      // Also, refactoring this out may break things
+      "@typescript-eslint/prefer-nullish-coalescing": "off"
       //#endregion
       // TODO: go over https://typescript-eslint.io/linting/troubleshooting/performance-troubleshooting
     }
@@ -601,5 +551,5 @@ const index = [
   }
 ];
 export {
-  index as default
+  defaultConfig as default
 };

package/dist/config/lumina.js

@@ -58,12 +58,6 @@ const lumina = [
       "@typescript-eslint/require-await": "off",
       // Too many offenders for now to report this as an error. Assigned issues to tackle this.
       "lumina/no-create-element-component": "warn",
-      /*
-       * This rule emits false warnings when using Controllers due to
-       * limitations of TypeScript when it comes to expressing the type of a
-       * property that changes during lifecycle (from non-null to eventual null)
-       */
-      "@typescript-eslint/no-confusing-void-expression": "off",
       "@typescript-eslint/no-restricted-imports": [
         "error",
         {

package/dist/{makePlugin-D5oWauGb.js → makePlugin-D9AKFbOC.js}

@@ -1,5 +1,5 @@
 import { ESLintUtils } from "@typescript-eslint/utils";
-const version = "4.33.0-next.98";
+const version = "4.34.0-next.0";
 function makeEslintPlugin(pluginName, urlCreator) {
   const rules = [];
   const creator = ESLintUtils.RuleCreator(urlCreator);

package/dist/plugins/lumina/index.js

@@ -1,4 +1,4 @@
-import { m as makeEslintPlugin } from "../../makePlugin-D5oWauGb.js";
+import { m as makeEslintPlugin } from "../../makePlugin-D9AKFbOC.js";
 import { AST_NODE_TYPES, ESLintUtils, AST_TOKEN_TYPES } from "@typescript-eslint/utils";
 import ts from "typescript";
 import { camelToKebab } from "@arcgis/components-utils";
@@ -95,16 +95,16 @@ function isBindThisCallee(callee) {
   callee.object.object.type === AST_NODE_TYPES.ThisExpression;
 }
 const importDeclaration = `import { ${luminaJsxExportName} } from "${luminaEntrypointName}";`;
-const description$j = `To use Lumina's JSX, you need to ${importDeclaration}`;
+const description$k = `To use Lumina's JSX, you need to ${importDeclaration}`;
 plugin.createRule({
   name: "add-missing-jsx-import",
   meta: {
     docs: {
-      description: description$j,
+      description: description$k,
       defaultLevel: "error"
     },
     messages: {
-      addMissingJsxImport: description$j
+      addMissingJsxImport: description$k
     },
     type: "problem",
     schema: [],
@@ -161,12 +161,12 @@ plugin.createRule({
     };
   }
 });
-const description$i = "Auto add { type: Boolean } or { type: Number } where necessary";
+const description$j = "Auto add { type: Boolean } or { type: Number } where necessary";
 plugin.createRule({
   name: "auto-add-type",
   meta: {
     docs: {
-      description: description$i,
+      description: description$j,
       defaultLevel: "warn"
     },
     messages: {
@@ -402,12 +402,12 @@ plugin.createRule({
     };
   }
 });
-const description$h = `Lumina component must be declared in a TSX file with a matching folder name located inside of src/components folder.`;
+const description$i = `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$h,
+      description: description$i,
       defaultLevel: "error"
     },
     messages: {
@@ -446,7 +446,7 @@ plugin.createRule({
     };
   }
 });
-const description$g = `Enforce consistent event naming.`;
+const description$h = `Enforce consistent event naming.`;
 const defaultOptions$1 = [
   {
     eventNamespaces: ["arcgis"],
@@ -457,7 +457,7 @@ plugin.createRule({
   name: "consistent-event-naming",
   meta: {
     docs: {
-      description: description$g,
+      description: description$h,
       defaultLevel: "warn"
     },
     messages: {
@@ -558,6 +558,87 @@ Discussion: https://devtopia.esri.com/WebGIS/arcgis-web-components/discussions/3
   }
 });
 const capitalAfterLower = /(?<=[a-z\d])[A-Z]/u;
+const description$g = `Enforce consistent usage of ? for marking property as nullable, rather than |null, |undefined or |Nil.`;
+plugin.createRule({
+  name: "consistent-nullability",
+  meta: {
+    docs: {
+      description: description$g,
+      // TODO: enable this by default
+      defaultLevel: "off"
+    },
+    messages: {
+      consistentNullabilityError: `For consistency, use {{propertyName}}?:{{newType}} to denote property as optional, rather than {{propertyName}}:{{oldType}}.`,
+      removeNeedlessDefault: `This default value is likely unnecessary. Remove it to reduce bundle size.`
+    },
+    schema: [],
+    fixable: "code",
+    type: "suggestion"
+  },
+  defaultOptions: [],
+  create(context) {
+    return {
+      PropertyDefinition(node) {
+        const isProperty = hasDecorator(node, "property");
+        if (!isProperty) {
+          return;
+        }
+        const comments = context.sourceCode.getCommentsBefore(node);
+        const isDeprecated = comments.some((comment) => comment.value.includes("@deprecated"));
+        if (isDeprecated) {
+          return;
+        }
+        const defaultValue = node.value;
+        if (defaultValue?.type === AST_NODE_TYPES.Literal && defaultValue.value === null || defaultValue?.type === AST_NODE_TYPES.Identifier && defaultValue.name === "undefined") {
+          context.report({
+            node: defaultValue,
+            messageId: "removeNeedlessDefault",
+            fix(fixer) {
+              const tokenBeforeDefaultValue = context.sourceCode.getTokenBefore(defaultValue);
+              const isEqualsSign = tokenBeforeDefaultValue && tokenBeforeDefaultValue.value === "=";
+              return isEqualsSign ? fixer.removeRange([tokenBeforeDefaultValue.range[0], defaultValue.range[1]]) : fixer.remove(defaultValue);
+            }
+          });
+        }
+        const typeAnnotation = node.typeAnnotation?.typeAnnotation;
+        if (typeAnnotation === void 0) {
+          return;
+        }
+        const isUnionType = typeAnnotation.type === AST_NODE_TYPES.TSUnionType;
+        if (!isUnionType) {
+          return;
+        }
+        const withoutNillTypes = typeAnnotation.types.filter(
+          (type) => type.type !== AST_NODE_TYPES.TSUndefinedKeyword && type.type !== AST_NODE_TYPES.TSNullKeyword && (type.type !== AST_NODE_TYPES.TSTypeReference || type.typeName.type !== AST_NODE_TYPES.Identifier || type.typeName.name !== "Nil" && type.typeName.name !== "nil" && type.typeName.name !== "nullish")
+        );
+        const isSameCount = typeAnnotation.types.length === withoutNillTypes.length;
+        if (isSameCount || withoutNillTypes.length === 0) {
+          return;
+        }
+        const hasQuestionMark = node.optional;
+        const newType = withoutNillTypes.map((type) => context.sourceCode.getText(type)).join(" | ");
+        context.report({
+          node: typeAnnotation,
+          messageId: "consistentNullabilityError",
+          data: {
+            propertyName: context.sourceCode.getText(node.key),
+            newType,
+            oldType: context.sourceCode.getText(typeAnnotation)
+          },
+          fix(fixer) {
+            const tokenAfterKey = context.sourceCode.getTokenAfter(node.key);
+            const hasExclamationMark = tokenAfterKey !== null && tokenAfterKey.value === "!";
+            return [
+              ...hasExclamationMark ? [fixer.remove(tokenAfterKey)] : [],
+              ...hasQuestionMark ? [] : [fixer.insertTextAfter(node.key, "?")],
+              fixer.replaceText(typeAnnotation, newType)
+            ];
+          }
+        });
+      }
+    };
+  }
+});
 const description$f = `Enforce that @property(), @method() and createEvent() members are used in the correct context.`;
 plugin.createRule({
   name: "decorators-context",

package/dist/plugins/lumina/rules/consistent-nullability.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('@typescript-eslint/utils/ts-eslint').RuleModule<"consistentNullabilityError" | "removeNeedlessDefault", [], import('../../utils/makePlugin').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 } from "../../makePlugin-D5oWauGb.js";
+import { m as makeEslintPlugin } from "../../makePlugin-D9AKFbOC.js";
 import { resolve } from "node:path/posix";
 import { AST_NODE_TYPES } from "@typescript-eslint/utils";
 const plugin = makeEslintPlugin(
@@ -136,7 +136,7 @@ plugin.createRule({
   }
 });
 const description = "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", "component.d.ts"]);
+const allowedNames = /* @__PURE__ */ new Set(["vite-env.d.ts", "components.d.ts"]);
 plugin.createRule({
   name: "no-dts-files",
   meta: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/eslint-config",
-  "version": "4.33.0-next.98",
+  "version": "4.34.0-next.0",
   "description": "ESLint configuration for arcgis-web-components",
   "type": "module",
   "main": "index.js",
@@ -8,6 +8,7 @@
   "types": "dist/index.d.ts",
   "exports": {
     ".": "./dist/config/index.js",
+    "./application": "./dist/config/applications.js",
     "./extra": "./dist/config/extra.js",
     "./lumina": "./dist/config/lumina.js",
     "./plugins/webgis": "./dist/plugins/webgis/index.js",
@@ -19,19 +20,17 @@
   ],
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "@arcgis/components-utils": "4.33.0-next.98",
-    "@eslint/js": "^9.17.0",
+    "@arcgis/components-utils": "4.34.0-next.0",
+    "@eslint/js": "^9.23.0",
     "@types/confusing-browser-globals": "^1.0.3",
     "confusing-browser-globals": "^1.0.11",
-    "eslint-plugin-prettier": "^5.2.1",
-    "eslint-plugin-storybook": "^0.11.1",
+    "eslint-plugin-storybook": "^0.12.0",
     "globals": "^15.12.0",
-    "prettier": "^3.3.3",
-    "tslib": "^2.7.0",
-    "typescript": "~5.6.3",
-    "typescript-eslint": "^8.18.1"
+    "tslib": "^2.8.1",
+    "typescript": "~5.8.3",
+    "typescript-eslint": "^8.28.0"
   },
   "peerDependencies": {
-    "eslint": "^9.17.0"
+    "eslint": "^9.23.0"
   }
 }

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

@@ -1,28 +0,0 @@
-import { ESLintUtils, TSUtils } from '@typescript-eslint/utils';
-import { CommonDocs } from './makePlugin';
-import { RunTests } from '@typescript-eslint/rule-tester';
-export declare function testUntypedRule<MessageIds extends string, Options extends readonly unknown[]>(rule: ESLintUtils.RuleModule<MessageIds, Options, CommonDocs>, test: RunTests<TSUtils.NoInfer<MessageIds>, TSUtils.NoInfer<Options>>): void;
-export declare function testTypedRule<MessageIds extends string, Options extends readonly unknown[]>(rule: ESLintUtils.RuleModule<MessageIds, Options, CommonDocs>, test: RunTests<TSUtils.NoInfer<MessageIds>, TSUtils.NoInfer<Options>>): void;
-/**
- * A helper for authoring before/after autofix diff in a way that makes it easy
- * to see what part of the code changed, and avoids duplication.
- *
- * @example
- * ```ts
- * {
- *   ...diff`console.${["warn", "error"]}("test");`;
- *   errors: [{ messageId: "messageId" }],
- * },
- * // equivalent to:
- * {
- *   code: "console.warn(\"test\");",
- *   output: "console.error(\"test\");",
- *   errors: [{ messageId: "messageId" }],
- * },
- * ```
- *
- */
-export declare function diff(parts: readonly string[], ...parameters: readonly (readonly [before: string, after: string])[]): {
-    code: string;
-    output: string;
-};