菜单
Create new packages in the Fluid Framework monorepo following all conventions. Use when creating a new package, adding a new DDS, or scaffolding a new library. Triggers on mentions of new package, scaffold, create package, add package, or package template.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
| name | package-scaffolding |
| description | Create new packages in the Fluid Framework monorepo following all conventions. Use when creating a new package, adding a new DDS, or scaffolding a new library. Triggers on mentions of new package, scaffold, create package, add package, or package template. |
Guide for creating new packages in the Fluid Framework monorepo with all required conventions.
| Directory | Scope | Purpose |
|---|---|---|
packages/common/ | @fluidframework/* | Shared interfaces, utilities |
packages/dds/ | @fluidframework/* | Distributed Data Structures |
packages/drivers/ | @fluidframework/* | Service drivers |
packages/framework/ | @fluidframework/* | Framework components |
packages/loader/ | @fluidframework/* | Container loading |
packages/runtime/ | @fluidframework/* | Runtime components |
packages/service-clients/ | @fluidframework/* | Service client implementations |
packages/utils/ | @fluidframework/* | Shared utilities |
packages/test/ | @fluid-internal/* | Test utilities (not published) |
packages/tools/ | @fluidframework/* | Developer tools |
experimental/ | @fluid-experimental/* | Experimental packages |
azure/packages/ | @fluidframework/* | Azure-specific packages |
examples/ | @fluid-example/* | Examples (not published) |
All these paths are included in pnpm-workspace.yaml. No workspace registration is needed.
my-package/
├── api-extractor/
│ ├── api-extractor.current.json
│ ├── api-extractor.legacy.json
│ ├── api-extractor-lint-public.esm.json
│ ├── api-extractor-lint-public.cjs.json
│ ├── api-extractor-lint-legacy.esm.json
│ ├── api-extractor-lint-legacy.cjs.json
│ └── api-extractor-lint-bundle.json
├── api-report/ # Generated, committed
│ └── (created after first build)
├── src/
│ ├── cjs/
│ │ └── package.json
│ ├── test/
│ │ ├── tsconfig.json
│ │ ├── tsconfig.cjs.json
│ │ └── *.spec.ts
│ ├── index.ts
│ └── internal.ts
├── .mocharc.cjs
├── eslint.config.mts
├── package.json
├── test-config.json
├── tsconfig.json
└── tsconfig.cjs.json
Adapt the version, name, description, and directory path. Match devDependency versions to an existing peer package.
{
"name": "@fluidframework/my-package",
"version": "2.90.0",
"description": "Description of the package",
"homepage": "https://fluidframework.com",
"repository": {
"type": "git",
"url": "https://github.com/microsoft/FluidFramework.git",
"directory": "packages/category/my-package"
},
"license": "MIT",
"author": "Microsoft and contributors",
"sideEffects": false,
"type": "module",
"exports": {
".": {
"import": {
"types": "./lib/public.d.ts",
"default": "./lib/index.js"
},
"require": {
"types": "./dist/public.d.ts",
"default": "./dist/index.js"
}
},
"./internal": {
"import": {
"types": "./lib/index.d.ts",
"default": "./lib/index.js"
},
"require": {
"types": "./dist/index.d.ts",
"default": "./dist/index.js"
}
}
},
"main": "lib/index.js",
"types": "lib/public.d.ts",
"scripts": {
"api": "fluid-build . --task api",
"api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
"api-extractor:esnext": "flub generate entrypoints --outDir ./lib --node10TypeCompat",
"build": "fluid-build . --task build",
"build:api-reports": "concurrently \"npm:build:api-reports:*\"",
"build:api-reports:current": "api-extractor run --local --config api-extractor/api-extractor.current.json",
"build:commonjs": "fluid-build . --task commonjs",
"build:compile": "fluid-build . --task compile",
"build:docs": "api-extractor run --local",
"build:esnext": "tsc --project ./tsconfig.json",
"build:test": "npm run build:test:esm && npm run build:test:cjs",
"build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",
"build:test:esm": "tsc --project ./src/test/tsconfig.json",
"check:are-the-types-wrong": "attw --pack .",
"check:biome": "biome check .",
"check:exports": "concurrently \"npm:check:exports:*\"",
"check:exports:esm:public": "api-extractor run --config api-extractor/api-extractor-lint-public.esm.json",
"check:exports:cjs:public": "api-extractor run --config api-extractor/api-extractor-lint-public.cjs.json",
"check:exports:bundle-release-tags": "api-extractor run --config api-extractor/api-extractor-lint-bundle.json",
"clean": "rimraf --glob dist lib \"*.d.ts\" \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
"eslint": "eslint --quiet --format stylish src",
"eslint:fix": "eslint --quiet --format stylish src --fix --fix-type problem,suggestion,layout",
"format": "npm run format:biome",
"format:biome": "biome check . --write",
"lint": "fluid-build . --task lint",
"lint:fix": "fluid-build . --task eslint:fix --task format",
"test": "npm run test:mocha",
"test:coverage": "c8 npm test",
"test:mocha": "npm run test:mocha:esm && echo skipping cjs to avoid overhead",
"test:mocha:cjs": "cross-env FLUID_TEST_MODULE_SYSTEM=CJS mocha",
"test:mocha:esm": "mocha",
"tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && npm run place:cjs:package-stub",
"place:cjs:package-stub": "copyfiles -f ./src/cjs/package.json ./dist",
"typetests:gen": "flub generate typetests --dir . -v",
"typetests:prepare": "flub typetests --dir . --reset --previous --normalize"
},
"c8": {
"all": true,
"cache-dir": "nyc/.cache",
"exclude": ["src/test/**/*.*ts", "lib/test/**/*.*js"],
"exclude-after-remap": false,
"include": ["src/**/*.*ts", "lib/**/*.*js"],
"report-dir": "nyc/report",
"reporter": ["cobertura", "html", "text"],
"temp-directory": "nyc/.nyc_output"
},
"dependencies": {},
"devDependencies": {
"@arethetypeswrong/cli": "^0.18.2",
"@biomejs/biome": "~1.9.3",
"@fluid-tools/build-cli": "^0.63.0",
"@fluidframework/build-common": "^2.0.3",
"@fluidframework/build-tools": "^0.63.0",
"@fluidframework/eslint-config-fluid": "workspace:~",
"@microsoft/api-extractor": "7.52.11",
"@types/mocha": "^10.0.10",
"@types/node": "~20.19.30",
"c8": "^10.1.3",
"concurrently": "^9.2.1",
"copyfiles": "^2.4.1",
"cross-env": "^10.1.0",
"eslint": "~9.39.1",
"mocha": "^11.7.5",
"mocha-multi-reporters": "^1.5.1",
"rimraf": "^6.1.3",
"typescript": "~5.4.5"
},
"fluidBuild": {
"tasks": {}
},
"typeValidation": {
"broken": {},
"entrypoint": "public"
}
}
Key conventions:
workspace:~ for internal Fluid dependencies2.90.0 or current)"type": "module" for ESM-firstdependencies, build tools in devDependenciesAdjust the extends path based on package depth relative to common/build/build-common/.
{
"extends": "../../../common/build/build-common/tsconfig.node16.json",
"include": ["src/**/*"],
"exclude": ["src/test/**/*"],
"compilerOptions": {
"rootDir": "./src",
"outDir": "./lib"
}
}
{
"extends": "./tsconfig.json",
"compilerOptions": {
"outDir": "./dist"
}
}
/*!
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
* Licensed under the MIT License.
*/
export type { IMyInterface } from "./myInterface.js";
export { MyClass } from "./myClass.js";
Tag every export with a release tag (@public, @beta, @alpha, @internal) in the source file where it's defined.
Re-exports everything from index.ts plus any internal-only exports:
/*!
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
* Licensed under the MIT License.
*/
export * from "./index.js";
{
"type": "commonjs"
}
This gets copied to dist/ during build to mark CJS output.
Adjust the import path depth to reach common/build/eslint-config-fluid/.
import type { Linter } from "eslint";
import { strict } from "../../../common/build/eslint-config-fluid/flat.mts";
const config: Linter.Config[] = [
...strict,
];
export default config;
Available presets: strict (core packages), recommended (mid-level), minimalDeprecated (minimal).
"use strict";
const testCJS = process.env.FLUID_TEST_MODULE_SYSTEM === "CJS";
const outputFilePrefix = testCJS ? "CJS-" : "";
const suiteName = "@fluidframework/my-package" + (testCJS ? " - CJS" : "");
module.exports = {
spec: testCJS ? "dist/test/**/*.spec.*js" : "lib/test/**/*.spec.*js",
recursive: true,
reporter: "mocha-multi-reporters",
"reporter-options": [
`configFile=test-config.json,cmrOutput=xunit+output+${outputFilePrefix}:xunit+suiteName+${suiteName}`,
],
"unhandled-rejections": "strict",
};
{
"reporterEnabled": "spec, xunit",
"xunitReporterOptions": {
"output": "nyc/{id}junit-report.xml",
"suiteName": "{id}"
}
}
Adjust the extends path depth.
{
"extends": "../../../../common/build/build-common/tsconfig.test.node16.json",
"compilerOptions": {
"rootDir": "./",
"outDir": "../../lib/test",
"types": ["mocha", "node"]
},
"include": ["./**/*"],
"references": [
{ "path": "../.." }
]
}
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-report.esm.current.json",
"mainEntryPointFilePath": "<projectFolder>/lib/public.d.ts"
}
Only needed if the package has a legacy API surface. Otherwise omit.
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-report.esm.legacy.json"
}
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
"mainEntryPointFilePath": "<projectFolder>/lib/public.d.ts"
}
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
"mainEntryPointFilePath": "<projectFolder>/dist/public.d.ts"
}
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.json",
"mainEntryPointFilePath": "<projectFolder>/lib/index.d.ts"
}
Add additional lint configs for ./legacy, ./beta, or ./alpha paths if the package exposes them.
Add the package to the appropriate group and layer in layerInfo.json at the repo root:
"LayerName": {
"packages": ["@fluidframework/my-package"],
"deps": ["Core-Interfaces", "Core-Utils"]
}
Choose dependencies carefully — they define the allowed dependency graph. Run flub check layers --info layerInfo.json to validate.
pnpm install to update the workspace lockfilefluid-build packages/category/my-package --task buildcd packages/category/my-package && npm run build:api-reportsapi-report/ filesflub check policy to verify repo policy complianceflub check layers --info layerInfo.json to verify layer dependenciesPackages inherit from the root biome.jsonc automatically. No per-package config needed unless you need overrides (rare).
Default formatting: tabs, 95-char line width, double quotes, semicolons always, trailing commas.
package.json with correct name, version, exports, scripts, and dependenciestsconfig.json extending tsconfig.node16.jsontsconfig.cjs.json extending local tsconfig.jsonsrc/index.ts with public exportssrc/internal.ts re-exporting indexsrc/cjs/package.json with "type": "commonjs"eslint.config.mts extending strict.mocharc.cjs with correct package nametest-config.json for test reporterssrc/test/tsconfig.json for test compilationapi-extractor/ configs (current + lint variants)layerInfo.jsonpnpm install run to update lockfileapi-report/ generated and committedflub check policy passesflub check layers passesUse this skill when a user wants to add generated API/reference docs to a Gleam project from Gleam's package-interface.json metadata. Trigger for requests about Gleam docs JSON, package-interface.json, reference docs, Starlight or Astro docs sites, HexDocs-like pages, just recipes, pnpm/node scripts, or replicating the Gluegun docs recipe. This skill helps wire the generator script, package scripts, just tasks, sidebar entries, tests, and validation so the workflow is repeatable.
Use this skill for any Kusto query or telemetry investigation specifically related to Fluid Framework or its partners. Triggers include: writing or running a Kusto query against the Office Fluid database, investigating Fluid Framework telemetry or error rates, querying Office_Fluid_FluidRuntime_* tables, looking up a Fluid session by Session_Id or docId, investigating a Fluid-related error in Loop or Whiteboard telemetry, monitoring an FF bump or partner ring deployment, checking Fluid render reliability or Scriptor errors, or when the user mentions Fluid-specific tables (Office_Fluid_FluidRuntime_*, OwhLoads, HostTracker, Scriptor) or Fluid-specific error types (dataCorruptionError, dataProcessingError, DeltaConnectionFailureToConnect, ICE, ACE). Do NOT trigger for general Kusto questions that are not related to Fluid Framework.
Trigger ADO pipelines for a Copilot-created PR by posting /azp run comments. Use when the user asks to trigger CI pipelines for a specific PR.
Guide the Fluid Framework client release group through minor releases, patch releases, and post-release type test updates. Use when performing a release, preparing for a release, creating release branches, bumping versions, generating changelogs/release notes, or updating type test baselines after a release. Triggers on mentions of release, releasing, release branch, version bump, release notes, changelog generation, patch release, minor release, or release engineering.
Quick reference for flub and fluid-build CLI commands in the Fluid Framework monorepo. Use when you need to find the right flub command, understand its flags, or figure out how to run a specific build/check/generate task. Triggers on mentions of flub, fluid-build, build CLI, or specific flub subcommands.
Manage type compatibility tests in the Fluid Framework monorepo. Use when type tests fail, when acknowledging breaking changes, or when preparing type test baselines. Triggers on mentions of type tests, typetests, type validation, type compatibility, backward/forward compat, or validate*Previous.generated.ts.