feat: Rule component framework with Zod validation and given aliases#47
Open
feat: Rule component framework with Zod validation and given aliases#47
Conversation
- Refactor all IPA components into folder-per-component structure (Rule/, RulesSection/, Examples/, Workflow/, Correct/, Incorrect/, Reason/, IpaMetadata/) each with co-located CSS module - Extract generic Badge component into src/components/ui/Badge/ (renamed from Tag — 'badge' is the standard UI pattern name) - Replace monolithic styles.module.css with per-component CSS modules - Add IpaMetadata component that reads frontmatter `state` via useDoc() and renders a pill tag strip above the page title - Swizzle DocItem/Content (wrap mode) to inject IpaMetadata automatically on every IPA doc page without touching individual files - Migrate 36 IPA docs: add `state: adopt|experimental` to frontmatter, remove old :::info[State] admonition blocks - Use CSS counters for rule numbering (removes render-time side effects) - Add severity-based left border accent on Rule cards (must/should/may) - Unify accordion styles for Examples and Workflow - Add dark mode support for all severity and state colours
…ion, cycle detection)
… by parseFrontMatter)
andmatei
requested review from
andreaangiolillo,
drinkbird,
lovisaberggren,
maks-m-mongo-leaf,
matt-condon,
saisundar and
wtrocki
|
There is an existing patch(es) for this commit SHA: Please note that the status that is posted is not in the context of this PR but rather the (latest) existing patch and that may affect some tests that may depend on the particular PR. If your tests do not rely on any PR-specific values (like base or head branch name) then your tests will report the same status. If you would like a patch to run in the context of this PR and abort the other(s), comment 'evergreen retry'. |
- Guard Zod validation with SSR check (typeof window === 'undefined')
- Move validation after hook calls to satisfy React Rules of Hooks
- Strip fenced code blocks before regex extraction in validation plugin
- Handle explicit boolean syntax (lintable={true}/lintable={false})
- Restore 0100.mdx as test fixture so validation is exercised end-to-end
- Remove case-insensitive flag from deriveSeverity regex
- Use Zod validation instead of unsafe type casts in IpaMetadata - Type STATE_TAG_COLOR as Partial<Record<IpaState, BadgeColor>> - Extract shared Accordion component from duplicated Examples/Workflow - Extract shared ExampleBlock.module.css from duplicated Correct/Incorrect CSS - Handle self-closing Rule tags and JSX comments in validation regex - Throw if Rule rendered outside RulesSection (was silently defaulting) - Add uniqueness constraint on dependsOn array - Replace useMemo on deriveSeverity with plain call - Use explicit color class map in Badge instead of string interpolation - Remove unused @docusaurus/theme-search-algolia dependency
Collaborator
|
It would help to review the PR if it were shorter. Is it possible to split it? Would it be reasonable? |
Collaborator
Author
@maks-m-mongo-leaf Souds good to me, will make PRs for each component then close this PR |
4 tasks
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
2 participants
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.
Summary
Rule,RulesSection,Correct,Incorrect,Reason,Examples,Workflow)What's in this PR
Component framework
Badgecomponent insrc/components/ui/Badge/with six colour variantsIpaMetadatacomponent reads frontmatterstateviauseDoc()and renders a pill badge above the page titleDocItem/Contentswizzled in wrap mode to injectIpaMetadataautomaticallyValidation (Zod)
ruleIdSchema— validatesIPA-{nnnn}-{must|should|may}-{slug}formatgivenValueSchema— validates known alias or JSONPath starting with$rulePropsSchema— validates all Rule props with cross-field constraints (e.g., informational rules don't needgiven)Given aliases
delete-operation,schema,spec, etc.) insrc/config/givenAliases.tsCross-file validation plugin
loadContent()— fails the build early<Rule>props from.mdxfilesIPA document changes
stateadded to frontmatter of all 36 IPA docs:::info[State]admonition blocks removedslug:lines removed (auto-derived byparseFrontMatter)Test plan
npx vitest run— 44 tests across 3 files (Zod schemas, cross-file validation, frontmatter parsing)npx docusaurus build— full build succeeds with validation plugin active.mdxfile and verify build fails with clear error message