refactor: combining shared code markdown renderer readme & changelog #2717
refactor: combining shared code markdown renderer readme & changelog #2717WilcoSp wants to merge 249 commits into
Conversation
…md -> html does need to change)
excludes changelog releases due to needing api calls
…og.md is being used.
…gelog info endpoint will return ChangelogMarkdownInfo instead of ChangelogReleaseInfo
…nge by ungh.cc added version_distribution_title translation to Dutch
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@i18n/locales/nl.json`:
- Line 719: The translation string for the weekly downloads title has a typo:
update the value of the "version_distribution_title" key to use "Wekelijkse"
instead of "Weekelijkse" so the user-facing label reads "Wekelijkse downloads
voor versie {version}" (edit the JSON value for the version_distribution_title
entry).
In `@uno.config.ts`:
- Around line 36-40: The UnoCSS include currently references
'./src/composables/useProviderIcon.ts' but the project imports the module as
'~/composables/useProviderIcon' (the useProviderIcon composable) and UnoCSS
therefore isn't scanning the actual module; update the include array in
uno.config.ts to reference the same module used by imports (e.g. replace
'./src/composables/useProviderIcon.ts' with '~/composables/useProviderIcon' or
the correct module alias used in your code) so UnoCSS will scan useProviderIcon
and generate the provider icon classes.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 5acb90f1-35a2-41d1-8ac1-2ec96b642f6e
📒 Files selected for processing (8)
app/components/Changelog/Card.vueapp/components/Package/Header.vueapp/pages/package-changelog/[[org]]/[name].vuei18n/locales/nl.jsonserver/api/changelog/md/[provider]/[owner]/[repo]/[...path].get.tsserver/utils/changelog/detectChangelog.tstest/nuxt/a11y.spec.tsuno.config.ts
🚧 Files skipped from review as they are similar to previous changes (4)
- app/components/Changelog/Card.vue
- test/nuxt/a11y.spec.ts
- server/api/changelog/md/[provider]/[owner]/[repo]/[...path].get.ts
- app/components/Package/Header.vue
|
I've just fixed a small issue with git provider icons not showing (for example codeberg), this happened because all the icons where moved to the I've just committed a fix that now includes the |
| include: [ | ||
| /\.(vue|mdx|html)($|\?)/, | ||
| // git provider icons composable | ||
| '**/composables/useProviderIcon.ts', | ||
| ], |
There was a problem hiding this comment.
the icons for the git providers have been moved to a single composable so that the map isn't writen again when needed.
but because the composable was in a rs file it wasn't being scanned by unocss for potential icons which caused blank to be shown for ecample codeberg.
if it should/ could be different let me know
| @@ -0,0 +1,11 @@ | |||
| <template> | |||
There was a problem hiding this comment.
There's a skeleton layer right? Why isn't that used?
There was a problem hiding this comment.
changelog doesn't use a skeleton layer, do you maybe have examples of skeleton layers as idk what it is?
| "title_both": "Aanzienlijke toename in omvang en dependencies sinds v{version}", | ||
| "size": "De installatiegrootte is toegenomen met {percent} ({size} groter)", | ||
| "deps": "{count} meer dependencies" | ||
| "deps": "{count} meer dependency | {count} meer dependencies" |
There was a problem hiding this comment.
Try to keep distinct changes in a seperate PR if you can, makes reviewing easier and faster 😄
| const response = await $fetch(`https://ungh.cc/repos/${ref.owner}/${ref.repo}/releases/latest`) | ||
|
|
||
| const path = matchedChangelog.replace(/^.*\/blob\/[^/]+\//i, '') | ||
| const { release } = v.parse(v.object({ release: GithubReleaseSchama }), response) |
There was a problem hiding this comment.
this validation error is getting lost I think, not sure if that's intentional - optionally, it could also be moved up and use safeParse
There was a problem hiding this comment.
yeah in general the error management doesn't go well here, the only thing that should be stopped is a 404, anything else should be handled by the top level try catch.
I'll change it when I'm back home
There was a problem hiding this comment.
I've fixed the returning of the errors for checkLatestGithubRelease and also changed it to a tuple return of [Result, null] | [null, Error].
I've changed it to a tuple to make it easier to read and understand when a normal result is given or an error.
| export function usePackageHasChangelogFromState() { | ||
| return useState<boolean>(key) | ||
| } |
There was a problem hiding this comment.
I find this has changelog composable a little hard to follow - what's the rationale? 😄
There was a problem hiding this comment.
it's there to fix the bug in the video of #1233 (comment), when using useLazyFetch when not having enough data to create the url & having a data null uri as placeholder causes the information to be removed when switching pages.
that's why for the commandpallet uses this composable instead to prevent the bug, at the packageHeader component the usePackageHasChangelog composable is used with setting the state enabled, that way the command pallet is still able to know whether it should include changelog or not.
the only other fix could be to always have changelog in the command pallet, many other ideas I had to fix it didn't work or where not trust able.
implemented recomentations from ghostdevv
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@server/utils/changelog/detectChangelog.ts`:
- Around line 115-118: The code in detectChangelog.ts calls Error.isError(e)
which may not exist on Node versions <24.3; change the guard to check
availability first and fall back to instanceof: replace the direct
Error.isError(e) usage in the function that handles errors (the block containing
the current "if (!Error.isError(e)) { return [false, null] }") with a
conditional that uses typeof Error.isError === 'function' ? Error.isError(e) : e
instanceof Error so the check is safe across Node versions.
In `@shared/schemas/changelog/release.ts`:
- Line 11: The release schema contains a stray required field "mario:
v.string()" that causes v.parse(v.object({ release: GithubReleaseSchama })) in
detectChangelog.ts to always throw; remove the "mario" field from the schema in
shared/schemas/changelog/release.ts (the object that defines
GithubReleaseSchama) so the schema matches actual ungh.cc release payloads and
lets checkLatestGithubRelease / detectChangelog parse real releases
successfully.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: c159c333-992f-4c3b-801d-e0e381f10a35
📒 Files selected for processing (7)
app/components/Changelog/Markdown.vueapp/composables/usePackageChangelog.tsapp/composables/useProviderIcon.tsserver/api/changelog/md/[provider]/[owner]/[repo]/[...path].get.tsserver/api/changelog/releases/[provider]/[owner]/[repo].get.tsserver/utils/changelog/detectChangelog.tsshared/schemas/changelog/release.ts
🚧 Files skipped from review as they are similar to previous changes (4)
- app/composables/useProviderIcon.ts
- server/api/changelog/releases/[provider]/[owner]/[repo].get.ts
- app/components/Changelog/Markdown.vue
- app/composables/usePackageChangelog.ts
3 participants
click here to preview pr
🔗 Linked issue
This pr is part of #501
🧭 Context
Currently changelog uses a seperate marked markdown renderer from readme, this pr takes the shared code and makes it into a "markdown kit" so that code that can be shared will be shared
📚 Description
Moves shared code for both changelog & readme to a shared markdown kit while still allowing for each to have their unique needs.
additional changes
## heading-><hx><a href="#...>heading</a></hx>## [Example](https://example.com)-><hx><a href="https://example.com">Example</a><a href="#...></a></hx>package.takumi.vue&externallinks.vuethe provider icons are now given via theuseProviderIconcomposableuseProviderIconcomposablependingis being used fromuseLazyFetchin theChangelogReleases&ChangelogMarkdowncomponents instead of using<suspense>at the package-changelog page, this should remove/reduce the blank screen between showing the skeleton laoders & showing data.version_distribution_titletranslation and fixing a typo for Dutch (nl.json)AI usage
For
app/utils/header-version-matcher.tsI've used Gemini to get the regex for matching more exact the requested version in a toc item textnotes
The branch of this pr was based on #1233 initially, that's why there are so many commits, file changes does show correctly what has changed
the
createLinkfactory function will receive in future PRs changes, due to future plans to format git links to#pr,@personetc