Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,25 +16,26 @@ FAST (`@microsoft/fast`) is a Microsoft open-source monorepo for building W3C-st

## Packages

Each package includes a DESIGN.md file, read that to gain a general understanding of the code for that package.

| Package | Status | Purpose |
|---|---|---|
| `@microsoft/fast-element` | Stable (v2) | Core Web Component library |
| `@microsoft/fast-html` | Alpha | Declarative HTML parser |
| `@microsoft/fast-router` | Alpha | Web Component router |
| `@microsoft/fast-build` | Prerelease | Declarative HTML server side renderer |
| `@microsoft/fast-test-harness` | Prerelease | Testing utilities for FASTElement components |

### Other packages
### Sites

| Package | Status | Purpose |
|---|---|---|
| `@microsoft/fast-bench` | Private (not published as a package) | Benchmarking utilities |
| `sites/website` | Private (not published as a package) | Documentation website source |
| `@microsoft/fast-ssr` | Alpha (not actively maintained) | Server-side rendering utilities |
| `sites/benchmarks` | Private (not published as a package) | Benchmarking site |

### Example projects

- `examples/todo-app/` — A simple To-Do app demonstrating FAST usage patterns.
- `examples/ssr/` — Server-side rendering example using `@microsoft/fast-ssr`.

## Skills

Expand Down Expand Up @@ -93,7 +94,8 @@ packages/<package>/
```

- Source files use **kebab-case**: `element-controller.ts`, `update-queue.ts`.
- Test files use `*.pw.spec.ts` suffix, co-located next to the source they test.
- Playwright test files use `*.pw.spec.ts` suffix, co-located next to the source they test.
- Node test files use `*.spec.ts` suffix.

## Code Style

Expand Down Expand Up @@ -152,3 +154,5 @@ Before finishing any change, run these commands from the monorepo root and confi
- [ ] `npm run test` — all tests pass
- [ ] `npm run biome:check` — Biome linting and formatting pass
- [ ] `npm run checkchange` — beachball change files exist for any `packages/*` changes

Read the [shipping skill](./skills/shipping/SKILL.md) and ensure you have updated everything outlined in that file.
4 changes: 1 addition & 3 deletions .github/skills/shipping/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,9 +180,7 @@ If the breaking change is significant or requires multiple PRs, open a [discussi

# Documentation

Keep the website documentation in `sites/website/src/docs/` updated when making changes that affect public APIs, behavior, or usage patterns. The documentation is organized by version:

- `sites/website/src/docs/2.x/` — Current version documentation (getting started, guides, advanced topics, API reference).
After any changes ensure that the documentation is up to date, this includes the files DESIGN.md and README.md files for any packages/crates that have been modified. If your changes update or add to the public API, update the sites/website/src/docs/ files. Only update the latest version, these are denoted by major versions in their folder names inside the docs folder, 1.x, 2.x, etc., find the latest version of the docs and modify them if necessary.

When adding or modifying exported APIs, run the website prebuild script to regenerate API documentation from the api-extractor output:

Expand Down
10 changes: 4 additions & 6 deletions .github/workflows/cd-gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,16 @@ permissions:
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
node: [22.x]

steps:
- uses: actions/checkout@v4
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
fetch-depth: 0

- uses: actions/setup-node@v6
with:
node-version: 22

- name: Set Git User
run: |
git config --global user.name "${{ env.GITHUB_SERVICE_USER }}"
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/ci-validate-platforms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,11 +74,11 @@ jobs:
run: cargo install wasm-pack

- name: Build workspaces
run: npx lage build ${{ github.event_name == 'pull_request' && '--since origin/main' || '' }}
run: npx lage build ${{ github.event_name == 'pull_request' && '--since origin/main' || '' }} --allow-no-target-runs

- name: Install playwright dependencies and browsers
run: |
npx playwright install --with-deps

- name: Run tests in all Packages
run: npx lage test:node test:playwright ${{ github.event_name == 'pull_request' && '--since origin/main' || '' }}
run: npx lage test:node test:playwright ${{ github.event_name == 'pull_request' && '--since origin/main' || '' }} --allow-no-target-runs
4 changes: 2 additions & 2 deletions .github/workflows/ci-validate-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,14 @@ jobs:
run: cargo install wasm-pack

- name: Build workspaces
run: npx lage build ${{ github.event_name == 'pull_request' && format('--since origin/{0}', github.event.pull_request.base.ref) || '' }}
run: npx lage build ${{ github.event_name == 'pull_request' && format('--since origin/{0}', github.event.pull_request.base.ref) || '' }} --allow-no-target-runs

- name: Install playwright dependencies and browsers
run: |
npx playwright install --with-deps

- name: Testing unit tests
run: npx lage test:node test:chromium ${{ github.event_name == 'pull_request' && format('--since origin/{0}', github.event.pull_request.base.ref) || '' }}
run: npx lage test:node test:chromium ${{ github.event_name == 'pull_request' && format('--since origin/{0}', github.event.pull_request.base.ref) || '' }} --allow-no-target-runs

- name: Testing final validation
run: npm run test:validation
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "none",
"comment": "chore: replace rollup-plugin-filesize with esbuild bundle size reporting",
"packageName": "@microsoft/fast-element",
"email": "7559015+janechu@users.noreply.github.com",
"dependentChangeType": "none"
}
20 changes: 0 additions & 20 deletions examples/ssr/CHANGELOG.json

This file was deleted.

13 changes: 0 additions & 13 deletions examples/ssr/CHANGELOG.md

This file was deleted.

7 changes: 0 additions & 7 deletions examples/ssr/README.md

This file was deleted.

30 changes: 0 additions & 30 deletions examples/ssr/package.json

This file was deleted.

63 changes: 0 additions & 63 deletions examples/ssr/server.js

This file was deleted.

6 changes: 0 additions & 6 deletions examples/ssr/src/main.ts

This file was deleted.

14 changes: 0 additions & 14 deletions examples/ssr/todo-data.json

This file was deleted.

22 changes: 0 additions & 22 deletions examples/ssr/tsconfig.json

This file was deleted.

15 changes: 0 additions & 15 deletions examples/ssr/vite.config.ts

This file was deleted.

Loading
Loading