@arcgis/eslint-config 5.2.0-next.0 → 5.2.0-next.1

package/dist/config/applications.d.ts

@@ -1,10 +1,3 @@
-/**
- * While the main index.js config strives to be comprehensive, this config
- * disables rules that are less important for applications compared to libraries.
- */
-declare const _default: (import('eslint/config').Config | {
-    files: string[];
-    name?: string;
-    rules?: object;
-})[];
+import { TSESLint } from '@typescript-eslint/utils';
+declare const _default: TSESLint.FlatConfig.Config[];
 export default _default;

package/dist/config/applications.js

@@ -1,6 +1,6 @@
-import defaultConfig from "./index.js";
+import config from "./index.js";
 const applications = [
-  ...defaultConfig,
+  ...config,
   {
     rules: {
       // Not autofixable. Can be annoying

package/dist/config/index.d.ts

@@ -1,23 +1,3 @@
-/**
- * See setup documentation & rationale behind ESLint:
- * https://webgis.esri.com/references/support-packages/eslint
- *
- * Some advice on editing rules:
- * - prioritize autofixable rules to make adoption in existing codebases easier
- * - disable redundant rules (rules redundant with TypeScript, or each other),
- *   to reduce noise and performance impact
- * - if rule is always auto-fixable, it may be a good idea to emit it as a
- *   warning instead of an error to be less disruptive when the developer is
- *   typing code
- * - emit rules that have a lot of false positives as warnings instead of errors
- * - provide justification for enabling opinionated rules
- * - provide justification for disabling default rules
- * - if rule is disabled because it's buggy, describe how so
- *   (code sample, GitHub issue, permalink to file, etc)
- */
-declare const _default: (import('eslint/config').Config | {
-    files: string[];
-    name?: string;
-    rules?: object;
-})[];
-export default _default;
+import { TSESLint } from '@typescript-eslint/utils';
+declare const config: TSESLint.FlatConfig.ConfigArray;
+export default config;

package/dist/config/index.js

@@ -6,23 +6,25 @@ import { webgisPlugin } from "../plugins/webgis/index.js";
 import { globalIgnores } from "eslint/config";
 import markdown from "@eslint/markdown";
 import packageJson from "eslint-plugin-package-json";
+import { importX } from "eslint-plugin-import-x";
 const packageJsonSortableCollections = packageJson.rules["sort-collections"].meta.defaultOptions[0].filter(
   (collection) => !["scripts", "exports"].includes(collection)
 ) ?? [];
-const defaultConfig = [
+const config = [
   globalIgnores(["**/www", "**/dist", "**/assets", "**/coverage", "**/.docs"]),
   {
     files: ["**/*.js", "**/*.mjs", "**/*.cjs"],
     ...eslint.configs.recommended
   },
-  ...[...tsEslint.configs.strictTypeChecked, ...tsEslint.configs.stylisticTypeChecked].map((config) => ({
-    ...config,
+  ...[...tsEslint.configs.strictTypeChecked, ...tsEslint.configs.stylisticTypeChecked].map((config2) => ({
+    ...config2,
     files: ["**/*.ts", "**/*.tsx"]
   })),
   {
     ...webgisPlugin.configs.recommended,
     files: ["**/*.ts", "**/*.tsx"]
   },
+  importX.flatConfigs.typescript,
   {
     files: ["**/*.ts", "**/*.tsx"],
     linterOptions: {
@@ -653,5 +655,5 @@ const defaultConfig = [
   }
 ];
 export {
-  defaultConfig as default
+  config as default
 };

package/dist/{estree-D4NC8KvY.js → estree-CqRqIhAW.js}

@@ -1,5 +1,5 @@
 import { ESLintUtils, AST_NODE_TYPES } from "@typescript-eslint/utils";
-const version = "5.2.0-next.0";
+const version = "5.2.0-next.1";
 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-D4NC8KvY.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-CqRqIhAW.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-D4NC8KvY.js";
+import { m as makeEslintPlugin, e as extractDeclareElementsInterface, g as getComponentDeclaration } from "../../estree-CqRqIhAW.js";
 import { resolve } from "path/posix";
 import { AST_NODE_TYPES } from "@typescript-eslint/utils";
 const plugin = makeEslintPlugin(

package/dist/utils/defineBoundaries.d.ts

@@ -0,0 +1,44 @@
+import { TSESLint } from '@typescript-eslint/utils';
+/**
+ * Restrict which parts of the package can import what packages.
+ *
+ * @public
+ */
+export interface Boundaries<BoundaryNames extends string, DependencyNames extends string> {
+    /**
+     * List all dependencies that may be imported in src/.
+     *
+     * @public
+     */
+    dependencyNames: readonly DependencyNames[];
+    /**
+     * Define the boundaries within the package and their allowed dependencies.
+     * Boundary name must start with `./` and be a path relative to the src/ folder.
+     * For example, `./components`
+     *
+     * @public
+     */
+    boundaries: Record<BoundaryNames, Boundary<BoundaryNames, DependencyNames>>;
+}
+/** @public */
+export type Boundary<BoundaryNames extends string, DependencyNames extends string> = {
+    /**
+     * Dependencies this boundary may import.
+     *
+     * @public
+     */
+    allowedDependencies: readonly DependencyNames[];
+    /**
+     * Boundaries this boundary may import.
+     *
+     * @public
+     */
+    allowedBoundaries: readonly BoundaryNames[];
+};
+/**
+ * @param boundaries
+ * @param monorepoRoot
+ * @param basePath example: "packages/ai-packages/ai-components/src"
+ * @public
+ */
+export declare function boundariesToEslintRules(boundaries: Boundaries<string, string>, monorepoRoot: string, basePath: string, message: string): TSESLint.FlatConfig.Config[];

package/dist/utils/defineBoundaries.js

@@ -0,0 +1,50 @@
+function boundariesToEslintRules(boundaries, monorepoRoot, basePath, message) {
+  const boundaryNames = Object.keys(boundaries.boundaries);
+  const boundaryEntries = Object.entries(boundaries.boundaries);
+  return [
+    {
+      files: [`${basePath}/**/*.+(ts|tsx)`],
+      rules: {
+        "import-x/no-restricted-paths": [
+          "error",
+          {
+            basePath: `${monorepoRoot}${basePath}`,
+            zones: boundaryEntries.flatMap(
+              ([boundaryName, boundary]) => boundaryNames.filter((name) => name !== boundaryName && !boundary.allowedBoundaries.includes(name)).map((targetBoundary) => ({
+                from: targetBoundary,
+                target: boundaryName,
+                message
+              }))
+            )
+          }
+        ]
+      }
+    },
+    ...boundaryEntries.flatMap(([boundaryName, boundary]) => {
+      const blockedDependencies = boundaries.dependencyNames.filter(
+        (dependency) => !boundary.allowedDependencies.includes(dependency)
+      );
+      return blockedDependencies.length === 0 ? [] : [
+        {
+          files: [`${basePath}/${boundaryName.slice(2)}/**/*.+(ts|tsx)`],
+          rules: {
+            "@typescript-eslint/no-restricted-imports": [
+              "error",
+              {
+                patterns: [
+                  {
+                    group: blockedDependencies.map((dependency) => `/${dependency}`),
+                    message
+                  }
+                ]
+              }
+            ]
+          }
+        }
+      ];
+    })
+  ];
+}
+export {
+  boundariesToEslintRules
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/eslint-config",
-  "version": "5.2.0-next.0",
+  "version": "5.2.0-next.1",
   "description": "ESLint configuration for WebGIS SDK",
   "type": "module",
   "exports": {
@@ -10,7 +10,8 @@
     "./lumina": "./dist/config/lumina.js",
     "./plugins/webgis": "./dist/plugins/webgis/index.js",
     "./plugins/lumina": "./dist/plugins/lumina/index.js",
-    "./utils/disable-rules": "./dist/utils/disable-rules.js",
+    "./utils/defineBoundaries": "./dist/utils/defineBoundaries.js",
+    "./utils/disableRules": "./dist/utils/disableRules.js",
     "./package.json": "./package.json"
   },
   "files": [
@@ -23,6 +24,8 @@
     "@types/confusing-browser-globals": "^1.0.3",
     "@typescript-eslint/utils": "^8.58.0",
     "confusing-browser-globals": "^1.0.11",
+    "eslint-import-resolver-typescript": "^4.4.4",
+    "eslint-plugin-import-x": "^4.16.2",
     "eslint-plugin-package-json": "~0.91.1",
     "eslint-plugin-storybook": "^10.3.4",
     "globals": "^16.5.0",
@@ -30,7 +33,7 @@
     "tslib": "^2.8.1",
     "typescript": "~6.0.2",
     "typescript-eslint": "^8.58.0",
-    "@arcgis/toolkit": "5.2.0-next.0"
+    "@arcgis/toolkit": "5.2.0-next.1"
   },
   "peerDependencies": {
     "eslint": "^10.2.0"