@arcgis/eslint-config 4.32.0-next.67

package/dist/config/lumina.js

@@ -0,0 +1,220 @@
+import {
+  restrictedImports
+} from "../chunk-WAWBOPY7.js";
+import {
+  lumina_default
+} from "../chunk-D7HD47IC.js";
+import "../chunk-C2D6KHIP.js";
+
+// src/config/storybook.ts
+import eslintPluginStorybook from "eslint-plugin-storybook";
+var storybookConfig = [
+  {
+    ignores: ["**/storybook-static*"]
+  },
+  ...eslintPluginStorybook.configs["flat/recommended"],
+  ...eslintPluginStorybook.configs["flat/addon-interactions"],
+  ...eslintPluginStorybook.configs["flat/csf-strict"],
+  {
+    files: ["**/*.stories.@(ts|tsx)"],
+    rules: {
+      // Redundant with https://typescript-eslint.io/rules/no-floating-promises/
+      "storybook/await-interactions": "off",
+      // Not applicable in our web-component setup
+      "storybook/csf-component": "off",
+      // We don't have deprecated usages
+      "storybook/hierarchy-separator": "off",
+      // Not applicable in our web-component setup
+      "storybook/no-title-property-in-meta": "off",
+      // Not applicable as we have a central Storybook config (@arcgis/storybook-utils)
+      "storybook/no-uninstalled-addons": "off",
+      // We never used storiesOf, and it's no longer included in Storybook
+      "storybook/no-stories-of": "off"
+    }
+  }
+];
+
+// src/config/lumina.ts
+var lumina_default2 = [
+  ...storybookConfig,
+  {
+    ...lumina_default.configs.recommended,
+    files: ["**/*.tsx"]
+  },
+  // Enable this rule in both .ts and .tsx files
+  {
+    files: ["**/*.ts", "**/*.tsx"],
+    plugins: { lumina: lumina_default },
+    rules: {
+      "lumina/component-placement-rules": "error"
+    }
+  },
+  {
+    files: ["**/*.tsx"],
+    rules: {
+      // 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",
+      "@typescript-eslint/no-restricted-imports": [
+        "error",
+        {
+          patterns: [
+            ...restrictedImports,
+            {
+              group: ["/lit"],
+              importNames: ["LitElement"],
+              message: "Import LitElement from `@arcgis/lumina` instead",
+              caseSensitive: true
+            },
+            {
+              group: [
+                "/lit/decorators.js",
+                "/lit/decorators/property.js",
+                "/@lit/reactive-element/decorators.js",
+                "/@lit/reactive-element/decorators/property.js"
+              ],
+              importNames: ["property"],
+              message: "Import @property() from `@arcgis/lumina` instead",
+              caseSensitive: true
+            },
+            {
+              group: [
+                "/lit/decorators.js",
+                "/lit/decorators/state.js",
+                "/@lit/reactive-element/decorators.js",
+                "/@lit/reactive-element/decorators/state.js"
+              ],
+              importNames: ["state"],
+              message: "Import @state() from `@arcgis/lumina` instead",
+              caseSensitive: true
+            },
+            {
+              group: [
+                "/lit/decorators.js",
+                "/lit/decorators/custom-element.js",
+                "/@lit/reactive-element/decorators.js",
+                "/@lit/reactive-element/decorators/custom-element.js",
+                // This does not start with "/" so matches ../../runtime and etc
+                "runtime"
+              ],
+              importNames: ["customElement"],
+              message: `Do no import customElement - it will be added at build time. Instead, make sure your component file has the following:
+declare global {
+  interface DeclareElements {
+    "arcgis-your-component": ArcgisYourComponent;
+  }
+}`,
+              caseSensitive: true
+            },
+            {
+              group: [
+                "/lit/directives/class-map.js",
+                "/lit-html/directives/class-map.js",
+                "/lit/directives/style-map.js",
+                "/lit-html/directives/style-map.js",
+                "/lit/directives/keyed.js",
+                "/lit-html/directives/keyed.js",
+                "/lit/directives/ref.js",
+                "/lit-html/directives/ref.js"
+              ],
+              importNames: ["classMap", "styleMap", "ref", "keyed"],
+              message: `You do not need to use classMap(), styleMap(), keyed() or ref() Lit directives - they will be auto-added at build time as necessary.`,
+              caseSensitive: true
+            },
+            {
+              group: ["/@lit/context"],
+              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
+            }
+          ]
+        }
+      ]
+    }
+  }
+  /*{
+    ...eslintPluginLit.configs["flat/recommended"],
+    files: ["**\/*.tsx"],
+    rules: {
+      // While some rules provided by the eslint-plugin-lit are helpful, most of
+      // them only apply to html`` tagged template literals - since we are using
+      // JSX, those rules don't work out of the box (or are not even needed
+      // because TypeScript would report the issues those rules try to catch).
+      //
+      // The only vaguely useful is lit/no-this-assign-in-render, however, we have
+      // TypeScript config that forces us to add "override" to any property
+      // that shadows prototype - that should catch accidental usages.
+      // Otherwise, having a `@property() override title=""` is a good way to
+      // document that your component reads this native property, and to get
+      // notified when it changes.
+      //
+      // Thus, as of 1.15.0, none of the rules in that plugin are useful for us.
+    },
+  },*/
+  /*{
+    ...eslintPluginWc.configs["flat/recommended"],
+    settings: {
+      wc: {
+        elementBaseClasses: ["LitElement"],
+      },
+    },
+    // For all tsx files
+    files: ["**\/*.tsx"],
+    // eslint-plugin-wc was written for no-TypeScript codebases that don't use
+    // any frameworks. None of it's rules as of v2.2.0 apply or are really
+    // useful to us.
+    //
+    // What follows is explanation of why the following rules are off:
+    rules: {
+      // This rule wrongly gets triggered for all classes, not just web
+      // components
+      "wc/no-constructor-params": "off",
+      // We are not defining custom elements using customElement.define()
+      "wc/no-invalid-element-name": "off",
+      // All shadow roots should be created by LitElement
+      "wc/attach-shadow-constructor": "off",
+      // Since we have lazy loading, all imperative dom interactions will go
+      // through this.el.*, which this rule doesn't detect
+      "wc/no-self-class": "off",
+      // Since we have lazy loading, all imperative dom interactions will go
+      // through this.el.*, which this rule doesn't detect
+      "wc/no-constructor-attributes": "off",
+      // Not needed with TypeScript and Lit
+      "wc/guard-super-call": "off",
+      // Implementing attributeChangedCallback is not needed with Lit
+      "wc/no-child-traversal-in-attributechangedcallback": "off",
+      // This rule might be ok, but it will never report anything for us since
+      // our DOM interactions go though this.el.*, rather than this.*
+      "wc/no-child-traversal-in-connectedcallback": "off",
+      // All shadow roots should be created by LitElement
+      "wc/no-closed-shadow-root": "off",
+      // We don't use customElement.define so this rule will never report
+      "wc/no-invalid-extends": "off",
+      // Good rule, but most of the time listeners will be setup using
+      // this.listen(), so this rule is useless. When addEventListener is
+      // used, it might be inside this.manager.onLifecycle(), followed by
+      // removeEventListener - this rule won't detect such usages and will
+      // falsely report
+      "wc/require-listener-teardown": "off",
+      // Lumina allows defining multiple components in a file
+      "wc/file-name-matches-element": "off",
+      // Off because
+      // - we have TypeScript that will force us to add "override" to any
+      //   property that shadows prototype, thus this rule becomes somewhat
+      //   redundant
+      // - the rule is too broad - names like "onClicked" should be allowed
+      "wc/no-method-prefixed-with-on": "off",
+      // `@arcgis/lumina-compiler` includes a better check for this
+      "wc/tag-name-matches-class": "off",
+    },
+  },*/
+];
+export {
+  lumina_default2 as default
+};

