feat: move buildDocs and cleanMarkdown to readme-validator#18
Open
dgaponov wants to merge 1 commit into
Open
Conversation
The AI documentation build (buildDocs, createDefaultDocsConfig, cleanMarkdown) depends on the validator's parse* functions, so it now lives in @gravity-ui/readme-validator alongside them. Removed here: src/buildDocs.ts, src/cleanMarkdown.ts, their tests and fixtures, the buildDocs public exports, the @gravity-ui/readme-validator dependency and the README section. BREAKING CHANGE: buildDocs, createDefaultDocsConfig, cleanMarkdown and their types are no longer exported from @gravity-ui/gulp-utils. Import them from @gravity-ui/readme-validator instead.
dgaponov
changed the title
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
1 participant
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.
BREAKING CHANGE: the AI documentation build (
buildDocs,createDefaultDocsConfig,cleanMarkdownand their types) now lives in@gravity-ui/readme-validator(see readme-validator#6), next to theparse*functions it depended on. Import them from there instead.Removed
src/buildDocs.ts,src/cleanMarkdown.tstest/buildDocs.test.ts,test/cleanMarkdown.test.ts,test/fixtures/buildDocs/createDefaultDocsConfigexports and theDocs*types from the public API@gravity-ui/readme-validatordependency (and lockfile entry)## buildDocsREADME sectionMigration
Verification
npm run typecheck,npm run lint(incl. attw exports check),npm run build— greenbuildDocs/cleanMarkdown/readme-validatorNote:
gulp-utilsnow ships no tests (the gulp transforms were never covered) — worth a follow-up.🤖 Generated with Claude Code