fluidBuild.config.cjs

/*!
 * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
 * Licensed under the MIT License.
 */

// Enable TypeScript type-checking for this file.
// See https://www.typescriptlang.org/docs/handbook/intro-to-js-ts.html#ts-check
// @ts-check

/**
 * Dependencies for the "eslint" (and "eslint:fix") tasks.
 *
 * eslint does type-aware linting driven by the TypeScript *sources* (via projectService),
 * so it must resolve the same imported types that tsc does.
 *
 * To handle test code we also depend on code generation which is either linted or used by tests.
 *
 * We specifically avoid depending on this package's test compilation: it is unnecessary
 * and would slow down building individual packages by starting lint much later.
 */
const eslintDependsOn = [
	"^build:package:esm",
	"build:genver",
	"typetests:gen",
	// in case test code imports from package entrypoint (which is desirable)
	"build:package:esm",
	// legacy dependencies that are not needed for client packages, but can be for other workspaces
	"^build:esnext",
	"ts2esm",
	"^tsc",
	"^api",
	"api",
];

// release group packages; while ** is supported, it is very slow, so these entries capture all the levels we
// have packages at today. Once we can upgrade to a later version of
// globby things might be faster.
const releaseGroupPackageJsonGlobs = [
	"{azure,examples,experimental,packages}/*/*/package.json",
	"{azure,examples,experimental,packages}/*/*/*/package.json",
	"{azure,examples,experimental,packages}/*/*/*/*/package.json",
	"tools/markdown-magic/package.json",
];

/**
 * The settings in this file configure the Fluid build tools, such as fluid-build and flub. Some settings apply to the
 * whole repo, while others apply only to the client release group.
 *
 * See https://github.com/microsoft/FluidFramework/blob/main/build-tools/packages/build-tools/src/fluidBuild/fluidTaskDefinitions.ts
 * for details on the task and dependency definition format.
 *
 * @type {import("@fluidframework/build-tools").IFluidBuildConfig & import("@fluid-tools/build-cli").FlubConfig}
 */
