@arcgis/eslint-config 5.1.0-next.87 → 5.1.0-next.89

package/dist/config/lumina.js

@@ -34,7 +34,11 @@ const storybookConfig = [
       // We never used storiesOf, and it's no longer included in Storybook
       "storybook/no-stories-of": "off",
       // Redundant with TypeScript
-      "storybook/context-in-play-function": "off"
+      "storybook/context-in-play-function": "off",
+      // Enforces writing satisfies Meta after the meta object definition to ensure that stories use the correct properties in the metadata.
+      "storybook/meta-satisfies-type": "error",
+      // In our Lumina stories, render args should infer from Meta<T>/StoryObj<T>.
+      "webgis/no-story-render-args-type-annotation": "error"
     }
   }
 ];

package/dist/{estree-Blx7w727.js → estree-Cg4iVsEi.js}

@@ -1,5 +1,5 @@
 import { ESLintUtils, AST_NODE_TYPES } from "@typescript-eslint/utils";
-const version = "5.1.0-next.87";
+const version = "5.1.0-next.89";
 const packageJson = {
   version
 };

package/dist/plugins/lumina/index.js

@@ -1,4 +1,4 @@
-import { m as makeEslintPlugin, l as luminaJsxExportName, a as luminaEntrypointName, b as luminaTestEntrypointName, s as sourceCodeDeclaresComponent, p as parsePropertyDecorator, c as getProperty, i as isGetterWithoutSetter, e as extractDeclareElementsInterface, d as isCreateEvent, h as hasDecorator, f as getName, j as checkForLuminaJsx, k as isBindThisCallee, g as getComponentDeclaration, u as unwrapExpression } from "../../estree-Blx7w727.js";
+import { m as makeEslintPlugin, l as luminaJsxExportName, a as luminaEntrypointName, b as luminaTestEntrypointName, s as sourceCodeDeclaresComponent, p as parsePropertyDecorator, c as getProperty, i as isGetterWithoutSetter, e as extractDeclareElementsInterface, d as isCreateEvent, h as hasDecorator, f as getName, j as checkForLuminaJsx, k as isBindThisCallee, g as getComponentDeclaration, u as unwrapExpression } from "../../estree-Cg4iVsEi.js";
 import { AST_NODE_TYPES, ESLintUtils, AST_TOKEN_TYPES } from "@typescript-eslint/utils";
 import ts from "typescript";
 import { camelToKebab } from "@arcgis/toolkit/string";

package/dist/plugins/webgis/index.js

