@arcgis/eslint-config 4.33.0-next.90 → 4.33.0-next.92

package/dist/{makePlugin-lsyutBw7.js → makePlugin-n5hoB6m9.js}

@@ -1,4 +1,4 @@
-const version = "4.33.0-next.90";
+const version = "4.33.0-next.92";
 function makeEslintPlugin(pluginName, rules) {
   const config = {
     rules: Object.fromEntries(

package/dist/plugins/lumina/index.js

@@ -1,6 +1,6 @@
 import { ESLintUtils, AST_NODE_TYPES, AST_TOKEN_TYPES } from "@typescript-eslint/utils";
 import ts from "typescript";
-import { m as makeEslintPlugin } from "../../makePlugin-lsyutBw7.js";
+import { m as makeEslintPlugin } from "../../makePlugin-n5hoB6m9.js";
 import { camelToKebab } from "@arcgis/components-utils";
 const createRule = ESLintUtils.RuleCreator(
   (rule) => `https://devtopia.esri.com/WebGIS/arcgis-web-components/tree/main/packages/support-packages/eslint-config/src/plugins/lumina/rules/${rule}.ts`
@@ -326,6 +326,81 @@ function inferTrivialType(member) {
   return "Other";
 }
 const builtInConverterTypes = /* @__PURE__ */ new Set(["Number", "Boolean", "Array", "Object"]);
+const banEvents = createRule({
+  name: "ban-events",
+  defaultOptions: [],
+  meta: {
+    docs: {
+      description: "This rule helps ban or warn against listened event types",
+      defaultLevel: "error"
+    },
+    messages: {
+      default: "{{message}}"
+    },
+    schema: {
+      type: "array",
+      items: {
+        anyOf: [
+          { type: "string" },
+          {
+            type: "object",
+            properties: {
+              event: { type: "string" },
+              message: {
+                type: "string",
+                minLength: 1
+              }
+            },
+            additionalProperties: false,
+            required: ["event"]
+          }
+        ]
+      },
+      uniqueItems: true
+    },
+    type: "problem"
+  },
+  create(context) {
+    const bannedEventToMessageLookup = /* @__PURE__ */ new Map();
+    context.options.forEach((option) => {
+      const event = typeof option === "string" ? option : option.event;
+      const message = typeof option === "string" ? null : option.message ?? null;
+      bannedEventToMessageLookup.set(event, message);
+    });
+    function buildMessage(eventName) {
+      return bannedEventToMessageLookup.get(eventName) ?? `${eventName} is not allowed`;
+    }
+    function checkEvent(node, eventName) {
+      if (bannedEventToMessageLookup.has(eventName)) {
+        context.report({
+          node,
+          messageId: "default",
+          data: {
+            message: buildMessage(eventName)
+          }
+        });
+      }
+    }
+    const luminaJsxCheck = checkForLuminaJsx();
+    return {
+      "ImportDeclaration": luminaJsxCheck,
+      "CallExpression:matches([callee.property.name=addEventListener], [callee.property.name=removeEventListener]), CallExpression[callee.object.type=ThisExpression][callee.property.name=listen]"(node) {
+        if (!luminaJsxCheck.isLuminaJsx) {
+          return;
+        }
+        const eventName = node.arguments[0].value;
+        checkEvent(node, eventName);
+      },
+      "CallExpression[callee.object.type=ThisExpression][callee.property.name=listenOn]"(node) {
+        if (!luminaJsxCheck.isLuminaJsx) {
+          return;
+        }
+        const eventName = node.arguments[1].value;
+        checkEvent(node, eventName);
+      }
+    };
+  }
+});
 const description$g = `Lumina component must be declared in a TSX file with a matching folder name located inside of src/components folder.`;
 const componentPlacementRules = createRule({
   name: "component-placement-rules",
@@ -1083,6 +1158,65 @@ const memberOrdering = createRule({
     }
   })
 });
+const blockListedCustomElementNames = /* @__PURE__ */ new Set([
+  "annotation-xml",
+  "color-profile",
+  "font-face",
+  "font-face-src",
+  "font-face-uri",
+  "font-face-format",
+  "font-face-name",
+  "missing-glyph"
+]);
+const noCreateElementComponent = createRule({
+  name: "no-create-element-component",
+  defaultOptions: [],
+  meta: {
+    docs: {
+      description: "This rule ensures that components are not created with `document.createElement()` to ensure imports are tracked by the compiler.",
+      defaultLevel: "error"
+    },
+    fixable: "code",
+    messages: {
+      default: "Use JSX instead of `document.createElement()` to create components.\nDetails: https://qawebgis.esri.com/components/lumina/jsx#rendering-jsx-outside-the-component"
+    },
+    schema: [],
+    type: "problem"
+  },
+  create(context) {
+    const luminaJsxCheck = checkForLuminaJsx();
+    return {
+      ImportDeclaration: luminaJsxCheck,
+      CallExpression(node) {
+        if (!luminaJsxCheck.isLuminaJsx) {
+          return;
+        }
+        if (isCreateElementComponent(node)) {
+          return void context.report({
+            node,
+            messageId: "default"
+          });
+        }
+      }
+    };
+  }
+});
+function isCreateElementComponent(node) {
+  if (!(node.callee?.type === AST_NODE_TYPES.MemberExpression && node.callee?.object?.type === AST_NODE_TYPES.Identifier && node.callee?.object?.name === "document" && node.callee?.property?.type === AST_NODE_TYPES.Identifier && node.callee?.property?.name === "createElement" && node.arguments.length >= 1)) {
+    return false;
+  }
+  const localNameArg = node.arguments[0];
+  if (localNameArg.type === AST_NODE_TYPES.Literal && typeof localNameArg.value === "string") {
+    return isCustomElementTag(localNameArg.value);
+  }
+  if (localNameArg.type === AST_NODE_TYPES.TemplateLiteral && localNameArg.expressions.length === 0) {
+    return isCustomElementTag(localNameArg.quasis[0].value.raw);
+  }
+  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 noIgnoreJsDocTag = createRule({
   name: "no-ignore-jsdoc-tag",
@@ -1930,26 +2064,18 @@ declare global {
     };
   }
 });
-const blockListedCustomElementNames = /* @__PURE__ */ new Set([
-  "annotation-xml",
-  "color-profile",
-  "font-face",
-  "font-face-src",
-  "font-face-uri",
-  "font-face-format",
-  "font-face-name",
-  "missing-glyph"
-]);
 const tagNameToNormalizedClassName = (tagName) => tagName.replaceAll("-", "").toLowerCase();
 const reCustomElementName = /^[a-z]+(?:-[a-z\d]+)+$/u;
 const luminaPlugin = makeEslintPlugin("lumina", {
   "add-missing-jsx-import": addMissingJsxImport,
   "auto-add-type": autoAddType,
+  "ban-events": banEvents,
   "component-placement-rules": componentPlacementRules,
   "consistent-event-naming": consistentEventNaming,
   "decorators-context": decoratorsContext,
   "explicit-setter-type": explicitSetterType,
   "member-ordering": memberOrdering,
+  "no-create-element-component": noCreateElementComponent,
   "no-ignore-jsdoc-tag": noIgnoreJsDocTag,
   "no-incorrect-dynamic-tag-name": noIncorrectDynamicTagName,
   "no-inline-arrow-in-ref": noInlineArrowInRef,

package/dist/plugins/lumina/rules/ban-events.d.ts

@@ -0,0 +1,6 @@
+type Options = (string | {
+    event: string;
+    message?: string;
+})[];
+export declare const banEvents: import('@typescript-eslint/utils/ts-eslint').RuleModule<"default", Options, import('../../utils/makePlugin').CommonDocs, import('@typescript-eslint/utils/ts-eslint').RuleListener>;
+export {};

package/dist/plugins/lumina/rules/no-create-element-component.d.ts

@@ -0,0 +1 @@
+export declare const noCreateElementComponent: import('@typescript-eslint/utils/ts-eslint').RuleModule<"default", [], import('../../utils/makePlugin').CommonDocs, import('@typescript-eslint/utils/ts-eslint').RuleListener>;

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

@@ -0,0 +1,8 @@
+/**
+ * Although most native elements do not contain dashes inside, there are a
+ * few exceptions. Explicitly declaring a custom element by this name is
+ * forbidden
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/CustomElementRegistry/define#valid_custom_element_names
+ */
+export declare const blockListedCustomElementNames: Set<string>;

package/dist/plugins/webgis/index.js

@@ -1,4 +1,4 @@
-import { m as makeEslintPlugin } from "../../makePlugin-lsyutBw7.js";
+import { m as makeEslintPlugin } from "../../makePlugin-n5hoB6m9.js";
 import { ESLintUtils, AST_NODE_TYPES } from "@typescript-eslint/utils";
 import { resolve } from "node:path/posix";
 const isTestFile = (filePath) => filePath.includes("/test") || filePath.includes(".test") || filePath.includes(".spec") || filePath.includes("e2e") || filePath.includes("__") || filePath.includes("/.");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/eslint-config",
-  "version": "4.33.0-next.90",
+  "version": "4.33.0-next.92",
   "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.90",
+    "@arcgis/components-utils": "4.33.0-next.92",
     "@eslint/js": "^9.17.0",
     "@types/confusing-browser-globals": "^1.0.3",
     "confusing-browser-globals": "^1.0.11",