[WIP] Fix TypeDoc configuration and autofix action issues

[Copilot]

• Explore repository and understand the issue
• Add exclude array to package config in scripts/generateDocs.js
• Update .prettierignore to exclude .github/** files
• Verify prettier doesn't format .github files
• Verify docs generation works without TypeDoc exclude error
• Run code review
• Run security analysis (CodeQL)

Original prompt

Problem

The CI run for branch tanstack-config fails during docs generation and autofix: TypeDoc reports "The 'exclude' option must be set to an array of strings" and the autofix action is blocked because formatting changed files under .github and the action is not permitted to modify the .github directory.

Goal

Apply minimal, focused fixes to the tanstack-config branch so that: (1) TypeDoc receives a valid configuration (exclude is an array of strings) and (2) automated formatting does not modify files under .github (so autofix-ci can run without trying to commit .github changes).

Changes to make

1. Add typedoc.json at repository root with a valid 'exclude' array and sensible defaults for docs generation. File contents:

{
"entryPoints": ["packages/typescript"],
"out": "docs/reference",
"exclude": [
"/*.spec.ts",
"/*.test.ts",
"/tests/",
"node_modules/",
"packages//dist/**"
],
"excludeExternals": true,
"excludePrivate": true
}

Rationale: TypeDoc expects exclude to be an array of strings. Pointing entryPoints at packages/typescript matches the monorepo layout where TypeDoc runs in CI. This will resolve the error and allow docs generation to complete.

2. Add .prettierignore at repository root to prevent Prettier from modifying files under .github. File contents:

.github/**

Rationale: The autofix CI action is not allowed to commit changes under .github. Prettier in the autofix workflow changed .github/workflows/pr.yml which caused the autofix action to attempt to commit those changes and fail. Adding .prettierignore prevents Prettier from touching .github files.

Verification steps

• Commit the two files to a branch and open a pull request against tanstack-config (the PR created by this tool should use tanstack-config as the base so CI runs against that branch). The existing PR from tanstack-config into main will pick up the additional commits.
• In CI (or locally), run:
  • pnpm prettier:write (should not modify files under .github)
  • pnpm build:all && pnpm docs:generate (TypeDoc should run without the exclude error and generate markdown under ./docs/reference)

Notes

• No changes to existing .github workflows are necessary — adding .prettierignore is the minimal change to avoid formatting .github files.
• If you prefer the alternative approach (narrow prettier globs in the workflow), I can apply that instead. This PR will implement the .prettierignore approach as requested.

Files to add

• typedoc.json (root) — contents above
• .prettierignore (root) — contents above

Please create the branch and PR against the tanstack-config base branch with a commit message "chore: ensure typedoc.exclude is array; avoid formatting .github files" and include the two files.

This pull request was created as a result of the following prompt from Copilot chat.

Problem

The CI run for branch tanstack-config fails during docs generation and autofix: TypeDoc reports "The 'exclude' option must be set to an array of strings" and the autofix action is blocked because formatting changed files under .github and the action is not permitted to modify the .github directory.

Goal

Apply minimal, focused fixes to the tanstack-config branch so that: (1) TypeDoc receives a valid configuration (exclude is an array of strings) and (2) automated formatting does not modify files under .github (so autofix-ci can run without trying to commit .github changes).

Changes to make

1. Add typedoc.json at repository root with a valid 'exclude' array and sensible defaults for docs generation. File contents:

{
"entryPoints": ["packages/typescript"],
"out": "docs/reference",
"exclude": [
"/*.spec.ts",
"/*.test.ts",
"/tests/",
"node_modules/",
"packages//dist/**"
],
"excludeExternals": true,
"excludePrivate": true
}

Rationale: TypeDoc expects exclude to be an array of strings. Pointing entryPoints at packages/typescript matches the monorepo layout where TypeDoc runs in CI. This will resolve the error and allow docs generation to complete.

2. Add .prettierignore at repository root to prevent Prettier from modifying files under .github. File contents:

.github/**

Rationale: The autofix CI action is not allowed to commit changes under .github. Prettier in the autofix workflow changed .github/workflows/pr.yml which caused the autofix action to attempt to commit those changes and fail. Adding .prettierignore prevents Prettier from touching .github files.

Verification steps

• Commit the two files to a branch and open a pull request against tanstack-config (the PR created by this tool should use tanstack-config as the base so CI runs against that branch). The existing PR from tanstack-config into main will pick up the additional commits.
• In CI (or locally), run:
  • pnpm prettier:write (should not modify files under .github)
  • pnpm build:all && pnpm docs:generate (TypeDoc should run without the exclude error and generate markdown under ./docs/reference)

Notes

• No changes to existing .github workflows are necessary — adding .prettierignore is the minimal change to avoid formatting .github files.
• If you prefer the alternative approach (narrow prettier globs in the workflow), I can apply that instead. This PR will implement the .prettierignore approach as requested.

Files to add

• typedoc.json (root) — contents above
• .prettierignore (root) — contents above

Please create the branch and PR against the tanstack-config base branch with a commit message "chore: ensure typedoc.exclude is array; avoid formatting .github files" and include the two files.

---

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.