fix: generate error code catalog from single YAML source - #1400
Open
mysteriousskater wants to merge 1 commit into
Open
mysteriousskater wants to merge 1 commit into
mysteriousskater wants to merge 1 commit into
Conversation
|
@mysteriousskater Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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
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.
Overview
This PR consolidates the duplicated error code documentation into a single hand-maintained source.
docs/error-codes.yamlbecomes the sole source of truth; the generator now emits bothsrc/errors/codes.tsanddocs/error-code-catalog.md, the hand-writtendocs/error-codes.mdduplicate is removed, andnpm run error-codes:checkverifies the generated markdown is up to date.Related Issue
Changes
🧾 Single Source of Truth
[MODIFY]
docs/error-codes.yaml[DELETE]
docs/error-codes.md[MODIFY]
scripts/generate-error-codes.mjsdocs/error-code-catalog.mdin addition tosrc/errors/codes.tsfrom the YAML source.npm run error-codes:checkfails when the generated markdown (or TypeScript) is stale.[MODIFY]
docs/error-code-catalog.md[MODIFY]
package.jsonerror-codes:checkto the generator's check mode.[MODIFY]
scripts/generate-error-codes.test.mjsVerification Results
docs/error-codes.yamlis the sole source;docs/error-codes.mdremoveddocs/error-code-catalog.mdSecurity and Failure Modes
Compatibility
src/errors/codes.tsoutput is unchanged in shape, so existing imports and error handling continue to work.docs/error-codes.mdcontent is preserved through the generateddocs/error-code-catalog.md.Closes #1335