@arcgis/eslint-config 5.0.0-next.84 → 5.0.0-next.86

package/dist/config/index.js

@@ -406,7 +406,7 @@ const defaultConfig = [
         }
       ],
       "@typescript-eslint/consistent-type-exports": ["warn", { fixMixedExportsWithInlineTypeSpecifier: true }],
-      "@typescript-eslint/consistent-type-imports": "warn",
+      "@typescript-eslint/no-import-type-side-effects": "error",
       "default-param-last": "off",
       // `undefined` can also be used to trigger default value
       "@typescript-eslint/default-param-last": "off",

package/dist/{makePlugin-DB-DfawG.js → makePlugin-DM-pwv8Z.js}

@@ -1,5 +1,5 @@
 import { ESLintUtils } from "@typescript-eslint/utils";
-const version = "5.0.0-next.84";
+const version = "5.0.0-next.86";
 const packageJson = {
   version
 };

package/dist/plugins/lumina/index.js

@@ -1,4 +1,4 @@
-import { m as makeEslintPlugin } from "../../makePlugin-DB-DfawG.js";
+import { m as makeEslintPlugin } from "../../makePlugin-DM-pwv8Z.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 } from "../../makePlugin-DB-DfawG.js";
+import { m as makeEslintPlugin } from "../../makePlugin-DM-pwv8Z.js";
 import { resolve } from "path/posix";
 import { AST_NODE_TYPES } from "@typescript-eslint/utils";
 const plugin = makeEslintPlugin(
@@ -6,16 +6,16 @@ const plugin = makeEslintPlugin(
   (rule) => `https://devtopia.esri.com/WebGIS/arcgis-web-components/tree/main/packages/support-packages/eslint-config/src/plugins/webgis/rules/${rule}.ts`
 );
 const isTestFile = (filePath) => filePath.includes("/test") || filePath.includes(".test") || filePath.includes(".spec") || filePath.includes("e2e") || filePath.includes("__") || filePath.includes("/.");
-const description$3 = `Imports of files outside the src/ folder are not-portable and likely to break for consumers of this package.`;
+const description$4 = `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$3,
+      description: description$4,
       defaultLevel: "error"
     },
     messages: {
-      noImportOutsideSrc: description$3
+      noImportOutsideSrc: description$4
     },
     type: "problem",
     schema: []
@@ -49,16 +49,16 @@ plugin.createRule({
     };
   }
 });
-const description$2 = `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$3 = `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$2,
+      description: description$3,
       defaultLevel: "warn"
     },
     messages: {
-      noTouchingJsDoc: description$2
+      noTouchingJsDoc: description$3
     },
     type: "problem",
     schema: []
@@ -94,17 +94,17 @@ plugin.createRule({
   }
 });
 const reTouchingJsDoc = /\*\/\s+\/\*\*/gu;
-const description$1 = `@arcgis/core imports need to end with .js for better compatibility with ESM CDN builds for @arcgis/core and other packages.`;
+const description$2 = `@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$1,
+      description: description$2,
       defaultLevel: "warn"
     },
     messages: {
-      requireJsInCoreImport: description$1
+      requireJsInCoreImport: description$2
     },
     type: "problem",
     fixable: "code",
@@ -138,17 +138,17 @@ plugin.createRule({
     };
   }
 });
-const description = "Using .d.ts files is discouraged. Prefer .ts files instead, as they are type-checked and not in global scope.";
+const description$1 = "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: description$1,
       defaultLevel: "warn"
     },
     messages: {
-      avoidDtsFiles: description
+      avoidDtsFiles: description$1
     },
     type: "suggestion",
     schema: []
@@ -178,6 +178,41 @@ plugin.createRule({
     };
   }
 });
+const description = `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,
+      defaultLevel: "off"
+      // NOTE: this is turned on conditionally in root eslint config
+    },
+    messages: {
+      consistentLoggingWarning: `For consistency, use the log utility from @arcgis/toolkit/log instead of console.{{logMethodName}}.`
+    },
+    schema: [],
+    fixable: void 0,
+    type: "suggestion"
+  },
+  defaultOptions: [],
+  create(context) {
+    return {
+      // NOTE: CallExpression is not enough. Use MemberExpression to handle callbacks, e.g. .catch(console.error)
+      MemberExpression(node) {
+        if (node.type === AST_NODE_TYPES.MemberExpression && node.object.type === AST_NODE_TYPES.Identifier && node.object.name === "console" && node.property.type === AST_NODE_TYPES.Identifier) {
+          const logMethodName = node.property.name;
+          context.report({
+            node,
+            messageId: "consistentLoggingWarning",
+            data: {
+              logMethodName
+            }
+          });
+        }
+      }
+    };
+  }
+});
 const webgisPlugin = plugin.finalize();
 export {
   webgisPlugin

package/dist/plugins/webgis/rules/consistent-logging.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('@typescript-eslint/utils/ts-eslint').RuleModule<"consistentLoggingWarning", [], 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.0.0-next.84",
+  "version": "5.0.0-next.86",
   "description": "ESLint configuration for arcgis-web-components",
   "type": "module",
   "main": "index.js",
@@ -20,7 +20,7 @@
   ],
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "@arcgis/toolkit": "5.0.0-next.84",
+    "@arcgis/toolkit": "5.0.0-next.86",
     "@eslint/js": "^9.39.1",
     "@eslint/markdown": "^7.5.1",
     "@types/confusing-browser-globals": "^1.0.3",