Exclude SDK landing pages from Prettier formatting #2944
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add docs/sdk/index.mdx and docs/sdk/migrate.mdx to .prettierignore to prevent automatic formatting of manually maintained SDK documentation landing pages.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
The pre-commit hook was passing files explicitly to Prettier via xargs, which bypasses .prettierignore rules. This caused docs/sdk/index.mdx and docs/sdk/migrate.mdx to be formatted despite being in .prettierignore. Changes: - Add filter_prettier_ignored() function to check Prettier ignore status - Filter JS/TS and Markdown files before passing to Prettier - Only format files that are not ignored This ensures .prettierignore rules are respected even when files are explicitly staged, preventing unwanted formatting of manually maintained SDK documentation landing pages.
The sdkDocsHandler was unconditionally overwriting index.mdx and migrate.mdx on every TypeDoc generation, causing manual edits to be lost. Changes: - Only generate index.mdx if it doesn't exist - Only generate migrate.mdx if it doesn't exist - Preserve manual edits across doc regenerations This allows the files to be manually maintained while still providing default templates for initial generation.
The root cause was that TypeDoc was cleaning the output directory before generating docs, which deleted index.mdx and migrate.mdx. Then the generator would recreate them from hardcoded templates, overwriting any manual edits. Solution: 1. Set cleanOutputDir: false in TypeDoc config to prevent auto-cleaning 2. Use custom cleanDirectory function that preserves index.mdx and migrate.mdx 3. Only generate these files if they don't exist (bootstrap mode) This allows index.mdx and migrate.mdx to be manually maintained while still cleaning auto-generated API documentation on each build.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add docs/sdk/index.mdx and docs/sdk/migrate.mdx to .prettierignore to prevent them being staged upon each build.
Description
Document type