Skip to content

tools: improve use of npx in api-diff #3283

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.

Sign up for GitHub

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

Merged
david-crespo merged 1 commit into from
Jul 7, 2026
Merged

tools: improve use of npx in api-diff #3283

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions tools/deno/api-diff.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,13 +336,27 @@ async function ensureSchema(
return schemaPath
}

const OXFMT_CONFIG = '/tmp/api-diff/oxfmt.json'

/**
* ensureClient runs for base and head in parallel, so install its npx deps
* once up front — concurrent npx installs of the same package race the npm
* cache and each prompt for confirmation. --yes skips the install prompt.
*/
async function ensureClientTools() {
await $`npx --yes --package @oxide/openapi-gen-ts@latest --package oxfmt true`
await $`mkdir -p /tmp/api-diff`
// an explicit (empty) config silences oxfmt's "No config found" warning
await Deno.writeTextFile(OXFMT_CONFIG, '{}\n')
}

async function ensureClient(schemaPath: string, force: boolean) {
const dir = schemaPath.replace(/\/spec\.json$/, '')
const clientPath = `${dir}/Api.ts`
if (force || !(await exists(clientPath))) {
console.error(`Generating client...`)
await $`npx @oxide/openapi-gen-ts@latest ${schemaPath} ${dir}`
await $`npx oxfmt ${dir}`
await $`npx --yes @oxide/openapi-gen-ts@latest ${schemaPath} ${dir}`
await $`npx --yes oxfmt -c ${OXFMT_CONFIG} ${dir}`
}
return clientPath
}
Expand Down Expand Up @@ -427,6 +441,7 @@ Dependencies:
if (options.format === 'schema') {
await runDiff(baseSchema, headSchema, target.baseSchema, target.headSchema)
} else {
await ensureClientTools()
const [baseClient, headClient] = await Promise.all([
ensureClient(baseSchema, force),
ensureClient(headSchema, force),
Expand Down
Loading