@@ -1,4 +1,4 @@
-import { m as makeEslintPlugin, e as extractDeclareElementsInterface, g as getComponentDeclaration } from "../../estree-Blx7w727.js";
+import { m as makeEslintPlugin, e as extractDeclareElementsInterface, g as getComponentDeclaration } from "../../estree-Cg4iVsEi.js";
 import { resolve } from "path/posix";
 import { AST_NODE_TYPES } from "@typescript-eslint/utils";
 const plugin = makeEslintPlugin(
@@ -7,16 +7,16 @@ const plugin = makeEslintPlugin(
 );
 const isTestFile = (filePath) => filePath.includes("/test") || filePath.includes(".test") || filePath.includes(".spec") || filePath.includes("e2e") || filePath.includes("__") || filePath.includes("/.");
 const isStorybookFile = (filePath) => filePath.includes(".stories");
-const description$5 = `Imports of files outside the src/ folder are not-portable and likely to break for consumers of this package.`;
+const description$6 = `Imports of files outside the src/ folder are not-portable and likely to break for consumers of this package.`;
 plugin.createRule({
   name: "no-import-outside-src",
   meta: {
     docs: {
-      description: description$5,
+      description: description$6,
       defaultLevel: "error"
     },
     messages: {
-      noImportOutsideSrc: description$5
+      noImportOutsideSrc: description$6
     },
     type: "problem",
     schema: []
@@ -50,16 +50,16 @@ plugin.createRule({
     };
   }
 });
-const description$4 = `Having two JSDoc comments next to each other is most likely a mistake - consider combining them into one, or separating them for clarity.`;
+const description$5 = `Having two JSDoc comments next to each other is most likely a mistake - consider combining them into one, or separating them for clarity.`;
 plugin.createRule({
   name: "no-touching-jsdoc",
   meta: {
     docs: {
-      description: description$4,
+      description: description$5,
       defaultLevel: "warn"
     },
     messages: {
-      noTouchingJsDoc: description$4
+      noTouchingJsDoc: description$5
     },
     type: "problem",
     schema: []
@@ -95,17 +95,17 @@ plugin.createRule({
   }
 });
 const reTouchingJsDoc = /\*\/\s+\/\*\*/gu;
-const description$3 = `@arcgis/core imports need to end with .js for better compatibility with ESM CDN builds for @arcgis/core and other packages.`;
+const description$4 = `@arcgis/core imports need to end with .js for better compatibility with ESM CDN builds for @arcgis/core and other packages.`;
 const packagesToEnforce = ["@arcgis/core/", "@amcharts/amcharts4/", "@amcharts/amcharts5/"];
 plugin.createRule({
   name: "require-js-in-imports",
   meta: {
     docs: {
-      description: description$3,
+      description: description$4,
       defaultLevel: "warn"
     },
     messages: {
-      requireJsInCoreImport: description$3
+      requireJsInCoreImport: description$4
     },
     type: "problem",
     fixable: "code",
@@ -139,17 +139,17 @@ plugin.createRule({
     };
   }
 });
-const description$2 = "Using .d.ts files is discouraged. Prefer .ts files instead, as they are type-checked and not in global scope.";
+const description$3 = "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", "components.d.ts"]);
 plugin.createRule({
   name: "no-dts-files",
   meta: {
     docs: {
-      description: description$2,
+      description: description$3,
       defaultLevel: "warn"
     },
     messages: {
-      avoidDtsFiles: description$2
+      avoidDtsFiles: description$3
     },
     type: "suggestion",
     schema: []
@@ -179,12 +179,12 @@ plugin.createRule({
     };
   }
 });
-const description$1 = `Enforce consistent logging so that ArcGIS developers can easily debug errors or warnings logged by our web components, which may lack a meaningful context in compiled code. See [our documentation on @arcgis/toolkit/log](https://webgis.esri.com/references/toolkit/log).`;
+const description$2 = `Enforce consistent logging so that ArcGIS developers can easily debug errors or warnings logged by our web components, which may lack a meaningful context in compiled code. See [our documentation on @arcgis/toolkit/log](https://webgis.esri.com/references/toolkit/log).`;
 plugin.createRule({
   name: "consistent-logging",
   meta: {
     docs: {
-      description: description$1,
+      description: description$2,
       defaultLevel: "off"
       // NOTE: this is turned on conditionally in root eslint config
     },
@@ -217,16 +217,16 @@ plugin.createRule({
     };
   }
 });
-const description = `Do not use links like [](#something) as they are not portable across .d.ts, and are not validated at build time. Use {@link } syntax, or absolute links. See https://webgis.esri.com/webgis/core/core/documenting-api#link`;
+const description$1 = `Do not use links like [](#something) as they are not portable across .d.ts, and are not validated at build time. Use {@link } syntax, or absolute links. See https://webgis.esri.com/webgis/core/core/documenting-api#link`;
 plugin.createRule({
   name: "no-unsafe-hash-links",
   meta: {
     docs: {
-      description,
+      description: description$1,
       defaultLevel: "warn"
     },
     messages: {
-      error: description
+      error: description$1
     },
     type: "problem",
     schema: [],
@@ -272,6 +272,47 @@ function computeReplacement(declareElementsInterface, anchor) {
   const tagName = declaration.key.value;
   return `components/${tagName}#${anchor}`;
 }
+const description = "In Storybook render functions, let `args` infer from `Meta<T>` or `StoryObj<T>` instead of annotating the render parameter.";
+plugin.createRule({
+  name: "no-story-render-args-type-annotation",
+  meta: {
+    docs: {
+      description,
+      defaultLevel: "off"
+    },
+    messages: {
+      noStoryRenderArgsTypeAnnotation: "Do not annotate `render(args)` in stories. Type the story with `Meta<T>` or `StoryObj<T>` and let `args` infer from that."
+    },
+    schema: [],
+    type: "suggestion",
+    fixable: "code"
+  },
+  defaultOptions: [],
+  create(context) {
+    if (!isStorybookFile(context.filename)) {
+      return {};
+    }
+    return {
+      Property(node) {
+        if (!isRenderProperty(node)) {
+          return;
+        }
+        const [firstParameter] = node.value.params;
+        if (firstParameter?.type !== AST_NODE_TYPES.Identifier || firstParameter.typeAnnotation === void 0) {
+          return;
+        }
+        context.report({
+          node: firstParameter.typeAnnotation,
+          messageId: "noStoryRenderArgsTypeAnnotation",
+          fix: (fixer) => fixer.remove(firstParameter.typeAnnotation)
+        });
+      }
+    };
+  }
+});
+function isRenderProperty(node) {
+  return node.key.type === AST_NODE_TYPES.Identifier && node.key.name === "render" && (node.value.type === AST_NODE_TYPES.ArrowFunctionExpression || node.value.type === AST_NODE_TYPES.FunctionExpression);
+}
 const webgisPlugin = plugin.finalize();
 export {
   webgisPlugin

package/dist/plugins/webgis/rules/no-story-render-args-type-annotation.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/eslint-config",
-  "version": "5.1.0-next.87",
+  "version": "5.1.0-next.89",
   "description": "ESLint configuration for WebGIS SDK",
   "type": "module",
   "exports": {
@@ -32,7 +32,7 @@
     "tslib": "^2.8.1",
     "typescript": "~6.0.2",
     "typescript-eslint": "^8.58.0",
-    "@arcgis/toolkit": "5.1.0-next.87"
+    "@arcgis/toolkit": "5.1.0-next.89"
   },
   "peerDependencies": {
     "eslint": "^10.2.0"