feat: changelog - formatted links, more git providers & copy markdown#2983
feat: changelog - formatted links, more git providers & copy markdown#2983WilcoSp wants to merge 299 commits into
Conversation
…ble to the version that was selected
…nd idk how it should be now
added scroll margin classes ensuring to navigate to hash if present
…ithub.com:WilcoSp/npmx.dev into changelog/format-link+git-providers+copy-markdown
copy markdown button will wait 300ms before prefetching when hovering
…eive query params
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 12
🧹 Nitpick comments (3)
server/api/changelog/releases/[provider]/[owner]/[repo]/raw/[tag].get.ts (1)
116-127: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winSet
User-Agentheader for Forgejo and GitLab API calls.
getMarkdownFromGithubsetsUser-Agent: 'npmx.dev', butgetMarkdownFromForgejoandgetMarkdownFromGitlabdon't. The detection functions indetectChangelog.tsdo set this header for the same APIs. Some Forgejo/GitLab instances may reject requests without aUser-Agent.♻️ Proposed fix
async function getMarkdownFromForgejo( owner: string, repo: string, tag: string, host: string = 'codeberg.org', ) { - const data = await $fetch(`https://${host}/api/v1/repos/${owner}/${repo}/releases/tags/${tag}`) + const data = await $fetch(`https://${host}/api/v1/repos/${owner}/${repo}/releases/tags/${encodeURIComponent(tag)}`, { + headers: { + 'User-Agent': 'npmx.dev', + 'accept': 'application/json', + }, + }) const release = v.parse(ForgejoReleaseSchama, data) return release.body } async function getMarkdownFromGitlab( owner: string, repo: string, tag: string, host: string = 'gitlab.com', ) { owner = decodeURIComponent(owner) const repoPath = encodeURIComponent(`${owner}/${repo}`) - const data = await $fetch(`https://${host}/api/v4/projects/${repoPath}/releases/${tag}`) + const data = await $fetch(`https://${host}/api/v4/projects/${repoPath}/releases/${encodeURIComponent(tag)}`, { + headers: { + 'User-Agent': 'npmx.dev', + 'accept': 'application/json', + }, + }) const release = v.parse(GitlabReleaseSchame, data) return release.description }Also applies to: 129-143
🤖 Prompt for 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. In `@server/api/changelog/releases/`[provider]/[owner]/[repo]/raw/[tag].get.ts around lines 116 - 127, Update getMarkdownFromForgejo and getMarkdownFromGitlab so their $fetch API requests include the same User-Agent header as getMarkdownFromGithub, using the value npmx.dev. Preserve the existing request URLs and response parsing.server/utils/changelog/detectChangelog.ts (1)
106-114: 🩺 Stability & Availability | 🔵 Trivial | ⚡ Quick winAdd a timeout to the
fetchcall incheckFiles.The global
fetchhas no timeout, so a slow or unresponsive provider will hang the request indefinitely. While.catch(() => false)handles errors, a hung connection never triggers the catch. Consider usingAbortControlleror switching to$fetchwith atimeoutoption.♻️ Proposed fix using AbortSignal.timeout
const exists = await fetch(resolveURL(baseUrl.raw, dir ?? '', fileName), { headers: { // GitHub API requires User-Agent 'User-Agent': 'npmx.dev', }, method: ref.provider != 'tangled' ? 'HEAD' : 'GET', // we just need to know if it exists or not, tangled doesn't support HEAD + signal: AbortSignal.timeout(5000), }) .then(r => r.ok) .catch(() => false)🤖 Prompt for 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. In `@server/utils/changelog/detectChangelog.ts` around lines 106 - 114, Update the fetch call in checkFiles to enforce a finite timeout, using AbortSignal.timeout or an equivalent AbortController signal, while preserving the existing URL, headers, method selection, and false-on-error behavior.app/components/Changelog/Markdown.vue (1)
24-26: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueNon-obvious guard could use a brief comment.
typeof data.value == 'string'isn't self-explanatory — presumably guarding against the union response type this endpoint can return (object vs raw string) depending on therawquery used elsewhere in this file. A short comment would help future readers.As per coding guidelines, "Add comments only to explain complex logic or non-obvious implementations."
🤖 Prompt for 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. In `@app/components/Changelog/Markdown.vue` around lines 24 - 26, Add a brief explanatory comment immediately above the typeof data.value == 'string' guard in the watchEffect callback, clarifying that the endpoint may return either a parsed object or raw string depending on the raw query. Keep the existing guard and behavior unchanged.Source: Coding guidelines
🤖 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 `@app/components/Button/CopyMd.vue`:
- Around line 15-36: Update prefetchMarkdown and the fetch condition inside
copyMarkdown so status === 'error' retries fetchMarkdown before copying,
preventing stale or empty markdown after transient failures. Preserve the
existing idle/pending behavior and ensure copying proceeds only with the
refreshed result or surfaces the fetch failure.
In `@app/components/Changelog/Releases.vue`:
- Around line 11-21: Pass the existing host value from Releases.vue into each
ChangelogCard, then update ChangelogCard’s raw release useLazyFetch query to
include host alongside the existing parameters. Ensure the raw endpoint receives
the self-hosted host instead of falling back to its default.
In `@server/api/changelog/md/`[provider]/[owner]/[repo]/[...path].get.ts:
- Around line 19-20: The changelog fetch path must not pass arbitrary host
values from the host query parameter into server-side requests. Update the
validation and fetch flow around the parsed host, including the logic at lines
32-46, to reuse a shared outbound-host validator that validates URL structure,
resolved addresses, and every redirect, or enforce the established host
allowlist before fetching and returning raw content.
- Around line 93-101: Add a `tangled` case to the `getRepoInfo()` provider
switch and dispatch to the existing `createTangledInfo` function with the
appropriate repository parameters, so Tangled repositories return their info
instead of falling through as undefined. Preserve the existing dispatch behavior
for GitHub, Forgejo/Codeberg, and GitLab.
In `@server/api/changelog/releases/`[provider]/[owner]/[repo].get.ts:
- Around line 37-41: Add a `tangled` branch to the provider switch alongside the
existing Forgejo and GitLab cases, routing through a dedicated
`getReleasesFromTangled` fetcher with the appropriate owner, repository, and
host values. Ensure the endpoint’s provider-specific release retrieval and
rendering path covers Tangled requests consistently with the advertised support.
- Around line 23-24: Validate the optional host from the query before it reaches
the Forgejo and GitLab $fetch URL construction, allowing only approved public
destinations or an explicit host allowlist. Apply the same protection to every
provider request and validate each redirect target to block private, loopback,
link-local, reserved, and DNS-rebinding addresses; reject invalid hosts before
fetching.
In `@server/api/changelog/releases/`[provider]/[owner]/[repo]/raw/[tag].get.ts:
- Line 75: URL-encode the decoded tag route parameter in the upstream API URL
construction for all three provider functions. Update each URL template using
tag to apply encodeURIComponent(tag), while leaving owner, repo, and the
surrounding request behavior unchanged.
- Around line 17-18: Validate the user-controlled host from rawQuery before
constructing any upstream URL. Add or reuse a validateHost(provider, host) guard
that permits only approved Git hosting providers (or otherwise enforces valid
public hostnames and rejects private, loopback, and link-local ranges), then
invoke it in the raw release flow before the provider-specific API calls; apply
the same protection to the corresponding releases endpoint and every listed host
usage.
In `@server/utils/changelog/detectChangelog.ts`:
- Around line 243-248: Update ROOT_ONLY_REGEX and both directory-filter
conditions in checkLatestForgejoRelease and checkLatestGitlabRelease so
extracted root-level paths such as changelog.md match without a leading slash,
while nested paths still require the configured directory prefix.
In `@server/utils/changelog/markdown.ts`:
- Line 239: Update accountRegex and the corresponding matching logic at the
referenced usage to exclude @ segments from email addresses and package-version
suffixes such as package@latest, while preserving valid standalone account
mentions. Ensure both account-matching paths use the same corrected boundary
behavior.
- Line 100: Update the textFilter configuration to prevent
createResolveGitTextToLinks from emitting unsafe raw anchor markup from
request-derived host, owner, or repo values; build links before sanitization or
HTML-escape both generated URLs and labels before insertion. Add a regression
test covering quote-containing repository components and verify the resulting
href and text cannot inject markup.
In `@shared/utils/constants.ts`:
- Line 48: Update the ERROR_CHANGELOG_NOT_FOUND constant’s user-facing message
to use “was found” instead of “had been found,” preserving the rest of the
wording.
---
Nitpick comments:
In `@app/components/Changelog/Markdown.vue`:
- Around line 24-26: Add a brief explanatory comment immediately above the
typeof data.value == 'string' guard in the watchEffect callback, clarifying that
the endpoint may return either a parsed object or raw string depending on the
raw query. Keep the existing guard and behavior unchanged.
In `@server/api/changelog/releases/`[provider]/[owner]/[repo]/raw/[tag].get.ts:
- Around line 116-127: Update getMarkdownFromForgejo and getMarkdownFromGitlab
so their $fetch API requests include the same User-Agent header as
getMarkdownFromGithub, using the value npmx.dev. Preserve the existing request
URLs and response parsing.
In `@server/utils/changelog/detectChangelog.ts`:
- Around line 106-114: Update the fetch call in checkFiles to enforce a finite
timeout, using AbortSignal.timeout or an equivalent AbortController signal,
while preserving the existing URL, headers, method selection, and false-on-error
behavior.
🪄 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: 3e14fb36-dfc4-4096-947f-8c8738e998bf
📒 Files selected for processing (24)
app/components/Button/CopyMd.vueapp/components/Changelog/Card.vueapp/components/Changelog/Markdown.vueapp/components/Changelog/Releases.vueapp/pages/package-changelog/[[org]]/[name].vueapp/pages/package/[[org]]/[name].vuei18n/locales/en.jsoni18n/locales/nl.jsoni18n/schema.jsonnuxt.config.tsserver/api/changelog/info/[name]/v/[version].get.tsserver/api/changelog/md/[provider]/[owner]/[repo]/[...path].get.tsserver/api/changelog/releases/[provider]/[owner]/[repo].get.tsserver/api/changelog/releases/[provider]/[owner]/[repo]/raw/[tag].get.tsserver/utils/changelog/baseFileUrl.tsserver/utils/changelog/detectChangelog.tsserver/utils/changelog/markdown.tsserver/utils/changelog/mdRepoInfo.tsserver/utils/mdKit.tsshared/schemas/changelog/release.tsshared/types/changelog.tsshared/utils/constants.tstest/nuxt/a11y.spec.tstest/unit/server/utils/changelog/markdown.spec.ts
| function prefetchMarkdown() { | ||
| if (status === 'idle') { | ||
| fetchMarkdown() | ||
| } | ||
| } | ||
|
|
||
| const { | ||
| copied: copiedReadme, | ||
| copy, | ||
| copyPending: copyReadmePending, | ||
| } = useClipboard({ | ||
| copiedDuring: 2000, | ||
| }) | ||
|
|
||
| function copyMarkdown() { | ||
| copy(async () => { | ||
| if (status === 'idle' || status === 'pending') { | ||
| await fetchMarkdown() | ||
| } | ||
| return markdown ?? '' | ||
| }) | ||
| } |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf '\n## File outline\n'
ast-grep outline app/components/Button/CopyMd.vue --view expanded || true
printf '\n## Relevant file section\n'
wc -l app/components/Button/CopyMd.vue
cat -n app/components/Button/CopyMd.vue | sed -n '1,220p'
printf '\n## Find clipboard helper usage and dependency version\n'
rg -n "useClipboard|copyPending|copiedDuring|`@vueuse/core`" -S . --glob '!**/node_modules/**' || true
printf '\n## Package manifests\n'
git ls-files 'package.json' 'pnpm-lock.yaml' 'package-lock.json' 'yarn.lock' 'npm-shrinkwrap.json' | xargs -r -I{} sh -c 'echo "--- {}"; sed -n "1,220p" "{}"'Repository: npmx-dev/npmx.dev
Length of output: 22845
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf '\n## Find CopyMd.vue usage\n'
rg -n "CopyMd" app docs -S || true
printf '\n## Inspect surrounding usage if present\n'
for f in $(rg -l "CopyMd" app docs -S || true); do
echo "--- $f"
cat -n "$f" | sed -n '1,220p'
done
printf '\n## Search for fetchMarkdown/markdown/status props passed to CopyMd\n'
rg -n "fetchMarkdown|markdown:|status:" app docs -S --glob '!**/node_modules/**' || trueRepository: npmx-dev/npmx.dev
Length of output: 21935
🌐 Web query:
VueUse useClipboard copy signature v14.3.0 source string async callback docs
💡 Result:
In VueUse version 14.3.0, the useClipboard function provides a flexible copy mechanism that supports both static strings and asynchronous callbacks [1][2]. The copy function signature is: copy(value?: ClipboardValue) => Promise The ClipboardValue type allows the source to be either a string or an async function that returns a string [2]. Key details regarding the source and copy behavior in v14.3.0 include: 1. Handling of Sources: When calling copy, if no argument is provided, the function defaults to the source defined in the useClipboard options (which supports MaybeRefOrGetter) [3][1][2]. 2. Asynchronous Support: The implementation was updated in v14.3.0 (via PR #5369) to better handle asynchronous operations, specifically addressing issues in Safari [4][5][2]. When providing an async function as the source, the copy method will await the resolved value before performing the clipboard write [2]. 3. Legacy Fallback: If the Clipboard API is unavailable or permission is denied, and legacy mode is enabled (legacy: true), the function handles both string values and asynchronous callbacks by resolving the async function, updating the text ref, and then executing a fallback copy (using document.execCommand) [1][2]. The return object of useClipboard includes the copy function, which is typed to return a Promise that resolves after the operation completes [1][6].
Citations:
- 1: https://github.com/vueuse/vueuse/blob/main/packages/core/useClipboard/index.ts
- 2: vueuse/vueuse@5ec568d
- 3: https://github.com/vueuse/vueuse/blob/main/packages/core/useClipboard/index.md
- 4: https://github.com/vueuse/vueuse/releases/tag/v14.3.0
- 5: vueuse/vueuse@v14.2.1...v14.3.0
- 6: https://vueuse.pages.dev/core/useClipboard/
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf '\n## useClipboard source from installed package if present\n'
for f in $(git ls-files | grep -E '(^|/)package.json$|(^|/)pnpm-lock.yaml$' | head -n 2); do :; done
rg -n "function useClipboard|export function useClipboard|type ClipboardValue|copy\\(" node_modules .pnpm . -S --glob '**/useClipboard/**' --glob '!**/dist/**' --glob '!**/node_modules/**' || true
printf '\n## Search for error handling / retry patterns around lazy fetches\n'
rg -n "status === 'error'|status === \\\"error\\\"|error'\\]\\.includes\\(.*status|fetchMarkdown\\(\\)" app -S --glob '!**/node_modules/**' || trueRepository: npmx-dev/npmx.dev
Length of output: 509
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf '\n## Search for error-state handling near lazy fetch/clipboard flows\n'
rg -n "status === 'error'|status === \"error\"|\\bcopyMarkdown\\b|\\bprefetchMarkdown\\b|useLazyFetch<.*Markdown" app docs test -S --glob '!**/node_modules/**' || true
printf '\n## Inspect related clipboard buttons for comparison\n'
for f in app/components/Terminal/Install.vue app/components/Code/Header.vue app/composables/useInstallCommand.ts; do
if [ -f "$f" ]; then
echo "--- $f"
cat -n "$f" | sed -n '1,220p'
fi
doneRepository: npmx-dev/npmx.dev
Length of output: 22933
Retry on fetch errors before copying markdown. prefetchMarkdown() and copyMarkdown() only fetch when status is idle/pending, so a transient failure leaves the button unable to recover and it can keep copying stale/empty content. Allow status === 'error' to retry, or surface the failure instead.
🤖 Prompt for 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.
In `@app/components/Button/CopyMd.vue` around lines 15 - 36, Update
prefetchMarkdown and the fetch condition inside copyMarkdown so status ===
'error' retries fetchMarkdown before copying, preventing stale or empty markdown
after transient failures. Preserve the existing idle/pending behavior and ensure
copying proceeds only with the refreshed result or surfaces the fetch failure.
There was a problem hiding this comment.
is there a toast/snackbar component/composable available for notifying when getting raw markdown failed?
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf '\n## Search for toast/snackbar/notification composables or components\n'
rg -ni "toast|snackbar|notif" app -S --glob '!**/node_modules/**' -g '*.vue' -g '*.ts' | grep -v test || true
printf '\n## Search package.json for toast libraries\n'
rg -n "toast|notiv|vue-sonner|vue-toastification" package.json || true
printf '\n## Look for app/components directory structure for UI feedback\n'
fd . app/components -t dLength of output: 1935
@WilcoSp, I searched the codebase and didn't find an existing toast/snackbar component or composable — there's no vue-sonner, vue-toastification, or similar library in package.json, and nothing under app/components/ (e.g. Tooltip/) implements toast-style notifications.
A few options if you want to surface the fetch failure:
- Build a minimal toast/snackbar composable (e.g.
useToast()backed by a global reactive queue + aToast.vuerenderer mounted once in the layout) — reusable beyond this PR. - Reuse the existing
Tooltipcomponent to show an inline "Failed to copy, try again" message on the button itself whenstatus === 'error', avoiding a new global UI primitive. - Use an
aria-liveregion near the button for an accessible, unobtrusive text update on failure, which is the lowest-effort option and still addresses the retry/notify concern from my original comment.
Given this PR's scope is already broad (per the earlier discussion about splitting it), option 2 or 3 might be the pragmatic choice for now, with a dedicated toast composable as a possible follow-up if similar needs arise elsewhere. Let me know which direction you'd like to take, or if you'd prefer to defer the failure-notification part of my comment altogether.
(=^･ω･^=)
There was a problem hiding this comment.
is there maybe something like an a11y announce function or composable?
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf '\n## Search for a11y announce composables\n'
rg -ni "announce|aria-live|useAnnouncer|useEventBus.*announce" app -S --glob '!**/node_modules/**' || true
printf '\n## Search nuxt.config and package.json for a11y modules\n'
rg -ni "a11y|announcer" nuxt.config.ts package.json || true
printf '\n## Search node_modules metadata for vueuse announcer or nuxt a11y module (from lockfile)\n'
rg -n "vueuse|nuxt-a11y|`@nuxtjs/a11y`|vue-announcer" pnpm-lock.yaml 2>/dev/null | head -n 40 || trueLength of output: 9143
@WilcoSp yes — there's already a global announce composable used elsewhere in the app: useCommandPalette() exposes an announce(message: string) function (app/composables/useCommandPalette.ts, Line 89), backed by a useState('command-palette:announcement', …) ref. It's rendered as an always-present aria-live="polite" region in app/components/CommandPalette.client.vue (Lines 283-284), so it works independent of whether the command palette UI is open.
It's already used for clipboard-copy feedback in a couple of places, e.g.:
app/components/Terminal/Install.vue(Lines 138, 152, 166, 180):announce($t('command_palette.announcements.copied_to_clipboard'))app/components/Package/Header.vue(Line 98): same pattern
You could follow the same convention in CopyMd.vue:
const { announce } = useCommandPalette()
function copyMarkdown() {
copy(async () => {
if (status === 'idle' || status === 'pending') {
await fetchMarkdown()
}
if (status === 'error') {
announce(t('changelog.copy_failed')) // or similar i18n key
return ''
}
return markdown ?? ''
})
}This reuses the existing pattern rather than introducing a new toast/snackbar primitive, and keeps the fix scoped to this PR's copy-markdown flow.
✏️ Learnings added
Learnt from: WilcoSp
Repo: npmx-dev/npmx.dev PR: 2983
File: app/components/Button/CopyMd.vue:15-36
Timestamp: 2026-07-11T21:11:26.909Z
Learning: In the npmx.dev repository (Vue/Nuxt), there is an existing global a11y announce composable: `useCommandPalette()` exposes `announce(message: string)` (defined in app/composables/useCommandPalette.ts), backed by a `useState('command-palette:announcement', ...)` ref and rendered via an always-present `aria-live="polite"` region in app/components/CommandPalette.client.vue. This is the established pattern for screen-reader announcements (e.g., clipboard-copy feedback in app/components/Terminal/Install.vue and app/components/Package/Header.vue) and should be reused instead of introducing a new toast/snackbar/announcer primitive.
Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.
given changelogCard now also host added tests to ensure that email & package@version isn't formatted to a git link
…ithub.com:WilcoSp/npmx.dev into changelog/format-link+git-providers+copy-markdown
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
shared/utils/git-providers.ts (1)
291-291: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winType
NEED_HOSTasProviderId[].Currently inferred as
string[], so invalid or misspelt provider IDs would not be caught at compile time.As per coding guidelines: "Ensure you write strictly type-safe code".
♻️ Proposed change
-export const NEED_HOST = ['gitlab', 'gitea', 'forgejo', 'radicle'] +export const NEED_HOST: ProviderId[] = ['gitlab', 'gitea', 'forgejo', 'radicle']🤖 Prompt for 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. In `@shared/utils/git-providers.ts` at line 291, Type the NEED_HOST constant explicitly as ProviderId[] so its provider entries are compile-time validated. Preserve the existing provider values and locate the change at the NEED_HOST declaration.Source: Coding guidelines
🤖 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 `@shared/utils/git-providers.ts`:
- Around line 305-311: Update the provider parsing logic around the discarded
NEED_HOST.includes(provider.id) expression to retain its boolean result, then
use that result when assigning host in the returned object. Ensure host is
populated only for providers listed in NEED_HOST and remains undefined for all
others.
---
Nitpick comments:
In `@shared/utils/git-providers.ts`:
- Line 291: Type the NEED_HOST constant explicitly as ProviderId[] so its
provider entries are compile-time validated. Preserve the existing provider
values and locate the change at the NEED_HOST declaration.
🪄 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: 13f42098-7fdb-46aa-aa4c-f442d909cdaa
📒 Files selected for processing (9)
app/components/Changelog/Card.vueapp/components/Changelog/Releases.vueserver/api/changelog/md/[provider]/[owner]/[repo]/[...path].get.tsserver/api/changelog/releases/[provider]/[owner]/[repo].get.tsserver/api/changelog/releases/[provider]/[owner]/[repo]/raw/[tag].get.tsserver/utils/changelog/validateHost.tsshared/utils/constants.tsshared/utils/git-providers.tstest/unit/server/utils/changelog/markdown.spec.ts
🚧 Files skipped from review as they are similar to previous changes (6)
- app/components/Changelog/Releases.vue
- app/components/Changelog/Card.vue
- server/api/changelog/releases/[provider]/[owner]/[repo]/raw/[tag].get.ts
- server/api/changelog/md/[provider]/[owner]/[repo]/[...path].get.ts
- server/api/changelog/releases/[provider]/[owner]/[repo].get.ts
- test/unit/server/utils/changelog/markdown.spec.ts
fixing the validation for host.
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 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 `@test/unit/server/utils/changelog/validateHost.spec.ts`:
- Line 52: Correct the describe block title in the host validation tests by
changing “know host” to “known host”; leave the test behavior unchanged.
- Line 46: Correct the typo in the test description for the “require radicle to
have a host” case by changing “shoud” to “should.”
- Around line 179-182: Correct the test description in the radicle host
validation test so it states that gitea.com should be rejected or disallowed.
Keep the existing createSchema('radicle') setup and toBeFalsy assertion
unchanged.
- Around line 19-27: Update the second test description in the changelog host
validation tests to say it allows tangled without a host, while leaving its
createSchema('tangled') setup and assertions unchanged.
🪄 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: 700712cc-2f91-4022-a66a-ee0ede851d79
📒 Files selected for processing (5)
server/utils/changelog/detectChangelog.tsserver/utils/changelog/markdown.tsserver/utils/changelog/validateHost.tsshared/utils/constants.tstest/unit/server/utils/changelog/validateHost.spec.ts
🚧 Files skipped from review as they are similar to previous changes (4)
- server/utils/changelog/validateHost.ts
- shared/utils/constants.ts
- server/utils/changelog/detectChangelog.ts
- server/utils/changelog/markdown.ts
2 participants
preview
🔗 Linked issue
🧭 Context
📚 Description
added providers:
#, will in the future change due to tangled not having shorthands yet)(the following aren't required for this pr, just nice to have and are here if review takes long)
Adding support to format links to the git providers (same repo only):
Added button to allow copying the raw markdown
I did only use AI for some of the regular expressions
this pr continued from #2717 which continued from the pr before, that's why there are so many commits