@arcgis/eslint-config 4.33.0-next.94 → 4.33.0-next.96

package/dist/config/lumina.js

@@ -42,11 +42,11 @@ const lumina = [
     ...luminaPlugin.configs.recommended,
     files: ["**/*.tsx"]
   },
-  // Enable this rule in both .ts and .tsx files
   {
     files: ["**/*.ts", "**/*.tsx"],
     plugins: { lumina: luminaPlugin },
     rules: {
+      // Enable this rule in both .ts and .tsx files
       "lumina/component-placement-rules": "error"
     }
   },
@@ -56,6 +56,8 @@ const lumina = [
       // It's a good practice for @method() in components to be async even if
       // they don't have await
       "@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
@@ -132,6 +134,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'
             }
           ]
         }

package/dist/{makePlugin-W-rZIyei.js → makePlugin-khyXfCm4.js}

@@ -1,9 +1,10 @@
 import { ESLintUtils } from "@typescript-eslint/utils";
-const version = "4.33.0-next.94";
+const version = "4.33.0-next.96";
 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 };
@@ -11,6 +12,7 @@ function makeEslintPlugin(pluginName, urlCreator) {
       rules.push(ruleModule);
       return ruleModule;
     },
+    // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
     finalize() {
       const config = {
         rules: Object.fromEntries(

package/dist/plugins/lumina/index.js

@@ -1,4 +1,4 @@
-import { m as makeEslintPlugin } from "../../makePlugin-W-rZIyei.js";
+import { m as makeEslintPlugin } from "../../makePlugin-khyXfCm4.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$i = `To use Lumina's JSX, you need to ${importDeclaration}`;
+const description$j = `To use Lumina's JSX, you need to ${importDeclaration}`;
 plugin.createRule({
   name: "add-missing-jsx-import",
   meta: {
     docs: {
-      description: description$i,
+      description: description$j,
       defaultLevel: "error"
     },
     messages: {
-      addMissingJsxImport: description$i
+      addMissingJsxImport: description$j
     },
     type: "problem",
     schema: [],
@@ -161,12 +161,12 @@ plugin.createRule({
     };
   }
 });
-const description$h = "Auto add { type: Boolean } or { type: Number } where necessary";
+const description$i = "Auto add { type: Boolean } or { type: Number } where necessary";
 plugin.createRule({
   name: "auto-add-type",
   meta: {
     docs: {
-      description: description$h,
+      description: description$i,
       defaultLevel: "warn"
     },
     messages: {
@@ -333,7 +333,7 @@ plugin.createRule({
   meta: {
     docs: {
       description: "This rule helps ban or warn against listened event types",
-      defaultLevel: "error"
+      defaultLevel: "off"
     },
     messages: {
       default: "{{message}}"
@@ -402,12 +402,12 @@ plugin.createRule({
     };
   }
 });
-const description$g = `Lumina component must be declared in a TSX file with a matching folder name located inside of src/components folder.`;
+const description$h = `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$g,
+      description: description$h,
       defaultLevel: "error"
     },
     messages: {
@@ -446,7 +446,7 @@ plugin.createRule({
     };
   }
 });
-const description$f = `Enforce consistent event naming.`;
+const description$g = `Enforce consistent event naming.`;
 const defaultOptions$1 = [
   {
     eventNamespaces: ["arcgis"],
@@ -457,7 +457,7 @@ plugin.createRule({
   name: "consistent-event-naming",
   meta: {
     docs: {
-      description: description$f,
+      description: description$g,
       defaultLevel: "warn"
     },
     messages: {
@@ -558,12 +558,12 @@ Discussion: https://devtopia.esri.com/WebGIS/arcgis-web-components/discussions/3
   }
 });
 const capitalAfterLower = /(?<=[a-z\d])[A-Z]/u;
-const description$e = `Enforce that @property(), @method() and createEvent() members are used in the correct context.`;
+const description$f = `Enforce that @property(), @method() and createEvent() members are used in the correct context.`;
 plugin.createRule({
   name: "decorators-context",
   meta: {
     docs: {
-      description: description$e,
+      description: description$f,
       defaultLevel: "error"
     },
     messages: {
@@ -657,7 +657,7 @@ function isLuminaJsxType(type) {
 }
 const hasTypeFlag = (type, flag) => type.flags & flag ? true : (type.flags & ts.TypeFlags.Union) !== 0 && type.types.some((t) => hasTypeFlag(t, flag));
 const literalTypeFlag = ts.TypeFlags.StringLike | ts.TypeFlags.NumberLike | ts.TypeFlags.BooleanLike;
-const description$d = `Need to add explicit type annotation: {{ setterType }}
+const description$e = `Need to add explicit type annotation: {{ setterType }}
 
 Explanation:
 Lumina automatically creates an attribute for a property if property type includes a literal type (string|number|boolean).
@@ -668,11 +668,11 @@ plugin.createRule({
   name: "explicit-setter-type",
   meta: {
     docs: {
-      description: description$d,
+      description: description$e,
       defaultLevel: "error"
     },
     messages: {
-      explicitSetterType: description$d,
+      explicitSetterType: description$e,
       addExplicitSetterType: `Add {{ setterType }} type annotation`
     },
     type: "problem",
@@ -1169,6 +1169,9 @@ const blockListedCustomElementNames = /* @__PURE__ */ new Set([
   "font-face-name",
   "missing-glyph"
 ]);
+function isCustomElementTag(tag) {
+  return tag.includes("-") && !blockListedCustomElementNames.has(tag);
+}
 plugin.createRule({
   name: "no-create-element-component",
   defaultOptions: [],
@@ -1215,19 +1218,16 @@ function isCreateElementComponent(node) {
   }
   return false;
 }
-function isCustomElementTag(tag) {
-  return tag.includes("-") && !blockListedCustomElementNames.has(tag);
-}
-const description$c = `Use @internal or @private JSDoc tag over @ignore. See https://qawebgis.esri.com/components/lumina/documenting-components#excluding-api-from-public-documentation`;
+const description$d = `Use @internal or @private JSDoc tag over @ignore. See https://qawebgis.esri.com/components/lumina/documenting-components#excluding-api-from-public-documentation`;
 plugin.createRule({
   name: "no-ignore-jsdoc-tag",
   meta: {
     docs: {
-      description: description$c,
+      description: description$d,
       defaultLevel: "error"
     },
     messages: {
-      noIgnoreJsDocTag: description$c
+      noIgnoreJsDocTag: description$d
     },
     type: "problem",
     schema: []
@@ -1256,12 +1256,12 @@ plugin.createRule({
   }
 });
 const reIgnore = /\* @ignore/gu;
-const description$b = `Detect incorrect usage of dynamic JSX tag name`;
+const description$c = `Detect incorrect usage of dynamic JSX tag name`;
 plugin.createRule({
   name: "no-incorrect-dynamic-tag-name",
   meta: {
     docs: {
-      description: description$b,
+      description: description$c,
       defaultLevel: "error"
     },
     messages: {
@@ -1305,7 +1305,7 @@ plugin.createRule({
   }
 });
 const baseDescription$2 = `Do not pass an inline arrow function to a ref prop - such syntax creates a new function on each render, which makes Lit call ref callback again on each render.`;
-const description$a = `${baseDescription$2}
+const description$b = `${baseDescription$2}
 
 Alternatives: https://qawebgis.esri.com/components/lumina/jsx#refs`;
 plugin.createRule({
@@ -1316,7 +1316,7 @@ plugin.createRule({
       defaultLevel: "error"
     },
     messages: {
-      errorInlineArrow: description$a
+      errorInlineArrow: description$b
     },
     type: "problem",
     schema: []
@@ -1342,16 +1342,16 @@ plugin.createRule({
     };
   }
 });
-const description$9 = `directives={} prop value must be an array literal. Documentation: https://qawebgis.esri.com/components/lumina/jsx#lit-directives`;
+const description$a = `directives={} prop value must be an array literal. Documentation: https://qawebgis.esri.com/components/lumina/jsx#lit-directives`;
 plugin.createRule({
   name: "no-invalid-directives-prop",
   meta: {
     docs: {
-      description: description$9,
+      description: description$a,
       defaultLevel: "error"
     },
     messages: {
-      noInvalidDirectivesProp: description$9
+      noInvalidDirectivesProp: description$a
     },
     type: "problem",
     schema: []
@@ -1388,16 +1388,16 @@ plugin.createRule({
     };
   }
 });
-const description$8 = `This spread syntax is not supported. Alternatives: https://qawebgis.esri.com/components/lumina/jsx#spread-attributes`;
+const description$9 = `This spread syntax is not supported. Alternatives: https://qawebgis.esri.com/components/lumina/jsx#spread-attributes`;
 plugin.createRule({
   name: "no-jsx-spread",
   meta: {
     docs: {
-      description: description$8,
+      description: description$9,
       defaultLevel: "error"
     },
     messages: {
-      noJsxSpread: description$8
+      noJsxSpread: description$9
     },
     type: "problem",
     schema: []
@@ -1427,7 +1427,7 @@ plugin.createRule({
   }
 });
 const baseDescription$1 = `Do not call this.listen()/this.listenOn() in connectedCallback.`;
-const description$7 = `${baseDescription$1}
+const description$8 = `${baseDescription$1}
 
 Instead, call this.listen()/this.listenOn() in constructor(), load() or loaded().
 
@@ -1442,7 +1442,7 @@ plugin.createRule({
       defaultLevel: "error"
     },
     messages: {
-      errorListenInConnectedCallback: description$7
+      errorListenInConnectedCallback: description$8
     },
     type: "problem",
     schema: []
@@ -1477,18 +1477,18 @@ plugin.createRule({
     };
   }
 });
-const description$6 = `To ensure Hot Module Replacement (HMR) works correctly, the file that defines the Lumina component must not export anything other than the component. Exceptions: type-only exports, and the \`exportsForTests\` object for exposing additional things for usages in tests only`;
+const description$7 = `To ensure Hot Module Replacement (HMR) works correctly, the file that defines the Lumina component must not export anything other than the component. Exceptions: type-only exports, and the \`exportsForTests\` object for exposing additional things for usages in tests only`;
 plugin.createRule({
   name: "no-non-component-exports",
   meta: {
     docs: {
-      description: description$6,
+      description: description$7,
       defaultLevel: "warn"
     },
     messages: {
-      noNonComponentExports: description$6,
-      noDefaultExports: `Default exports are not allowed in files that export Lumina component - only named exports are allowed. ${description$6}`,
-      noExportAll: `\`export *\` exports are not allowed in files that export Lumina component - only named exports are allowed. ${description$6}`
+      noNonComponentExports: description$7,
+      noDefaultExports: `Default exports are not allowed in files that export Lumina component - only named exports are allowed. ${description$7}`,
+      noExportAll: `\`export *\` exports are not allowed in files that export Lumina component - only named exports are allowed. ${description$7}`
     },
     type: "problem",
     schema: []
@@ -1574,16 +1574,16 @@ plugin.createRule({
     };
   }
 });
-const description$5 = `Do not start public property names with "on" as that can confuse frameworks into thinking this property is an event`;
+const description$6 = `Do not start public property names with "on" as that can confuse frameworks into thinking this property is an event`;
 plugin.createRule({
   name: "no-property-name-start-with-on",
   meta: {
     docs: {
-      description: description$5,
+      description: description$6,
       defaultLevel: "error"
     },
     messages: {
-      noPropertyNameStartWithOn: description$5
+      noPropertyNameStartWithOn: description$6
     },
     type: "problem",
     schema: []
@@ -1617,7 +1617,7 @@ plugin.createRule({
   }
 });
 const baseDescription = `Avoid accidentally rendering "false" to the screen (Lit stringifies booleans, rather than drop them like React/Stencil).`;
-const description$4 = `${baseDescription}
+const description$5 = `${baseDescription}
 
 Lumina automatically handles some cases where "false" may get rendered to the screen, but the pattern this code is using is not handled.`;
 plugin.createRule({
@@ -1628,7 +1628,7 @@ plugin.createRule({
       defaultLevel: "warn"
     },
     messages: {
-      errorFalseRendered: description$4
+      errorFalseRendered: description$5
     },
     type: "problem",
     schema: [],
@@ -1670,6 +1670,96 @@ plugin.createRule({
     };
   }
 });
+const description$4 = `Avoid using type assertions like 'event.target as ...', 'event.currentTarget as ...', or 'event.detail as ...'. Instead, improve the event argument type to avoid the need for assertions.`;
+plugin.createRule({
+  name: "no-unnecessary-assertion-on-event",
+  meta: {
+    docs: {
+      description: description$4,
+      defaultLevel: "warn"
+    },
+    messages: {
+      needlessInlineJsxEventTypeAnnotation: "There is no need for this type annotation as JSX types already define event types.",
+      redundantTypeAssertion: "This type assertion is likely unnecessary.",
+      avoidTypeAssertion: "This type assertion might be avoidable if you improve the event argument type. See examples in https://qawebgis.esri.com/components/lumina/events#listening-to-events-on-children-components"
+    },
+    hasSuggestions: true,
+    fixable: "code",
+    type: "suggestion",
+    schema: []
+  },
+  defaultOptions: [],
+  create(context) {
+    const luminaJsxCheck = checkForLuminaJsx();
+    return {
+      ImportDeclaration: luminaJsxCheck,
+      TSAsExpression(node) {
+        if (!luminaJsxCheck.isLuminaJsx || node.expression.type !== AST_NODE_TYPES.MemberExpression || node.expression.object.type !== AST_NODE_TYPES.Identifier || node.expression.property.type !== AST_NODE_TYPES.Identifier || !["target", "currentTarget", "detail"].includes(node.expression.property.name)) {
+          return;
+        }
+        const eventVariableName = node.expression.object.name;
+        let parent = node.parent;
+        let functionParent = void 0;
+        while (parent != null) {
+          if (parent.type === AST_NODE_TYPES.FunctionExpression || parent.type === AST_NODE_TYPES.FunctionDeclaration || parent.type === AST_NODE_TYPES.ArrowFunctionExpression) {
+            functionParent = parent;
+            break;
+          }
+          parent = parent.parent;
+        }
+        if (functionParent === void 0) {
+          return;
+        }
+        const argument = functionParent.params.at(0);
+        if (argument === void 0 || argument.type !== AST_NODE_TYPES.Identifier || argument.name !== eventVariableName) {
+          return;
+        }
+        const reportPossiblyUnnecessaryTypeAssertion = () => context.report({
+          messageId: "redundantTypeAssertion",
+          node,
+          // If it is definitely unnecessary, it will be removed by
+          // the `@typescript-eslint/no-unnecessary-type-assertion` rule.
+          // So we only report as a suggestion for manual review.
+          suggest: [
+            {
+              messageId: "redundantTypeAssertion",
+              fix(fixer) {
+                return fixer.replaceTextRange(
+                  [node.range[0], node.range[1]],
+                  context.sourceCode.getText(node.expression)
+                );
+              }
+            }
+          ]
+        });
+        const isInlineListener = functionParent.parent.type === AST_NODE_TYPES.JSXExpressionContainer;
+        if (isInlineListener) {
+          if (argument.typeAnnotation === void 0) {
+            reportPossiblyUnnecessaryTypeAssertion();
+            return;
+          } else {
+            const typeAnnotation = argument.typeAnnotation;
+            context.report({
+              messageId: "needlessInlineJsxEventTypeAnnotation",
+              node: typeAnnotation,
+              fix(fixer) {
+                return fixer.remove(typeAnnotation);
+              }
+            });
+            return;
+          }
+        }
+        if (argument.typeAnnotation?.typeAnnotation.type === AST_NODE_TYPES.TSUnionType) {
+          return;
+        }
+        context.report({
+          messageId: "avoidTypeAssertion",
+          node
+        });
+      }
+    };
+  }
+});
 const description$3 = 'There is no need for { attribute: "name" } in @property() when attribute name is trivially inferrable from the property name';
 plugin.createRule({
   name: "no-unnecessary-attribute-name",

package/dist/plugins/lumina/rules/no-unnecessary-assertion-on-event.d.ts

@@ -0,0 +1,3 @@
+import { TSESLint } from '@typescript-eslint/utils';
+declare const _default: TSESLint.RuleModule<"needlessInlineJsxEventTypeAnnotation" | "redundantTypeAssertion" | "avoidTypeAssertion", [], import('../../utils/makePlugin').CommonDocs, TSESLint.RuleListener>;
+export default _default;

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

@@ -6,3 +6,9 @@
  * @see https://developer.mozilla.org/en-US/docs/Web/API/CustomElementRegistry/define#valid_custom_element_names
  */
 export declare const blockListedCustomElementNames: Set<string>;
+/**
+ * Simple check based on:
+ * - https://html.spec.whatwg.org/multipage/custom-elements.html#valid-custom-element-name
+ * - https://developer.mozilla.org/en-US/docs/Web/API/CustomElementRegistry/define#valid_custom_element_names
+ */
+export declare function isCustomElementTag(tag: string): boolean;

package/dist/plugins/webgis/index.js

@@ -1,4 +1,4 @@
-import { m as makeEslintPlugin } from "../../makePlugin-W-rZIyei.js";
+import { m as makeEslintPlugin } from "../../makePlugin-khyXfCm4.js";
 import { resolve } from "node:path/posix";
 import { AST_NODE_TYPES } from "@typescript-eslint/utils";
 const plugin = makeEslintPlugin(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/eslint-config",
-  "version": "4.33.0-next.94",
+  "version": "4.33.0-next.96",
   "description": "ESLint configuration for arcgis-web-components",
   "type": "module",
   "main": "index.js",
@@ -19,7 +19,7 @@
   ],
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "@arcgis/components-utils": "4.33.0-next.94",
+    "@arcgis/components-utils": "4.33.0-next.96",
     "@eslint/js": "^9.17.0",
     "@types/confusing-browser-globals": "^1.0.3",
     "confusing-browser-globals": "^1.0.11",