@arcgis/eslint-config 4.33.0-next.16 → 4.33.0-next.160

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/extra.js

@@ -1,5 +1,4 @@
-// src/config/extra.ts
-var extra_default = [
+const extra = [
   {
     files: ["**/*.ts", "**/*.tsx"],
     rules: {
@@ -32,5 +31,5 @@ var extra_default = [
   }
 ];
 export {
-  extra_default as default
+  extra as default
 };

package/dist/config/index.d.ts

@@ -1,22 +1,5 @@
-/**
- * See setup documentation & rationale behind ESLint:
- * https://qawebgis.esri.com/components/monorepo/support-packages/eslint
- *
- * Some advice on editing rules:
- * - prioritize autofixable rules to make adoption in existing codebases easier
- * - disable redundant rules (rules redundant with TypeScript, or each other),
- *   to reduce noise and performance impact
- * - if rule is always auto-fixable, it may be a good idea to emit it as a
- *   warning instead of an error to be less disruptive when the developer is
- *   typing code
- * - emit rules that have a lot of false positives as warnings instead of errors
- * - provide justification for enabling opinionated rules
- * - provide justification for disabling default rules
- * - if rule is disabled because it's buggy, describe how so
- *   (code sample, GitHub issue, permalink to file, etc)
- */
-import type { TSESLint } from "@typescript-eslint/utils";
-declare const _default: (TSESLint.FlatConfig.Config | {
+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/index.js

@@ -1,28 +1,23 @@
-import {
-  webgis_default
-} from "../chunk-2ND3FRSX.js";
-import "../chunk-C76ANB4Z.js";
-
-// src/config/index.ts
 import eslint from "@eslint/js";
 import tsEslint from "typescript-eslint";
 import restrictedGlobals from "confusing-browser-globals";
 import globals from "globals";
-var config_default = [
-  {
-    ignores: ["**/www", "**/dist", "**/assets", "**/coverage", "**/.docs"]
-  },
+import { webgisPlugin } from "../plugins/webgis/index.js";
+import { globalIgnores } from "eslint/config";
+const defaultConfig = [
+  globalIgnores(["**/www", "**/dist", "**/assets", "**/coverage", "**/.docs"]),
   eslint.configs.recommended,
   ...tsEslint.configs.strictTypeChecked,
   ...tsEslint.configs.stylisticTypeChecked,
   {
-    ...webgis_default.configs.recommended,
+    ...webgisPlugin.configs.recommended,
     files: ["**/*.ts", "**/*.tsx"]
   },
   {
     files: ["**/*.ts", "**/*.tsx"],
     linterOptions: {
-      reportUnusedDisableDirectives: "error"
+      reportUnusedDisableDirectives: "error",
+      reportUnusedInlineConfigs: "error"
     },
     languageOptions: {
       globals: {
@@ -79,6 +74,13 @@ var config_default = [
       "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
       /**
@@ -150,8 +152,8 @@ var config_default = [
       "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",
@@ -164,35 +166,21 @@ var config_default = [
       // variable. If you actually mean to use them, prepend with "globalThis."
       "no-restricted-globals": [
         "error",
-        .../* @__PURE__ */ new Set([
-          ...restrictedGlobals,
-          "event",
-          "name",
-          "closed",
-          "i",
-          "index",
-          "length",
-          "parent",
-          "self",
-          "status",
-          "stop",
-          "toolbar",
-          "top",
-          // use Number.POSITIVE_INFINITY instead
-          "Infinity",
-          // use Number.NaN instead
-          "NaN",
-          // use Number.isNaN instead
-          "isNaN",
-          // Use Number.isFinite instead
-          "isFinite",
-          // use Number.parseFloat instead
-          "parseFloat",
-          // use Number.parseInt instead
-          "parseInt",
-          // Use Object.keys instead
-          "keys"
-        ])
+        "i",
+        "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"
+        },
+        {
+          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",
       // Consider using String.prototype.localeCompare()
@@ -275,16 +263,7 @@ var config_default = [
       "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)
@@ -315,6 +294,9 @@ var config_default = [
           }
         }
       ],
+      // 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
@@ -334,26 +316,8 @@ var config_default = [
       // 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).
@@ -367,48 +331,6 @@ var config_default = [
        * ```
        */
       "@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
@@ -595,12 +517,6 @@ var config_default = [
       // 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
@@ -610,7 +526,20 @@ var config_default = [
       // This is error by default. Turning into warning because it falsely
       // reports when component tries to emit an event that is marked as
       // deprecated.
-      "@typescript-eslint/no-deprecated": "warn"
+      "@typescript-eslint/no-deprecated": "warn",
+      // For can be useful in support packages and hot paths
+      "@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
     }
@@ -622,5 +551,5 @@ var config_default = [
   }
 ];
 export {
-  config_default as default
+  defaultConfig as default
 };

package/dist/config/lumina.d.ts

@@ -1,7 +1,3 @@
-/**
- * In addition to the main index.js config, this rule set contains rule for
- * `@arcgis/lumina`
- */
-import type { TSESLint } from "@typescript-eslint/utils";
+import { TSESLint } from '@typescript-eslint/utils';
 declare const _default: TSESLint.FlatConfig.Config[];
 export default _default;

package/dist/config/lumina.js

@@ -1,11 +1,6 @@
-import {
-  lumina_default
-} from "../chunk-PVNFCQDL.js";
-import "../chunk-C76ANB4Z.js";
-
-// src/config/storybook.ts
 import eslintPluginStorybook from "eslint-plugin-storybook";
-var storybookConfig = [
+import { luminaPlugin } from "../plugins/lumina/index.js";
+const storybookConfig = [
   {
     ignores: ["**/storybook-static*"]
   },
@@ -41,19 +36,17 @@ var storybookConfig = [
     }
   }
 ];
-
-// src/config/lumina.ts
-var lumina_default2 = [
+const lumina = [
   ...storybookConfig,
   {
-    ...lumina_default.configs.recommended,
+    ...luminaPlugin.configs.recommended,
     files: ["**/*.tsx"]
   },
-  // Enable this rule in both .ts and .tsx files
   {
     files: ["**/*.ts", "**/*.tsx"],
-    plugins: { lumina: lumina_default },
+    plugins: { lumina: luminaPlugin },
     rules: {
+      // Enable this rule in both .ts and .tsx files
       "lumina/component-placement-rules": "error"
     }
   },
@@ -63,12 +56,8 @@ var lumina_default2 = [
       // It's a good practice for @method() in components to be async even if
       // they don't have await
       "@typescript-eslint/require-await": "off",
-      /*
-       * 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",
+      // Too many offenders for now to report this as an error. Assigned issues to tackle this.
+      "lumina/no-create-element-component": "warn",
       "@typescript-eslint/no-restricted-imports": [
         "error",
         {
@@ -139,6 +128,14 @@ declare global {
               importNames: ["ContextProvider", "ContextConsumer", "provide", "consume"],
               message: `For lazy-loading compatibility, import the useContextProvider() and the useContextConsumer() controllers from @arcgis/lumina rather than directly calling the Lit's controllers/decorators.`,
               caseSensitive: true
+            },
+            {
+              group: ["/@arcgis/components-controllers/accessor"],
+              message: 'Import from "@arcgis/lumina/controllers/accessor" instead'
+            },
+            {
+              group: ["/@arcgis/components-controllers"],
+              message: 'Import from "@arcgis/lumina/controllers" instead'
             }
           ]
         }
@@ -223,5 +220,5 @@ declare global {
   },*/
 ];
 export {
-  lumina_default2 as default
+  lumina as default
 };

package/dist/config/storybook.d.ts

@@ -1,2 +1,2 @@
-import type { TSESLint } from "@typescript-eslint/utils";
+import { TSESLint } from '@typescript-eslint/utils';
 export declare const storybookConfig: TSESLint.FlatConfig.ConfigArray;

package/dist/makePlugin-DEVY1iGf.js

@@ -0,0 +1,38 @@
+import { ESLintUtils } from "@typescript-eslint/utils";
+const version = "4.33.0-next.160";
+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 },
+        configs: {
+          recommended: config
+        },
+        rules: Object.fromEntries(rules.map((rule) => [rule.meta.docs.name, rule]))
+      };
+      config.plugins = {
+        [pluginName]: plugin
+      };
+      return plugin;
+    }
+  };
+}
+export {
+  makeEslintPlugin as m
+};

package/dist/plugins/lumina/index.d.ts

@@ -1,6 +1,5 @@
-declare const _default: import("@typescript-eslint/utils/ts-eslint").FlatConfig.Plugin & {
+export declare const luminaPlugin: import("@typescript-eslint/utils/ts-eslint").FlatConfig.Plugin & {
     configs: {
         recommended: import("@typescript-eslint/utils/ts-eslint").FlatConfig.Config;
     };
 };
-export default _default;