package/dist/config/restrictedImports.d.ts

@@ -0,0 +1,6 @@
+export declare const restrictedImports: {
+    group: string[];
+    message: string;
+    allowTypeImports: boolean;
+    caseSensitive: boolean;
+}[];

package/dist/config/restrictedImports.js

@@ -0,0 +1,6 @@
+import {
+  restrictedImports
+} from "../chunk-WAWBOPY7.js";
+export {
+  restrictedImports
+};

package/dist/config/storybook.d.ts

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

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

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

package/dist/plugins/lumina/index.js

@@ -0,0 +1,7 @@
+import {
+  lumina_default
+} from "../../chunk-D7HD47IC.js";
+import "../../chunk-C2D6KHIP.js";
+export {
+  lumina_default as default
+};

package/dist/plugins/lumina/rules/add-missing-jsx-import.d.ts

@@ -0,0 +1,3 @@
+export declare const addMissingJsxImport: import("@typescript-eslint/utils/ts-eslint").RuleModule<"addMissingJsxImport", [], {
+    description: string;
+}, import("@typescript-eslint/utils/ts-eslint").RuleListener>;

package/dist/plugins/lumina/rules/add-missing-jsx-import.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/plugins/lumina/rules/auto-add-type.d.ts

@@ -0,0 +1,4 @@
+import { ESLintUtils } from "@typescript-eslint/utils";
+export declare const autoAddType: ESLintUtils.RuleModule<"addType", [], {
+    description: string;
+}, ESLintUtils.RuleListener>;