module.exports = {
	version: 1,
	tasks: {
		"ci:build": {
			dependsOn: [
				"compile",
				"lint",
				"ci:build:api-reports",
				"ci:build:docs",
				"build:manifest",
				"build:readme",
			],
			script: false,
		},
		"full": {
			dependsOn: ["build", "webpack"],
			script: false,
		},
		"build": {
			dependsOn: [
				"check:format",
				"compile",
				"lint",
				"build:api-reports",
				"build:docs",
				"build:manifest",
				"build:readme",
			],
			script: false,
		},
		"compile": {
			// Note that "api" is included as "compile" intends to build a complete package
			// and "api" generates package entrypoint files for some packages.
			dependsOn: [
				"commonjs",
				"build:esnext",
				"build:package",
				"api",
				"build:test",
				"build:copy",
			],
			script: false,
		},
		"compile:esm": {
			dependsOn: ["compile:esm:packages", "build:test:esm"],
			script: false,
		},
		"compile:esm:packages": {
			// Note that "api-extractor:esnext" is included as "compile" intends
			// to build complete packages and "api-extractor:esnext" currently
			// generates package entrypoint files outside of client workspace.
			dependsOn: ["build:package:esm", "build:esnext", "api-extractor:esnext", "build:copy"],
			script: false,
		},
		"commonjs": {
			dependsOn: ["tsc", "build:test"],
			script: false,
		},
		"lint": {
			dependsOn: [
				"check:types",
				"eslint",
				"good-fences",
				"depcruise",
				"check:exports",
				"check:release-tags",
			],
			script: false,
		},
		"checks": {
			dependsOn: ["check:format"],
			script: false,
		},
		"checks:fix": {
			dependsOn: [],
			script: false,
		},
		"build:copy": [],
		"build:genver": [],
		"layerGeneration:gen": [],
		"typetests:gen": [],
		"ts2esm": [],
		"tsc": ["^tsc", "^api", "build:genver", "ts2esm"],
		"place:cjs:package-stub": [], // no cross-package deps needed (without definition default is [^*])
		"build:cjs": ["^build:package:cjs", "build:genver"],
		"build:esm": ["^build:package:esm", "build:genver"],
		"build:esnext": ["^build:esnext", "^api-extractor:esnext", "build:genver"],
		"build:entrypoints:esm": ["build:esm"],
		"build:entrypoints:cjs": ["build:cjs"],
		// Aliases to depend on complete package (or ESM/CJS specific side) implementation.
		// These will dependent on the outermost of the entrypoint generation which may just
		// be the code build.
		"build:package": {
			dependsOn: ["build:package:esm", "build:package:cjs"],
			script: false,
		},
		"build:package:cjs": {
			// CJS entrypoints are off and fall to ESM default via require-esm.
			// Continue building CJS to verify require-esm, support CJS testing,
			// and ability to rollback entrypoint trimming without new issues
			// sneaking in.
			dependsOn: [
				// keep verifying CJS buildability
				"build:entrypoints:cjs",
				"build:cjs",
				// build the real requirements for require-esm that will be used.
				"build:entrypoints:esm",
				"build:esm",
				"check:types:require-esm",
			],
			script: false,
		},
		"build:package:esm": {
			dependsOn: ["build:entrypoints:esm", "build:esm", "build:copy"],
			script: false,
		},
		// Generic build:test script should be replaced by :esm or :cjs specific versions.
		// "tsc" would be nice to eliminate from here, but plenty of packages still focus
		// on CommonJS.
		"build:test": [
			"typetests:gen",
			"tsc",
			"build:package:esm",
			// "build:package:cjs" is left out intentionally here as client workspace
			// packages are ESM first and they are only ones using build:package.
			"api-extractor:commonjs",
			"api-extractor:esnext",
		],
		"build:test:cjs": [
			"typetests:gen",
			"build:package:cjs",
			"tsc",
			"api-extractor:commonjs",
			// depend on ancestor packages in case current package doesn't have production build (e.g. test-only packages)
			"^build:package:cjs",
			"^tsc",
			"^api-extractor:commonjs",
		],
		"build:test:esm": [
			"typetests:gen",
			"build:package:esm",
			"build:esnext",
			"api-extractor:esnext",
			// depend on ancestor packages in case current package doesn't have production build (e.g. test-only packages)
			"^build:package:esm",
			"^build:esnext",
			"^api-extractor:esnext",
		],
		// At least as of 2026-08-21, no test's code uses package entrypoints; so just the ESM build is sufficient.
		"build:test:playwright": ["build:esm"],
		"check:types:test:playwright": ["build:esm"],
		"api": {
			dependsOn: [
				"api-extractor:commonjs",
				"api-extractor:esnext",
				// Depend on "tsc" and "build:esnext" in case there is no matching "api-extractor:*".
				"tsc",
				"build:esnext",
			],
			script: false,
		},
		"api-extractor:commonjs": ["tsc"],
		"api-extractor:esnext": {
			dependsOn: ["build:esnext"],
			script: true,
		},
		// Packages with a single API report may handle build:api-reports directly.
		// Packages with /legacy exports generate reports from legacy and "current" entrypoints using child tasks.
		// The "current" entrypoint should be the broadest of "public.d.ts",
		// "beta.d.ts", and "alpha.d.ts".
		"build:api-reports": [
			"build:package:esm",
			"api-extractor:esnext",
			"build:esnext",
			// kludge: api-extractor requires tsdoc-metadata.json to be present in the package type folder
			// to know that it can use the tsdocs in source package.
			"^build:api-reports",
		],
		"build:api-reports:current": [
			"build:package:esm",
			"api-extractor:esnext",
			"build:esnext",
			// kludge: api-extractor requires tsdoc-metadata.json to be present in the package type folder
			// to know that it can use the tsdocs in source package.
			"^build:api-reports",
		],
		"build:api-reports:legacy": [
			"build:package:esm",
			"api-extractor:esnext",
			"build:esnext",
			// kludge: api-extractor requires tsdoc-metadata.json to be present in the package type folder
			// to know that it can use the tsdocs in source package.
			"^build:api-reports",
		],
		"ci:build:api-reports": [
			"build:package:esm",
			"api-extractor:esnext",
			"build:esnext",
			// kludge: api-extractor requires tsdoc-metadata.json to be present in the package type folder
			// to know that it can use the tsdocs in source package. Under CI, these checks do the generation.
			"^ci:build:api-reports",
		],
		"ci:build:api-reports:current": [
			"build:package:esm",
			"api-extractor:esnext",
			"build:esnext",
			// kludge: api-extractor requires tsdoc-metadata.json to be present in the package type folder
			// to know that it can use the tsdocs in source package. Under CI, these checks do the generation.
			"^ci:build:api-reports",
		],
		"ci:build:api-reports:legacy": [
			"build:package:esm",
			"api-extractor:esnext",
			"build:esnext",
			// kludge: api-extractor requires tsdoc-metadata.json to be present in the package type folder
			// to know that it can use the tsdocs in source package. Under CI, these checks do the generation.
			"^ci:build:api-reports",
		],
		// With most packages in client building ESM first, there is ideally just "build:esnext" and "build:package:esm" (or "api-extractor:esnext") dependencies.
		// The package's local 'api-extractor.json' may use the entrypoint from either CJS or ESM,
		// therefore we need to require both before running api-extractor until other packages are
		// updated to use ESM entrypoints or customize their build configs.
		"build:docs": ["build:package:esm", "tsc", "build:esnext", "api-extractor:esnext"],
		"ci:build:docs": ["build:package:esm", "tsc", "build:esnext", "api-extractor:esnext"],
		"build:readme": {
			dependsOn: ["compile"],
			script: true,
		},
		"build:manifest": {
			dependsOn: ["compile"],
			script: true,
		},
		"depcruise": [],
		// check:exports provides protection for all of the subtasks so long as
		// they are not the specifically requested task by requiring all
		// entrypoints to be built before any of the child tasks are run.
		// This is done because the "check:exports:*" tasks have variable
		// names depending on the package configuration and fluid-build does
		// not support wildcards in task dependencies.
		// note: these are technically missing dependency on a task that generates tsdoc-metadata.json.
		// However different tasks are used to do that depending on run under CI or not. The metadata
		// file is small and changes rarely so it can be checked-in in future to avoid complexity.
		"check:exports": ["build:package", "api"],
		"check:exports:bundle-release-tags": ["build:esm", "build:esnext"],
		// The package's local 'api-extractor-lint.json' may use the entrypoint from either CJS or ESM,
		// therefore we need to require both before running api-extractor.
		"check:release-tags": ["tsc", "build:esnext"],
		"check:are-the-types-wrong": ["build:package", "tsc", "build:esnext", "api"],
		// check:types is an alias for all the type-checking tasks.
		"check:types": {
			dependsOn: [
				"check:types:inexactOptionalPropertyTypes",
				"check:types:require-esm",
				"check:types:test:playwright",
			],
			script: false,
		},
		"check:types:inexactOptionalPropertyTypes": [
			"^build:package:esm",
			"^build:esnext",
			"^api-extractor:esnext",
		],
		// check:types:require-esm is meant to ensure that the package is require-esm
		// compatible and can be imported by in CommonJS context. Mostly this means
		// no top-level await. For now, we just check that the package can be compiled
		// to CommonJS which ensures that it has no top-level await.
		// In CommonJS build context, the CJS versions of the package's dependencies
		// are used, so this task also ensures that the package's CommonJS support is
		// built (which may mean its ESM build).
		"check:types:require-esm": ["^build:package:cjs"],
		"check:format": {
			dependencies: [],
			script: true,
		},
		"format": {
			dependencies: [],
			script: true,
		},
		"check:biome": [],
		"check:prettier": [],
		"eslint": eslintDependsOn,
		"eslint:fix": eslintDependsOn,
		"good-fences": [],
		"format:biome": [],
		"format:prettier": [],
		"prettier": [],
		"prettier:fix": [],
		"webpack": ["^build:package:esm", "^api-extractor:esnext", "^build:esnext"],
		"webpack:profile": ["^build:package:esm", "^api-extractor:esnext", "^build:esnext"],
		"clean": {
			before: ["*"],
		},

		// Non-incremental tasks of convenience to ensure build is up-to-date
		// before command is run. And some aliases for convenience.
		"test:cjs": { dependsOn: ["test:unit:cjs"], script: false },
		"test:esm": { dependsOn: ["test:unit:esm"], script: false },
		"test:jest": ["build:compile"],
		"test:playwright": [
			"build:test:playwright",
			// In common case there is no playwright build as it generates as it runs.
			// In those cases, depend on the implementation. Since all playwright tests
			// are ESM focused, just depend on the ESM build.
			"build:esm",
			// This is not strictly a dependency as these only typecheck and don't emit,
			// but it is best to have passing typechecks and these are fast.
			"check:types:test:playwright",
		],
		"test:mocha": ["build:test"],
		"test:mocha:cjs": ["build:test:cjs"],
		"test:mocha:esm": ["build:test:esm"],
		"test:unit": { dependsOn: ["test:mocha", "test:jest", "test:playwright"], script: false },
		"test:unit:cjs": { dependsOn: ["test:mocha:cjs"], script: false },
		"test:unit:esm": { dependsOn: ["test:mocha:esm", "test:playwright"], script: false },

		// alias for back compat
		"build:full": {
			dependsOn: ["full"],
			script: false,
		},
		"build:compile": {
			dependsOn: ["compile"],
			script: false,
		},
		"build:commonjs": {
			dependsOn: ["commonjs"],
			script: false,
		},
	},

	multiCommandExecutables: ["jiti", "oclif", "syncpack", "tsx"],
	declarativeTasks: {
		// fluid-build lowercases the executable name, so we need to use buildversion instead of buildVersion.
		"flub check buildversion": {
			inputGlobs: [
				"package.json",

				...releaseGroupPackageJsonGlobs,
			],
			outputGlobs: ["package.json"],
			gitignore: ["input", "output"],
		},
		"flub generate node10Entrypoints": {
			inputGlobs: ["package.json"],
			outputGlobs: ["(alpha|beta|internal|legacy).d.ts", "legacy/alpha.d.ts"],
		},
		"jssm-viz": {
			inputGlobs: ["src/**/*.fsl"],
			outputGlobs: ["src/**/*.fsl.svg"],
		},
		"markdown-magic": {
			inputGlobs: [],
			outputGlobs: [
				// release group packages; while ** is supported, it is very slow, so these entries capture all the levels we
				// have generated markdown files at today. Once we can upgrade to a later version of
				// globby things might be faster.
				"{azure,examples,experimental,packages}/*/*/*.md",
				"{azure,examples,experimental,packages}/*/*/*/*.md",
				"{azure,examples,experimental,packages}/*/*/*/*/*.md",
				"tools/markdown-magic/**/*.md",
			],
			gitignore: ["input", "output"],
		},
		// eslint-config-fluid specific declarative task to print configs
		"jiti scripts/print-configs.ts printed-configs": {
			inputGlobs: [
				"scripts/print-configs.ts",
				"flat.mts",
				"library/**/*.{mts,ts,mjs}",
				"src/**/*.ts",
				"src/**/*.tsx",
				"*.js",
			],
			outputGlobs: ["printed-configs/*.json"],
			gitignore: ["input", "output"],
		},
		"oclif manifest": {
			inputGlobs: ["package.json", "src/**"],
			outputGlobs: ["oclif.manifest.json"],
		},
		"oclif readme": {
			inputGlobs: ["package.json", "src/**"],
			outputGlobs: ["README.md", "docs/**"],
		},
		"syncpack lint-semver-ranges": {
			inputGlobs: [
				".syncpackrc.yml",
				"package.json",

				...releaseGroupPackageJsonGlobs,
			],
			outputGlobs: [
				"package.json",

				...releaseGroupPackageJsonGlobs,
			],
			gitignore: ["input", "output"],
		},
		"syncpack list-mismatches": {
			inputGlobs: [
				".syncpackrc.yml",
				"package.json",

				...releaseGroupPackageJsonGlobs,
			],
			outputGlobs: [
				"package.json",

				...releaseGroupPackageJsonGlobs,
			],
			gitignore: ["input", "output"],
		},
	},

	// This defines the layout of the repo for fluid-build. It applies to the whole repo.
	repoPackages: {
		// Release groups
		"client": {
			directory: "",
			ignoredDirs: [],
			defaultInterdependencyRange: "workspace:~",
		},
		"build-tools": {
			directory: "build-tools",
		},
		"server": {
			directory: "server/routerlicious",
		},
		"gitrest": {
			directory: "server/gitrest",
		},
		"historian": {
			directory: "server/historian",
		},

		// Independent packages
		"build-common": "common/build/build-common",
		"eslint-config-fluid": "common/build/eslint-config-fluid",
		"common-utils": "common/lib/common-utils",
		"protocol-def": "common/lib/protocol-definitions",

		// Tools
		"tools": [
			"tools/api-markdown-documenter",
			"tools/benchmark",
			"tools/getkeys",
			"tools/test-tools",
		],
	},

	// `flub check policy` config. It applies to the whole repo.
	policy: {
		// Entries here are COMPLETELY ignored by the policy checker. Instead of adding entries here, consider adding
		// entries to the handlerExclusions list below to ignore a particular.
		exclusions: [
			// This file is a test file.
			"tools/markdown-magic/test/package.json",

			// Not a real package
			"website/api/",

			// Source to output package.json files - not real packages
			// These should only be files that are not in an pnpm workspace.
			"common/build/build-common/src/cjs/package.json",
			"common/build/build-common/src/esm/package.json",
			"packages/common/core-interfaces/src/cjs/package.json",
			"packages/framework/presence-definitions/src/cjs/package.json",
			"examples/utils/import-testing/src/cjs/package.json",
		],
		// Exclusion per handler
		handlerExclusions: {
			"fluid-build-tasks-eslint": [
				// This policy needs to be rethought in light of eslint 9. Disabling everywhere in the meantime.
				".*",

				// There are no built files, but a tsconfig.json is present to simplify the
				// eslint config.
				"azure/packages/azure-local-service/package.json",
				// eslint doesn't really depend on build. Doing so just slows down a package build.
				"^packages/test/snapshots/package.json",
				"^packages/test/test-utils/package.json",
				// TODO: AB#7630 uses lint only ts projects for coverage which don't have representative tsc scripts
				"^packages/tools/fluid-runner/package.json",

				// Server packages need to be cleaned up; excluding as a workaround
				"^server/routerlicious/packages/.*/package.json",
			],
			"fluid-build-tasks-tsc": [
				// Server packages need to be cleaned up; excluding as a workaround
				"^server/routerlicious/packages/.*/package.json",
			],
			"html-copyright-file-header": [
				// Tests generate HTML "snapshot" artifacts
				"tools/api-markdown-documenter/src/test/snapshots/.*",
			],
			"js-ts-copyright-file-header": [
				// These files all require a node shebang at the top of the file.
				"azure/packages/azure-local-service/src/index.ts",
				"experimental/PropertyDDS/packages/property-query/test/get_config.js",
				"server/routerlicious/packages/tinylicious/src/index.ts",

				// minified DOMPurify is not a source file, so it doesn't need a header.
				"website/static/dompurify/purify.min.js",

				// printed ESLint configs do not need headers
				".*/.eslint-print-configs/.*",

				// test data
				"^build-tools/packages/build-infrastructure/src/test/data/.*",

				// TODO: Once ESLint 9 flat configs are completely in use and the CJS configs are gone
				// we can remove these exceptions.
				".*/eslint.*.mts",
			],
			"no-js-file-extensions": [
				// Test coverage for loading .js as ESM based on the package type.
				"^build-tools/packages/build-tools/src/test/data/webpack/webpack.config.js$",

				// PropertyDDS uses .js files which should be renamed eventually.
				"experimental/PropertyDDS/.*",
				"azure/packages/azure-local-service/index.js",

				// selfhost's sub-projects are plain CommonJS npm packages (Azure Functions app,
				// CLIs); their cross-file require() calls assume the .js extension.
				"tools/selfhost/.*",

				// These oclif packages are still CJS vs. build-infrastructure which is ESM so is not excluded here.
				"build-tools/packages/build-cli/bin/dev.js",
				"build-tools/packages/build-cli/bin/run.js",
				"build-tools/packages/version-tools/bin/dev.js",
				"build-tools/packages/version-tools/bin/run.js",

				// Could be renamed, but there is tooling that uses this name and it's not worth it.
				"common/build/build-common/gen_version.js",

				// ESLint shared config
				"common/build/eslint-config-fluid/.*",

				"common/lib/common-utils/jest-puppeteer.config.js",
				"common/lib/common-utils/jest.config.js",

				// Mocha configs are okay to match package.json (help migrate to simple ESM all the time)
				// (Just under client packages for now)
				"^packages/.+/.mocharc.js$",

				// Avoids MIME-type issues in the browser.
				"website/static/trusted-types-policy.js",
				"website/static/dompurify/purify.min.js",
				"website/static/js/add-code-copy-button.js",
				"examples/data-objects/monaco/loaders/blobUrl.js",
				"examples/data-objects/monaco/loaders/compile.js",
				"examples/service-clients/odsp-client/shared-tree-demo/tailwind.config.js",
				"packages/test/test-service-load/scripts/usePrereleaseDeps.js",

				// Changelog generator wrapper is in js
				"tools/changelog-generator-wrapper/src/getDependencyReleaseLine.js",
				"tools/changelog-generator-wrapper/src/getReleaseLine.js",
				"tools/changelog-generator-wrapper/src/index.js",

				"tools/getkeys/index.js",
			],
			"npm-package-json-prettier": [
				// This rule is disabled for the whole repo because we no longer use prettier in the majority of packages.
				".*",
			],
			"npm-package-json-scripts-args": [
				// server/routerlicious and server/routerlicious/packages/routerlicious use
				// linux only scripts that would require extra logic to validate properly.
				// Ideally no packages would use OS specific scripts.
				"^server/routerlicious/package.json",
				"^server/routerlicious/packages/routerlicious/package.json",
			],
			"npm-package-json-script-clean": [
				// eslint-config-fluid's build step generate printed configs that are checked in. No need to clean
				"common/build/eslint-config-fluid/package.json",
				// markdown-magic's build step update the README.md file that are checked in. No need to clean.
				"tools/markdown-magic/package.json",
			],
			"npm-package-json-script-mocha-config": [
				// these don't use mocha config for reporters yet.
				"^server/",
				"^build-tools/",
				"^common/lib/common-utils/package.json",
			],
			// Packages that don't need type tests
			"npm-package-types-field": ["common/build/eslint-config-fluid/package.json"],
			"npm-package-json-test-scripts": [
				"common/build/eslint-config-fluid/package.json",
				"packages/test/mocha-test-setup/package.json",
			],
			"npm-package-json-test-scripts-split": [
				"server/",
				"tools/",
				"package.json",
				"packages/test/test-service-load/package.json",
				"packages/tools/devtools/devtools-browser-extension/package.json",
				"packages/tools/devtools/devtools-view/package.json",
			],
			"npm-package-exports-apis-linted": [
				// Packages that violate the API linting rules
				// ae-missing-release-tags, ae-incompatible-release-tags
				"^examples/data-objects/table-document/",

				// Packages with APIs that don't need strict API linting
				"^build-tools/",
				"^common/build/",
				"^experimental/PropertyDDS/",
				"^packages/framework/quill-react/",
				"^tools/api-markdown-documenter/",
			],
			"npm-package-exports-field": [
				// This policy is no longer correct or applicable to our packages, so all files are excluded.
				".*",
			],
			"npm-package-json-clean-script": [
				"server/gitrest/package.json",
				"server/historian/package.json",
				// getKeys has a fake tsconfig.json to make ./eslintrc.cjs work, but we don't need clean script
				"tools/getkeys/package.json",
				// this package has a irregular build pattern, so our clean script rule doesn't apply.
				"tools/markdown-magic/package.json",
				// Docs directory breaks cleaning down into multiple scripts.
				"website/package.json",
			],
			"npm-strange-package-name": [
				"server/gitrest/package.json",
				"server/historian/package.json",
				"package.json",
			],
			"npm-package-readmes": [
				"server/gitrest/package.json",
				"server/historian/package.json",
				"package.json",
			],
			"npm-package-folder-name": [
				"server/gitrest/package.json",
				"server/historian/package.json",
				"package.json",
			],
			"npm-package-json-script-dep": [],
			"npm-package-license": [
				// test packages
				"^build-tools/packages/build-infrastructure/src/test/data/testRepo/",
			],
			"npm-private-packages": [
				// test packages
				"^build-tools/packages/build-infrastructure/src/test/data/testRepo/",
			],
			"pnpm-npm-package-json-preinstall": [
				// test packages
				"^build-tools/packages/build-infrastructure/src/test/data/testRepo/",
			],
		},
		packageNames: {
			// The allowed package scopes for the repo.
			allowedScopes: [
				"@fluidframework",
				"@fluid-example",
				"@fluid-experimental",
				"@fluid-internal",
				"@fluid-private",
				"@fluid-tools",
			],
			// These packages are known unscoped packages.
			unscopedPackages: ["fluid-framework", "fluidframework-docs", "tinylicious"],

			mustPublish: {
				// These packages will always be published to npm. This is called the "public" feed.
				npm: [
					"@fluidframework",
					"fluid-framework",
					"@fluid-internal/client-utils",
					"@fluid-internal/mocha-test-setup",
					"@fluid-internal/presence-definitions",
					"@fluid-internal/presence-runtime",
					"@fluid-internal/test-driver-definitions",
					"tinylicious",
				],
				// A list of packages published to our internal-build feed. Note that packages published
				// to npm will also be published to this feed. This should be a minimal set required for legacy compat of
				// internal partners or internal CI requirements.
				internalFeed: [
					// TODO: We may not need to publish test packages to the internal feed, remove these exceptions if possible.
					"@fluid-internal/test-service-load",
					// Most examples should be private, but table-document needs to publish internally for legacy compat
					"@fluid-example/table-document",
				],
			},
			mayPublish: {
				// These packages may be published to npm in some cases. Policy doesn't enforce this.
				npm: ["@fluid-experimental", "@fluid-tools"],
				// These packages may be published to the internal-build feed in some cases. Policy doesn't enforce this.
				internalFeed: ["@fluid-internal", "@fluid-private"],
			},
		},
		dependencies: {
			// use by npm-package-json-script-dep policy
			// A list of script commands and the package that contains the command
			commandPackages: [
				["api-extractor", "@microsoft/api-extractor"],
				["attw", "@arethetypeswrong/cli"],
				["biome", "@biomejs/biome"],
				["c8", "c8"],
				["concurrently", "concurrently"],
				["copyfiles", "copyfiles"],
				["cross-env", "cross-env"],
				["depcruise", "dependency-cruiser"],
				["eslint", "eslint"],
				["flub", "@fluid-tools/build-cli"],
				["fluid-build", "@fluidframework/build-tools"],
				["gf", "good-fences"],
				["mocha", "mocha"],
				["nyc", "nyc"],
				["oclif", "oclif"],
				["prettier", "prettier"],
				["rimraf", "rimraf"],
				["tinylicious", "tinylicious"],
				["ts2esm", "ts2esm"],
				["tsc", "typescript"],
				["webpack", "webpack"],
			],
		},
		// These packages are independently versioned and released, but we use pnpm workspaces in single packages to work
		// around nested pnpm workspace behavior. These packages are not checked for the preinstall script that standard
		// pnpm workspaces should have.
		pnpmSinglePackageWorkspace: [
			"@fluid-private/changelog-generator-wrapper",
			"@fluid-tools/api-markdown-documenter",
			"@fluid-tools/benchmark",
			"@fluid-tools/markdown-magic",
			"@fluidframework/build-common",
			"@fluidframework/common-utils",
			"@fluidframework/eslint-config-fluid",
			"@fluidframework/protocol-definitions",
			"@fluidframework/test-tools",
			"fluidframework-docs",
		],
		fluidBuildTasks: {
			tsc: {
				ignoreDevDependencies: ["@fluid-example/webpack-fluid-loader"],
				ignoreTasks: [
					// Outside of normal build and packages/dd/matrix version includes tsc
					"bench:profile",
				],
			},
		},
		// Requirements applied to all `public` packages.
		publicPackageRequirements: {
			// The following scripts combined with npm-package-exports-apis-linted policy are all currently required
			// to ensure api-extractor is run correctly in local builds and pipelines.
			requiredScripts: [
				// TODO: Add as a requirement once all packages have been updated to produce dual esm/commonjs builds
				// {
				// 	name: "api",
				// 	body: "fluid-build . --task api",
				// },
			],
			requiredDevDependencies: [],
		},
	},

	assertTagging: {
		enabledPaths: [/^common\/lib\/common-utils/i, /^experimental/i, /^packages/i],
	},

	// `flub bump` config. These settings influence `flub bump` behavior for a release group. These settings can be
	// overridden usig explicit CLI flags like `--interdependencyRange`.
	bump: {
		defaultInterdependencyRange: {
			"client": "workspace:~",
			"build-tools": "workspace:~",
			"server": "workspace:~",
			"gitrest": "^",
			"historian": "^",
		},
	},

	// This defines the branch release types for type tests. It applies only to the client release group. Settings for
	// other release groups is in their root fluid-build config.
	branchReleaseTypes: {
		"main": "minor",
		"lts": "minor",
		"release/**": "patch",
		"next": "major",
	},

	releaseNotes: {
		sections: {
			// Note: Breaking changes should be reserved for major releases, which practically speaking means server.
			// Client releases with breaking _legacy_ changes should be in the "legacy" section instead.
			breaking: { heading: "🚨 Breaking Changes" },
			feature: { heading: "✨ New Features" },
			tree: { heading: "🌳 SharedTree DDS Changes" },
			fix: { heading: "🐛 Bug Fixes" },
			deprecation: { heading: "⚠️ Deprecations" },
			legacy: { heading: "Legacy API Changes" },
			other: { heading: "Other Changes" },
		},
	},

	// This setting influence `flub release report` behavior. This defines the legacy compat range for release group or independent packages.
	releaseReport: {
		legacyCompatInterval: {
			"client": 10,
		},
	},
};