build(client): Add biome scripts where missing (#23916)

Author: tylerbutler

biome.jsonc

@@ -83,9 +83,6 @@
 			// Generated by policy-check
 			"**/assertionShortCodesMap.ts",
 
-			// This is a test file
-			"tools/markdown-magic/test/include.md",
-
 			// These are actually templates, not pure YAML files
 			"**/templates/*.yaml",
 
@@ -113,11 +110,8 @@
 			"common/lib/**",
 			"docs/**",
 			"server/**",
-			"tools/api-markdown-documenter/**",
 			"tools/benchmark/**",
-			"tools/changelog-generator-wrapper/**",
 			"tools/getkeys/**",
-			"tools/markdown-magic/**",
 			"tools/pipelines/**",
 			"tools/test-tools/**"
 		],
@@ -177,7 +171,8 @@
 			}
 		},
 		{
-			// JSONC WITHOUT TRAILING COMMAS JSONC is not a standard, and support for trailing commas is not universal. For
+			// JSONC WITHOUT TRAILING COMMAS
+			// JSONC is not a standard, and support for trailing commas is not universal. For
 			// simplicity and safety, we parse most JSONC files in a liberal way -- allowing comments and trailing commas, but
 			// format them conservatively without trailing commas.
 			//
@@ -189,7 +184,13 @@
 				"**/api-extractor*.json",
 
 				// Tools reading tsdoc config files do not consistently support trailing commas.
-				"**/tsdoc*.json"
+				"**/tsdoc*.json",
+
+				// fence.json files don't support trailing commas
+				"**/fence.json",
+
+				// These files contain comments, but are not JSONC files
+				"tools/api-markdown-documenter/src/**/test/test-data/**"
 			],
 			"json": {
 				"parser": {

packages/tools/changelog-generator-wrapper/biome.jsonc

@@ -0,0 +1,4 @@
+{
+	"$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
+	"extends": ["../../../biome.jsonc"]
+}

packages/tools/changelog-generator-wrapper/package.json

@@ -22,12 +22,15 @@
 		"build": "concurrently npm:build:compile npm:lint",
 		"build:commonjs": "npm run tsc",
 		"build:compile": "npm run build:commonjs",
+		"check:biome": "biome check .",
+		"check:format": "npm run check:biome",
 		"clean": "rimraf --glob dist lib \"**/*.tsbuildinfo\" \"**/*.build.log\"",
 		"eslint": "eslint --format stylish src",
 		"eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
-		"format": "npm run prettier:fix",
-		"lint": "npm run prettier && npm run eslint",
-		"lint:fix": "npm run prettier:fix && npm run eslint:fix",
+		"format": "npm run format:biome",
+		"format:biome": "biome check . --write",
+		"lint": "npm run eslint",
+		"lint:fix": "npm run format && npm run eslint:fix",
 		"prettier": "prettier --check . --cache --ignore-path ../../.prettierignore",
 		"prettier:fix": "prettier --write . --cache --ignore-path ../../.prettierignore",
 		"tsc": "echo \"No build required.\""
@@ -39,6 +42,7 @@
 		"typescript": "~5.4.5"
 	},
 	"devDependencies": {
+		"@biomejs/biome": "~1.9.3",
 		"@fluidframework/build-common": "^2.0.3",
 		"@fluidframework/eslint-config-fluid": "^5.7.3",
 		"concurrently": "^8.2.1",

pnpm-lock.yaml

@@ -0,0 +1,27 @@
+{
+	"$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
+	"extends": ["../../biome.jsonc"],
+	"overrides": [
+		{
+			// JSONC WITHOUT TRAILING COMMAS
+			// JSONC is not a standard, and support for trailing commas is not universal. For
+			// simplicity and safety, we parse most JSONC files in a liberal way -- allowing comments and trailing commas, but
+			// format them conservatively without trailing commas.
+			//
+			// See also: https://github.com/microsoft/vscode/issues/102061
+			"include": [
+				// These files contain comments, but are not JSONC files
+				"**/test/test-data/**"
+			],
+			"json": {
+				"parser": {
+					"allowComments": true,
+					"allowTrailingCommas": true
+				},
+				"formatter": {
+					"trailingCommas": "none"
+				}
+			}
+		}
+	]
+}

tools/api-markdown-documenter/biome.jsonc

@@ -31,19 +31,20 @@
 		"build:examples": "tsc -p examples/tsconfig.json",
 		"build:readme": "markdown-magic --files \"**/*.md\"",
 		"build:tsc": "npm run tsc",
+		"check:biome": "biome check .",
+		"check:format": "npm run check:biome",
 		"check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
 		"ci:build:docs": "api-extractor run && copyfiles -u 1 \"./_api-extractor-temp/doc-models/*\" ../../_api-extractor-temp/",
 		"clean": "rimraf --glob _api-extractor-temp nyc dist lib \"**/*.tsbuildinfo\" \"**/*.build.log\"",
 		"eslint": "eslint src",
 		"eslint:fix": "eslint src --fix",
-		"format": "npm run prettier:fix",
+		"format": "npm run format:biome",
 		"format-and-build": "npm run format && npm run build",
+		"format:biome": "biome check . --write",
 		"good-fences": "gf",
-		"lint": "npm run prettier && npm run good-fences && npm run eslint",
+		"lint": "npm run good-fences && npm run eslint",
 		"lint:fences": "npm run good-fences",
-		"lint:fix": "npm run prettier:fix && npm run eslint:fix",
-		"prettier": "prettier --check . --cache --ignore-path ../../.prettierignore",
-		"prettier:fix": "prettier --write . --cache --ignore-path ../../.prettierignore",
+		"lint:fix": "npm run eslint:fix",
 		"rebuild": "npm run clean && npm run build",
 		"test": "npm run test:mocha",
 		"test:coverage": "c8 npm test:mocha",
@@ -85,6 +86,7 @@
 		"unist-util-remove-position": "^5.0.0"
 	},
 	"devDependencies": {
+		"@biomejs/biome": "^1.7.3",
 		"@fluid-internal/mocha-test-setup": "~2.0.0-rc.3.0.3",
 		"@fluid-tools/markdown-magic": "file:../markdown-magic",
 		"@fluidframework/build-common": "^2.0.3",

tools/api-markdown-documenter/package.json

@@ -41,9 +41,10 @@ export interface LintApiModelConfiguration extends LoggingConfiguration {
 /**
  * {@link LintApiModelConfiguration} defaults.
  */
-const defaultLintApiModelConfiguration: Required<Omit<LintApiModelConfiguration, "apiModel">> = {
-	logger: defaultConsoleLogger,
-};
+const defaultLintApiModelConfiguration: Required<Omit<LintApiModelConfiguration, "apiModel">> =
+	{
+		logger: defaultConsoleLogger,
+	};
 
 // TODO: common TsdocError base (associatedItem, packageName)
 
@@ -134,7 +135,7 @@ export async function lintApiModel(
 	return anyErrors
 		? {
 				referenceErrors: errors.referenceErrors,
-		  }
+			}
 		: undefined;
 }
 

tools/api-markdown-documenter/pnpm-lock.yaml

@@ -34,9 +34,10 @@ export interface LoadModelOptions extends LoggingConfiguration {
 /**
  * {@link LoadModelOptions} defaults.
  */
-export const defaultLoadModelOptions: Required<Omit<LoadModelOptions, "modelDirectoryPath">> = {
-	logger: defaultConsoleLogger,
-};
+export const defaultLoadModelOptions: Required<Omit<LoadModelOptions, "modelDirectoryPath">> =
+	{
+		logger: defaultConsoleLogger,
+	};
 
 /**
  * Reads API reports generated by {@link https://api-extractor.com/ | API-Extractor} (.api.json files)
@@ -131,10 +132,7 @@ function applyInheritDoc(apiItem: ApiItem, apiModel: ApiModel, logger: Logger):
 				result.resolvedApiItem.tsdocComment &&
 				result.resolvedApiItem !== apiItem
 			) {
-				copyInheritedDocumentation(
-					apiItem.tsdocComment,
-					result.resolvedApiItem.tsdocComment,
-				);
+				copyInheritedDocumentation(apiItem.tsdocComment, result.resolvedApiItem.tsdocComment);
 			}
 		}
 	}
@@ -153,7 +151,10 @@ function applyInheritDoc(apiItem: ApiItem, apiModel: ApiModel, logger: Logger):
  * @remarks Copied from `@microsoft/api-documenter` as a workaround for an `API-Extractor` limitation tracked by
  * this issue: {@link https://github.com/microsoft/rushstack/issues/2062}.
  */
-function copyInheritedDocumentation(targetComment: DocComment, sourceComment: DocComment): void {
+function copyInheritedDocumentation(
+	targetComment: DocComment,
+	sourceComment: DocComment,
+): void {
 	targetComment.summarySection = sourceComment.summarySection;
 	targetComment.remarksBlock = sourceComment.remarksBlock;
 

tools/api-markdown-documenter/src/LintApiModel.ts

@@ -13,7 +13,10 @@ import {
 	transformApiModel,
 } from "./api-item-transforms/index.js";
 import type { DocumentNode } from "./documentation-domain/index.js";
-import { type RenderDocumentAsHtmlConfiguration, renderDocumentAsHtml } from "./renderers/index.js";
+import {
+	type RenderDocumentAsHtmlConfiguration,
+	renderDocumentAsHtml,
+} from "./renderers/index.js";
 
 /**
  * API Model HTML rendering options.
@@ -30,7 +33,9 @@ export interface RenderApiModelAsHtmlOptions
  *
  * @alpha
  */
-export async function renderApiModelAsHtml(options: RenderApiModelAsHtmlOptions): Promise<void> {
+export async function renderApiModelAsHtml(
+	options: RenderApiModelAsHtmlOptions,
+): Promise<void> {
 	const documents = transformApiModel(options);
 
 	return renderDocumentsAsHtml(documents, options);

tools/api-markdown-documenter/src/LoadModel.ts

@@ -13,7 +13,10 @@ import {
 	transformApiModel,
 } from "./api-item-transforms/index.js";
 import type { DocumentNode } from "./documentation-domain/index.js";
-import { type MarkdownRenderConfiguration, renderDocumentAsMarkdown } from "./renderers/index.js";
+import {
+	type MarkdownRenderConfiguration,
+	renderDocumentAsMarkdown,
+} from "./renderers/index.js";
 
 /**
  * API Model Markdown rendering options.

tools/api-markdown-documenter/src/RenderHtml.ts

@@ -27,7 +27,10 @@ import {
 import type { DocumentNode, SectionNode } from "../documentation-domain/index.js";
 import { getApiItemKind } from "../utilities/index.js";
 
-import { doesItemRequireOwnDocument, shouldItemBeIncluded } from "./ApiItemTransformUtilities.js";
+import {
+	doesItemRequireOwnDocument,
+	shouldItemBeIncluded,
+} from "./ApiItemTransformUtilities.js";
 import { createDocument } from "./Utilities.js";
 import type { ApiItemTransformationConfiguration } from "./configuration/index.js";
 import { createBreadcrumbParagraph, wrapInSection } from "./helpers/index.js";