package/dist/plugins/lumina/rules/auto-add-type.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/plugins/lumina/rules/component-placement-rules.d.ts

@@ -0,0 +1,3 @@
+export declare const componentPlacementRules: import("@typescript-eslint/utils/ts-eslint").RuleModule<"fileFolderNameMismatch" | "extensionNotTsx" | "noComponentOutsideSrcComponents", [], {
+    description: string;
+}, import("@typescript-eslint/utils/ts-eslint").RuleListener>;

package/dist/plugins/lumina/rules/component-placement-rules.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/plugins/lumina/rules/consistent-event-naming.d.ts

@@ -0,0 +1,17 @@
+type Options = [
+    {
+        /**
+         * Enforce that events start with a given prefix
+         */
+        eventNamespaces?: readonly string[];
+        /**
+         * Enforce or forbid events to include the component name in the event name
+         */
+        includeComponentNameInEventName?: boolean;
+    }
+];
+type Messages = "componentNameInEventError" | "eventNamespaceError" | "missingPrivateJsDocTag" | "noComponentNameInEventError";
+export declare const consistentEventNaming: import("@typescript-eslint/utils/ts-eslint").RuleModule<Messages, Options, {
+    description: string;
+}, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+export {};

package/dist/plugins/lumina/rules/consistent-event-naming.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/plugins/lumina/rules/decorators-context.d.ts

@@ -0,0 +1,3 @@
+export declare const decoratorsContext: import("@typescript-eslint/utils/ts-eslint").RuleModule<"publicApiMustBePublic" | "noPropertyDecoratorOnMethods" | "noCombinedPropertyEvent", [], {
+    description: string;
+}, import("@typescript-eslint/utils/ts-eslint").RuleListener>;

package/dist/plugins/lumina/rules/decorators-context.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/plugins/lumina/rules/no-ignore-jsdoc-tag.d.ts

@@ -0,0 +1,3 @@
+export declare const noIgnoreJsDocTag: import("@typescript-eslint/utils/ts-eslint").RuleModule<"noIgnoreJsDocTag", [], {
+    description: string;
+}, import("@typescript-eslint/utils/ts-eslint").RuleListener>;

package/dist/plugins/lumina/rules/no-ignore-jsdoc-tag.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/plugins/lumina/rules/no-incorrect-dynamic-tag-name.d.ts

@@ -0,0 +1,4 @@
+import { ESLintUtils } from "@typescript-eslint/utils";
+export declare const noIncorrectDynamicTagName: ESLintUtils.RuleModule<"incorrectDynamicTagName", [], {
+    description: string;
+}, ESLintUtils.RuleListener>;

