-
Notifications
You must be signed in to change notification settings - Fork 41
feat(richtext): type richtext field value from OpenAPI spec #684
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
dipankarmaikap
wants to merge
10
commits into
main
Choose a base branch
from
fix/DX-487-richtext-openapi-types
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
7afbb95
feat(richtext): type richtext field value from OpenAPI spec
dipankarmaikap f2d13d0
fix(richtext): align YAML spec and generated types with richtext-attr…
dipankarmaikap fd36c09
chore(openapi): update richtext field-value spec and regenerate types
dipankarmaikap d58d33d
fix(richtext): update render logic, type signatures, and tests for ne…
dipankarmaikap 288619b
fix(vue): resolve type error in rich-text-renderer by casting to Comp…
dipankarmaikap 2f97c23
chore: add .prettierrc config
dipankarmaikap 75d417c
chore(richtext): html parser test updated to match correct behaviour
dipankarmaikap b6b04e1
chore: migrate pnpm overrides from package.json to pnpm-workspace.yaml
dipankarmaikap cc5a9ef
feat(cli): add OpenAPI-derived richtext type generation
dipankarmaikap 68b2d5d
refactor(cli): replace hand-written StoryblokRichtext with generated …
dipankarmaikap File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "bracketSpacing": true, | ||
| "printWidth": 80, | ||
| "semi": true, | ||
| "singleQuote": true, | ||
| "trailingComma": "all" | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -30,11 +30,6 @@ | |
| "resolutions": { | ||
| "cypress": "^14.3.3" | ||
| }, | ||
| "pnpm": { | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. (non-blocking): same here - it's not related to the PR. No issue keeping it as it's low risk, but better to tackle it in its own PR moving forward. Will give better visibility, for example, in cases where a regression is introduced |
||
| "overrides": { | ||
| "happy-dom": "^20.8.8" | ||
| } | ||
| }, | ||
| "dependencies": { | ||
| "cypress": "^14.3.3" | ||
| } | ||
|
|
||
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| #!/usr/bin/env -S node --experimental-strip-types --no-warnings=ExperimentalWarning | ||
| /** | ||
| * Generates `storyblok` CLI's OpenAPI-derived richtext types from the pinned | ||
| * overlay spec cache. Produces `RichtextDoc`, `RichTextNode`, and | ||
| * `RichTextMark` in `src/generated/` — the types for the richtext document | ||
| * format consumed by story content. | ||
| * | ||
| * Re-run after `pnpm --filter @storyblok/openapi-codegen pull[:update]`. | ||
| */ | ||
|
|
||
| import { resolve } from 'node:path'; | ||
| import { fileURLToPath } from 'node:url'; | ||
| import { generate } from '@storyblok/openapi-codegen'; | ||
| import { execSync } from 'node:child_process'; | ||
|
|
||
| const PKG_ROOT = resolve(fileURLToPath(import.meta.url), '../..'); | ||
|
|
||
| await generate({ | ||
| outDir: resolve(PKG_ROOT, 'src/generated'), | ||
| include: ['RichtextDoc', 'RichTextNode', 'RichTextMark'], | ||
| }); | ||
| const GENERATED_PATH = resolve(PKG_ROOT, 'src/generated'); | ||
| execSync(`pnpm eslint ${GENERATED_PATH} --fix`, { | ||
| stdio: 'inherit', | ||
| }); |
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@dipankarmaikap I would keep this out of the scope of this PR - we have a ticket to revisit formatting using OXC