🛠️ Script for reliable API build cleanup#2449
Conversation
Co-authored-by: Codex <noreply@openai.com>
There was a problem hiding this comment.
Pull request overview
This PR replaces shell-specific rm glob/brace cleanup in the API docs generation pipeline with a cross-platform Node-based cleanup script, addressing Windows shell incompatibilities encountered during yarn api:gen.
Changes:
- Added
scripts/api-build-cleanup.mjsto remove generated*.info.mdxfiles viafs/promisesin a platform-independent way. - Updated
package.jsonapi:genscript to run the new Node cleanup step afterdocusaurus gen-api-docs all.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| scripts/api-build-cleanup.mjs | Adds a Node-based cleanup routine that deletes *.info.mdx files in known API output directories, tolerating missing directories. |
| package.json | Replaces shell rm glob/brace expansions with node scripts/api-build-cleanup.mjs for reliable cross-platform execution. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
this seems like a really good solution. that package script always felt a little unwieldy, anyway, with its chained |
Co-authored-by: Codex <noreply@openai.com>
|
there may actually be a built-in fix for this. the |
I ran into a problem when changing files unrelated to the API sections, which showed up in #2448 (comment). The current script build command generates the API docs and then uses
rmto delete all*.info.mdxfiles. However, this runs through the actual command shorthand in the shell glob/brace expansion, which behaves differently depending on the shell/OS.These errors showed up on my Windows setup, even though they don't appear on OSX. This PR changes the script to use a Node cleanup environment with
fs/promisesthat works on all platforms. It also paves the way for more intricate post-generation formatting as formulated in the APN notes from #2418.