package/dist/plugins/lumina/rules/no-incorrect-dynamic-tag-name.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/plugins/lumina/rules/no-inline-arrow-in-ref.d.ts

@@ -0,0 +1,3 @@
+export declare const noInlineArrowInRef: import("@typescript-eslint/utils/ts-eslint").RuleModule<"errorInlineArrow", [], {
+    description: string;
+}, import("@typescript-eslint/utils/ts-eslint").RuleListener>;

package/dist/plugins/lumina/rules/no-inline-arrow-in-ref.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/plugins/lumina/rules/no-listen-in-connected-callback.d.ts

@@ -0,0 +1,3 @@
+export declare const noListenInConnectedCallback: import("@typescript-eslint/utils/ts-eslint").RuleModule<"errorListenInConnectedCallback", [], {
+    description: string;
+}, import("@typescript-eslint/utils/ts-eslint").RuleListener>;

package/dist/plugins/lumina/rules/no-listen-in-connected-callback.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/plugins/lumina/rules/no-needless-bind-this.d.ts

@@ -0,0 +1,3 @@
+export declare const noNeedlessBindThis: import("@typescript-eslint/utils/ts-eslint").RuleModule<"noNeedlessBindThis", [], {
+    description: string;
+}, import("@typescript-eslint/utils/ts-eslint").RuleListener>;

package/dist/plugins/lumina/rules/no-needless-bind-this.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/plugins/lumina/rules/no-property-name-start-with-on.d.ts

@@ -0,0 +1,3 @@
+export declare const noPropertyNameStartWithOn: import("@typescript-eslint/utils/ts-eslint").RuleModule<"noPropertyNameStartWithOn", [], {
+    description: string;
+}, import("@typescript-eslint/utils/ts-eslint").RuleListener>;

package/dist/plugins/lumina/rules/no-property-name-start-with-on.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/plugins/lumina/rules/no-render-false.d.ts

@@ -0,0 +1,4 @@
+import { ESLintUtils } from "@typescript-eslint/utils";
+export declare const noRenderFalse: ESLintUtils.RuleModule<"errorFalseRendered", [], {
+    description: string;
+}, ESLintUtils.RuleListener>;

package/dist/plugins/lumina/rules/no-render-false.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/plugins/lumina/rules/tag-name-rules.d.ts

@@ -0,0 +1,10 @@
+type Options = [
+    {
+        namespaces?: readonly string[];
+    }
+];
+type Messages = "noComputedTagName" | "noNonStringTagName" | "noTagNameIdentifier" | "requireNamespace" | "unexpectedDeclareElementsEntry";
+export declare const tagNameRules: import("@typescript-eslint/utils/ts-eslint").RuleModule<Messages, Options, {
+    description: string;
+}, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+export {};

package/dist/plugins/lumina/rules/tag-name-rules.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/plugins/lumina/utils/checker.d.ts

@@ -0,0 +1,2 @@
+import ts from "typescript";
+export declare function isLuminaJsxType(type: ts.Type): boolean;

package/dist/plugins/lumina/utils/creator.d.ts

@@ -0,0 +1,6 @@
+import { ESLintUtils } from "@typescript-eslint/utils";
+type CommonDocs = {
+    description: string;
+};
+export declare const createRule: <Options extends readonly unknown[], MessageIds extends string>({ meta, name, ...rule }: Readonly<ESLintUtils.RuleWithMetaAndName<Options, MessageIds, CommonDocs>>) => ESLintUtils.RuleModule<MessageIds, Options, CommonDocs, ESLintUtils.RuleListener>;
+export {};

package/dist/plugins/lumina/utils/estree.d.ts

