From a042b7759a77ebe0dbea2cb7ee965439f07ca5d1 Mon Sep 17 00:00:00 2001 From: Robin Bolscher Date: Fri, 23 Oct 2026 10:14:11 +0200 Subject: [PATCH] docs: List the format and type commands, drop a stale npmignore note AGENTS.md now lists format:check, format:write and generate-types next to the other commands. Lint in CI runs format:check, so a change that skips format:write fails there, and the file did not say the command exists. docs.yml asked to add .github to .npmignore. There is no .npmignore and none is needed: files in package.json is an allowlist of index.d.ts and lib, so nothing else is packed. --- .github/workflows/docs.yml | 2 -- AGENTS.md | 11 +++++++---- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 1fe6073..2b247f1 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -15,8 +15,6 @@ name: Deploy Documentation To GitHub Pages # Note: make sure to commit package-lock.json, this is needed for `npm ci`. -# Note: add `.github` to .npmignore - on: push: branches: [production] diff --git a/AGENTS.md b/AGENTS.md index 55f9515..8e48c02 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -5,10 +5,13 @@ This file provides guidance to AI agents when working with code in this reposito ## Commands ```bash -npm test # Run all tests (node:test) -npm run lint # ESLint (flat config in eslint.config.js) -npm run build # Generate JSDoc documentation into build/ -npm run docs # Build the docs and open them in the browser (macOS `open`) +npm test # Run all tests (node:test) +npm run lint # ESLint (flat config in eslint.config.js) +npm run format:check # Prettier check, run in CI next to lint +npm run format:write # Apply Prettier; run before committing +npm run generate-types # Regenerate index.d.ts from the cluster definitions +npm run build # Generate JSDoc documentation into build/ +npm run docs # Build the docs and open them in the browser (macOS `open`) ``` The docs are a static site that works straight from disk, no server needed. Off macOS, run