test(client): examples lint config (#23344)

to expect non-internal exports

Use /legacy for most imports, but some /beta and /alpha.
In example-utils modelLoader, use tinylicious-driver /test-utils.
(example-utils readme notes it has non-production code.)

Copied implementation of `delay` from `core-utils` to avoid `/internal`
import.

Skipped some packages per internal API use:
- apps/presence-tracker (pending rewrite in #23020)
- benchmarks/odspsnapshotfetch-perftestapp
- utils/bundle-size-tests
- utils/webpack-fluid-loader

There are a number of /internal imports that are suppressed.
packages with imported internals:
- cell (x3)
[AB#26903](https://dev.azure.com/fluidframework/235294da-091d-4c29-84fc-cdfc3d90890b/_workitems/edit/26903)
- container-loader (x1)
[AB#26907](https://dev.azure.com/fluidframework/235294da-091d-4c29-84fc-cdfc3d90890b/_workitems/edit/26907)
- core-interfaces (x1)
[AB#26908](https://dev.azure.com/fluidframework/235294da-091d-4c29-84fc-cdfc3d90890b/_workitems/edit/26908)
- fluid-static (x1)
[AB#26986](https://dev.azure.com/fluidframework/235294da-091d-4c29-84fc-cdfc3d90890b/_workitems/edit/26986)
- local-driver (x3)
[AB#26987](https://dev.azure.com/fluidframework/235294da-091d-4c29-84fc-cdfc3d90890b/_workitems/edit/26987)
- merge-tree (x3)
[AB#26905](https://dev.azure.com/fluidframework/235294da-091d-4c29-84fc-cdfc3d90890b/_workitems/edit/26905)
- sequence (x8)
[AB#26904](https://dev.azure.com/fluidframework/235294da-091d-4c29-84fc-cdfc3d90890b/_workitems/edit/26904)
- test-runtime-utils (x2)
[AB#26985](https://dev.azure.com/fluidframework/235294da-091d-4c29-84fc-cdfc3d90890b/_workitems/edit/26985)
- test-utils (x7)
[AB#26906](https://dev.azure.com/fluidframework/235294da-091d-4c29-84fc-cdfc3d90890b/_workitems/edit/26906)

Author: jason-ha

examples/.eslintrc.cjs

@@ -0,0 +1,13 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+// NOTE: this file isn't recognized by eslint automatically in this location.
+// Packages that want to leverage it should extend from it in their local
+// `.eslintrc.cjs` and normally after other configurations; so that these
+// rules get priority.
+
+const { lintConfig } = require("./.eslintrc.data.cjs");
+
+module.exports = lintConfig;

examples/.eslintrc.data.cjs

@@ -0,0 +1,71 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+// To facilitate reuse of configuration elements this module exports some
+// pieces of configuration and composed configuration.
+
+const importInternalModulesAllowed = [
+	// Allow import of Fluid Framework external API exports.
+	"@fluidframework/*/{beta,alpha,legacy}",
+	"fluid-framework/{beta,alpha,legacy}",
+
+	// Experimental package APIs and exports are unknown, so allow any imports from them.
+	"@fluid-experimental/**",
+
+	// Within examples allow import of Fluid Framework non-production test-utils APIs.
+	"@fluidframework/*/test-utils",
+
+	// Within examples assume and allow a progressive API pattern (no legacy).
+	"@fluid-example/*/{beta,alpha}",
+
+	// Allow imports from sibling and ancestral sibling directories,
+	// but not from cousin directories. Parent is allowed but only
+	// because there isn't a known way to deny it.
+	"*/index.js",
+];
+
+const importInternalModulesAllowedForTest = importInternalModulesAllowed.concat([
+	// TODO #26906: `test-utils` internal used in examples (test)
+	// Should `test-utils` provide support through `/test-utils` instead of `/internal`?
+	"@fluidframework/test-utils/internal",
+
+	// Allow internal reaching within test directories.
+	// (And also some external packages that aren't setup as modules.)
+	"*/*.js",
+]);
+
+const lintConfig = {
+	rules: {
+		/**
+		 * Allow Fluid Framework examples to import from unstable and legacy APIs.
+		 * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-internal-modules.md
+		 */
+		"import/no-internal-modules": [
+			"error",
+			{
+				allow: importInternalModulesAllowed,
+			},
+		],
+	},
+	overrides: [
+		{
+			files: ["*.spec.ts", "src/test/**", "tests/**"],
+			rules: {
+				"import/no-internal-modules": [
+					"error",
+					{
+						allow: importInternalModulesAllowedForTest,
+					},
+				],
+			},
+		},
+	],
+};
+
+module.exports = {
+	importInternalModulesAllowed: importInternalModulesAllowed,
+	importInternalModulesAllowedForTest: importInternalModulesAllowedForTest,
+	lintConfig: lintConfig,
+};

examples/apps/ai-collab/.eslintrc.cjs

@@ -3,30 +3,30 @@
  * Licensed under the MIT License.
  */
 
+const { importInternalModulesAllowed } = require("../../.eslintrc.data.cjs");
+
 module.exports = {
-	extends: [require.resolve("@fluidframework/eslint-config-fluid/recommended"), "prettier"],
+	extends: [
+		require.resolve("@fluidframework/eslint-config-fluid/recommended"),
+		"prettier",
+		"../../.eslintrc.cjs",
+	],
 	parserOptions: {
 		project: ["./tsconfig.json"],
 	},
 	rules: {
 		"import/no-internal-modules": [
 			"error",
 			{
-				allow: [
-					"@fluidframework/odsp-client/beta",
-					"@fluidframework/tree/alpha",
-
+				allow: importInternalModulesAllowed.concat([
 					// NextJS requires reaching to its internal modules
 					"next/**",
 
 					// Path aliases
 					"@/actions/**",
 					"@/types/**",
 					"@/components/**",
-
-					// Experimental package APIs and exports are unknown, so allow any imports from them.
-					"@fluidframework/ai-collab/alpha",
-				],
+				]),
 			},
 		],
 		// This is an example/test app; all its dependencies are dev dependencies so as not to pollute the lockfile

examples/apps/attributable-map/.eslintrc.cjs

@@ -4,7 +4,11 @@
  */
 
 module.exports = {
-	extends: [require.resolve("@fluidframework/eslint-config-fluid"), "prettier"],
+	extends: [
+		require.resolve("@fluidframework/eslint-config-fluid"),
+		"prettier",
+		"../../.eslintrc.cjs",
+	],
 	rules: {
 		"@fluid-internal/fluid/no-unchecked-record-access": "warn",
 	},

examples/apps/attributable-map/src/containerCode.ts

@@ -5,8 +5,8 @@
 
 import { getDataStoreEntryPoint } from "@fluid-example/example-utils";
 import { IProvideRuntimeAttributor, IRuntimeAttributor } from "@fluid-experimental/attributor";
-import { IContainer } from "@fluidframework/container-definitions/internal";
-import { IContainerRuntime } from "@fluidframework/container-runtime-definitions/internal";
+import { IContainer } from "@fluidframework/container-definitions/legacy";
+import { IContainerRuntime } from "@fluidframework/container-runtime-definitions/legacy";
 import { FluidObject } from "@fluidframework/core-interfaces";
 
 import { HitCounter } from "./dataObject.js";

examples/apps/attributable-map/src/dataObject.ts

@@ -5,7 +5,7 @@
 
 import type { EventEmitter } from "@fluid-example/example-utils";
 import { AttributableMap, ISharedMap } from "@fluid-experimental/attributable-map";
-import { DataObject, DataObjectFactory } from "@fluidframework/aqueduct/internal";
+import { DataObject, DataObjectFactory } from "@fluidframework/aqueduct/legacy";
 import { IFluidHandle } from "@fluidframework/core-interfaces";
 
 export const greenKey = "green";

examples/apps/attributable-map/src/modelContainerRuntimeFactoryWithAttribution.ts

@@ -10,10 +10,10 @@ import {
 	IContainerContext,
 	IRuntime,
 	IRuntimeFactory,
-} from "@fluidframework/container-definitions/internal";
-import { IContainerRuntimeOptions } from "@fluidframework/container-runtime/internal";
-import { IContainerRuntime } from "@fluidframework/container-runtime-definitions/internal";
-import { NamedFluidDataStoreRegistryEntries } from "@fluidframework/runtime-definitions/internal";
+} from "@fluidframework/container-definitions/legacy";
+import { IContainerRuntimeOptions } from "@fluidframework/container-runtime/legacy";
+import { IContainerRuntime } from "@fluidframework/container-runtime-definitions/legacy";
+import { NamedFluidDataStoreRegistryEntries } from "@fluidframework/runtime-definitions/legacy";
 
 const containerRuntimeWithAttribution = mixinAttributor();
 

examples/apps/attributable-map/src/view.ts

@@ -6,7 +6,7 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
 
 import { IRuntimeAttributor } from "@fluid-experimental/attributor";
-import type { AttributionKey } from "@fluidframework/runtime-definitions/internal";
+import type { AttributionKey } from "@fluidframework/runtime-definitions/legacy";
 
 import { IHitCounter, ITinyliciousUser, greenKey, redKey } from "./dataObject.js";
 

examples/apps/collaborative-textarea/.eslintrc.cjs

@@ -4,6 +4,10 @@
  */
 
 module.exports = {
-	extends: [require.resolve("@fluidframework/eslint-config-fluid"), "prettier"],
+	extends: [
+		require.resolve("@fluidframework/eslint-config-fluid"),
+		"prettier",
+		"../../.eslintrc.cjs",
+	],
 	rules: {},
 };

examples/apps/collaborative-textarea/src/container.ts

@@ -7,8 +7,8 @@ import {
 	ModelContainerRuntimeFactory,
 	getDataStoreEntryPoint,
 } from "@fluid-example/example-utils";
-import { IContainer } from "@fluidframework/container-definitions/internal";
-import { IContainerRuntime } from "@fluidframework/container-runtime-definitions/internal";
+import { IContainer } from "@fluidframework/container-definitions/legacy";
+import { IContainerRuntime } from "@fluidframework/container-runtime-definitions/legacy";
 
 import { CollaborativeText } from "./fluid-object/index.js";