@@ -0,0 +1,14 @@
+import type { TSESTree } from "@typescript-eslint/utils";
+export declare const unwrapExpression: <T extends TSESTree.Node>(expression: T) => T | TSESTree.Expression;
+export declare const luminaEntrypointName = "@arcgis/lumina";
+export declare const luminaJsxExportName = "h";
+type LuminaJsxCheck = (node: TSESTree.ImportDeclaration) => void;
+export declare function checkForLuminaJsx(): LuminaJsxCheck & {
+    isLuminaJsx: boolean;
+};
+export declare function hasDecorator(node: Pick<TSESTree.PropertyDefinitionNonComputedName, "decorators">, decoratorName: string): boolean;
+export declare function extractDeclareElementsInterface(node: TSESTree.TSModuleDeclaration): TSESTree.TSInterfaceDeclaration | undefined;
+export declare function isCreateEvent(node: TSESTree.PropertyDefinition): boolean;
+export declare const getProperty: (properties: TSESTree.ObjectLiteralElement[] | undefined, name: string) => TSESTree.Property["value"] | undefined;
+export declare function isGetterWithoutSetter(node: TSESTree.MethodDefinition | TSESTree.PropertyDefinition): boolean;
+export {};

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

@@ -0,0 +1,14 @@
+/**
+ * @remarks
+ * Not using eslint-plugin-eslint-plugin as most rules there are not applicable
+ * when using TypeScript. Sad that ESLint ecosystem doesn't have a strong
+ * TypeScript culture. Some other rules are not applicable since we are using
+ * typescript-eslint.
+ */
+import type { AnyRuleModule } from "@typescript-eslint/utils/ts-eslint";
+import type { TSESLint } from "@typescript-eslint/utils";
+export declare function makeEslintPlugin(pluginName: string, rules: Record<string, AnyRuleModule>): TSESLint.FlatConfig.Plugin & {
+    configs: {
+        recommended: TSESLint.FlatConfig.Config;
+    };
+};

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

@@ -0,0 +1,26 @@
+import { RuleTester } from "@typescript-eslint/rule-tester";
+export declare const untypedRuleTester: RuleTester;
+export declare const typedRuleTester: RuleTester;
+/**
+ * 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;
+};

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

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

package/dist/plugins/webgis/index.js

@@ -0,0 +1,7 @@
+import {
+  webgis_default
+} from "../../chunk-25YPAQ6A.js";
+import "../../chunk-C2D6KHIP.js";
+export {
+  webgis_default as default
+};

package/dist/plugins/webgis/rules/no-import-outside-src.d.ts

@@ -0,0 +1,3 @@
+export declare const noImportOutsideSrc: import("@typescript-eslint/utils/ts-eslint").RuleModule<"noImportOutsideSrc", [], {
+    description: string;
+}, import("@typescript-eslint/utils/ts-eslint").RuleListener>;

package/dist/plugins/webgis/rules/no-import-outside-src.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/plugins/webgis/utils/creator.d.ts

@@ -0,0 +1,6 @@
+import { ESLintUtils } from "@typescript-eslint/utils";
+type CommonDocs = {
+    description: string;
+};
+export declare const createRule: <Options extends readonly unknown[], MessageIds extends string>({ meta, name, ...rule }: Readonly<ESLintUtils.RuleWithMetaAndName<Options, MessageIds, CommonDocs>>) => ESLintUtils.RuleModule<MessageIds, Options, CommonDocs, ESLintUtils.RuleListener>;
+export {};

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@arcgis/eslint-config",
+  "version": "4.32.0-next.67",
+  "description": "ESLint configuration for arcgis-web-components",
+  "type": "module",
+  "main": "index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": "./dist/config/index.js",
+    "./extra": "./dist/config/extra.js",
+    "./lumina": "./dist/config/lumina.js",
+    "./restrictedImports": "./dist/config/restrictedImports.js",
+    "./plugins/webgis": "./dist/plugins/webgis/index.js",
+    "./plugins/lumina": "./dist/plugins/lumina/index.js",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist/"
+  ],
+  "license": "SEE LICENSE IN LICENSE.md",
+  "dependencies": {
+    "@eslint/js": "^9.17.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",
+    "globals": "^15.12.0",
+    "prettier": "^3.3.3",
+    "tslib": "^2.7.0",
+    "typescript": "~5.6.3",
+    "typescript-eslint": "^8.18.1"
+  },
+  "peerDependencies": {
+    "eslint": "^9.17.0"
+  }
+}