Skip to content

Commit dd7928e

Browse files
mmkalmmkal
committed
Get version strategy earlier
1 parent 8bda0df commit dd7928e

File tree

1 file changed

+102
-75
lines changed

1 file changed

+102
-75
lines changed

‎tools/npmono/src/publish.ts

+102-75
Original file line numberDiff line numberDiff line change
@@ -24,63 +24,6 @@ export const publish = async (input: PublishInput) => {
2424
const tasks = new Listr(
2525
[
2626
...setupContextTasks,
27-
{
28-
title: 'Get version strategy',
29-
rendererOptions: {persistentOutput: true},
30-
task: async (ctx, task) => {
31-
const allVersions = [
32-
...ctx.packages.map(pkg => pkg.version),
33-
...(ctx.packages.map(pkg => loadRegistryPackageJson(pkg)?.version).filter(Boolean) as string[]),
34-
]
35-
const maxVersion = allVersions.sort(semver.compare).at(-1) || VERSION_ZERO
36-
if (!maxVersion) throw new Error(`No versions found`)
37-
38-
let bumpedVersion = await task.prompt(ListrEnquirerPromptAdapter).run<string>({
39-
type: 'Select',
40-
message: `Select semver increment for all packages, specify new version, or publish packages independently`,
41-
hint: `Current latest version across all packageas is ${maxVersion}`,
42-
choices: [
43-
...bumpChoices(maxVersion),
44-
{
45-
message: 'Independent (each package will have its own version)',
46-
value: 'independent',
47-
},
48-
],
49-
})
50-
51-
if (bumpedVersion === 'independent') {
52-
const bumpMethod = await task.prompt(ListrEnquirerPromptAdapter).run<semver.ReleaseType | 'ask'>({
53-
type: 'Select',
54-
message: 'Select semver increment for each package',
55-
choices: [
56-
...allReleaseTypes.map(type => ({message: type, value: type})),
57-
{
58-
message: 'Ask for each package',
59-
value: 'ask',
60-
},
61-
],
62-
})
63-
64-
ctx.versionStrategy = {
65-
type: 'independent',
66-
bump: bumpMethod === 'ask' ? null : bumpMethod,
67-
}
68-
} else if (bumpedVersion === 'other') {
69-
bumpedVersion = await task.prompt(ListrEnquirerPromptAdapter).run<string>({
70-
type: 'Input',
71-
message: `Enter a custom version (must be greater than ${maxVersion})`,
72-
validate: v =>
73-
typeof v === 'string' && Boolean(semver.valid(v)) && semver.gt(v, maxVersion || VERSION_ZERO),
74-
})
75-
} else {
76-
ctx.versionStrategy = {
77-
type: 'fixed',
78-
version: bumpedVersion,
79-
}
80-
}
81-
task.output = inspect(ctx.versionStrategy)
82-
},
83-
},
8427
{
8528
title: 'Set target versions',
8629
task: async function setTargetVersions(ctx, task) {
@@ -253,6 +196,7 @@ export const ReleaseNotesInput = z.object({
253196
export type ReleaseNotesInput = z.infer<typeof ReleaseNotesInput>
254197

255198
// this doesn't work yet
199+
// consider making it a separate command that can read the folder made by the main publish command
256200
export const releaseNotes = async (input: ReleaseNotesInput) => {
257201
const tasks = new Listr(
258202
[
@@ -341,7 +285,7 @@ export const setupContextTasks: ListrTask<Ctx>[] = [
341285
const number = Number(`1${'0'.repeat(length.toString().length + 1)}`) + i
342286
pkg.folder = path.join(ctx.tempDir, `${number}.${pkg.name.replace('/', '__')}`)
343287
})
344-
task.output = ctx.packages.map(pkg => `${pkg.name}`).join('\n')
288+
task.output = ctx.packages.map(pkg => `${pkg.name}`).join(', ')
345289
return `Found ${ctx.packages.length} packages to publish`
346290
},
347291
},
@@ -364,15 +308,12 @@ export const setupContextTasks: ListrTask<Ctx>[] = [
364308
},
365309
},
366310
{
367-
title: `Pulling registry packages`,
368-
rendererOptions: {persistentOutput: true},
311+
title: 'Getting published versions',
369312
task: (ctx, task) => {
370313
return task.newListr(
371314
ctx.packages.map(pkg => ({
372-
title: `Pulling ${pkg.name}`,
373-
rendererOptions: {persistentOutput: true},
374-
task: async (_ctx, subtask) => {
375-
const {sortPackageJson} = await import('sort-package-json')
315+
title: `Getting published versions for ${pkg.name}`,
316+
task: async _ctx => {
376317
const publishedAlreadyFolder = path.join(pkg.folder, PUBLISHED_ALREADY_FOLDER)
377318
fs.mkdirSync(publishedAlreadyFolder, {recursive: true})
378319
const registryVersionsResult = await execa('npm', ['view', pkg.name, 'versions', '--json'], {reject: false})
@@ -382,18 +323,97 @@ export const setupContextTasks: ListrTask<Ctx>[] = [
382323
])
383324
const registryVersionsStdout = StdoutShape.parse(JSON.parse(registryVersionsResult.stdout))
384325
const registryVersions = Array.isArray(registryVersionsStdout) ? registryVersionsStdout : []
385-
const latestProperRelease = registryVersions
326+
pkg.publishedVersions = registryVersions
327+
},
328+
})),
329+
{concurrent: true},
330+
)
331+
},
332+
},
333+
{
334+
title: 'Get version strategy',
335+
rendererOptions: {persistentOutput: true},
336+
task: async (ctx, task) => {
337+
const allVersions = [
338+
...ctx.packages.map(pkg => pkg.version),
339+
...ctx.packages.flatMap(pkg => pkg.publishedVersions.slice()),
340+
]
341+
const maxVersion = allVersions.sort(semver.compare).at(-1) || VERSION_ZERO
342+
if (!maxVersion) throw new Error(`No versions found`)
343+
344+
let bumpedVersion = await task.prompt(ListrEnquirerPromptAdapter).run<string>({
345+
type: 'Select',
346+
message: `Select semver increment for all packages, specify new version, or publish packages independently`,
347+
hint: `Current latest version across all packageas is ${maxVersion}`,
348+
choices: [
349+
...bumpChoices(maxVersion),
350+
{
351+
message: 'Independent (each package will have its own version)',
352+
value: 'independent',
353+
},
354+
],
355+
})
356+
357+
if (bumpedVersion === 'independent') {
358+
const bumpMethod = await task.prompt(ListrEnquirerPromptAdapter).run<semver.ReleaseType | 'ask'>({
359+
type: 'Select',
360+
message: 'Select semver increment for each package',
361+
choices: [
362+
...allReleaseTypes.map(type => ({message: type, value: type})),
363+
{
364+
message: 'Ask for each package',
365+
value: 'ask',
366+
},
367+
],
368+
})
369+
370+
ctx.versionStrategy = {
371+
type: 'independent',
372+
bump: bumpMethod === 'ask' ? null : bumpMethod,
373+
}
374+
} else if (bumpedVersion === 'other') {
375+
bumpedVersion = await task.prompt(ListrEnquirerPromptAdapter).run<string>({
376+
type: 'Input',
377+
message: `Enter a custom version (must be greater than ${maxVersion})`,
378+
validate: v => typeof v === 'string' && Boolean(semver.valid(v)) && semver.gt(v, maxVersion || VERSION_ZERO),
379+
})
380+
} else {
381+
ctx.versionStrategy = {
382+
type: 'fixed',
383+
version: bumpedVersion,
384+
}
385+
}
386+
task.output = inspect(ctx.versionStrategy)
387+
},
388+
},
389+
{
390+
title: `Pulling registry packages`,
391+
rendererOptions: {persistentOutput: true},
392+
task: (ctx, task) => {
393+
return task.newListr(
394+
ctx.packages.map(pkg => ({
395+
title: `Pulling ${pkg.name}`,
396+
rendererOptions: {persistentOutput: true},
397+
task: async (_ctx, subtask) => {
398+
const {sortPackageJson} = await import('sort-package-json')
399+
const registryVersions = pkg.publishedVersions
400+
const publishedAlreadyFolder = path.join(pkg.folder, PUBLISHED_ALREADY_FOLDER)
401+
const publishedVersionForComparison = registryVersions
386402
.slice()
387403
.reverse()
388-
.find(v => !v.includes('-'))
389-
390-
if (!latestProperRelease) {
391-
task.output = `${task.output || ''}\n- No release found for ${pkg.name}`.trim()
404+
.find(
405+
v =>
406+
ctx.versionStrategy.type === 'independent' || // independent mode: compare to prerelease versions
407+
ctx.versionStrategy.version.includes('-') || // fixed mode prerelease version wanted: compare to prerelease versions
408+
!v.includes('-'), // otherwise, compare to proper releases
409+
)
410+
411+
if (!publishedVersionForComparison) {
392412
return
393413
}
394414

395415
// note: `npm pack foobar` will actually pull foobar.1-2-3.tgz from the registry. It's not actually doing a "pack" at all. `pnpm pack` does not do the same thing - it packs the local directory
396-
await pipeExeca(subtask, 'npm', ['pack', `${pkg.name}@${latestProperRelease}`], {
416+
await pipeExeca(subtask, 'npm', ['pack', `${pkg.name}@${publishedVersionForComparison}`], {
397417
reject: false,
398418
cwd: publishedAlreadyFolder,
399419
})
@@ -412,8 +432,6 @@ export const setupContextTasks: ListrTask<Ctx>[] = [
412432
// avoid churn on package.json field ordering, which npm seems to mess with
413433
fs.writeFileSync(registryPackageJsonPath, sortPackageJson(JSON.stringify(registryPackageJson, null, 2)))
414434
}
415-
416-
task.output = `${task.output || ''}\n- Pulled ${pkg.name}@${latestProperRelease}`.trim()
417435
},
418436
})),
419437
{concurrent: true},
@@ -547,13 +565,17 @@ async function getPackageRevList(pkg: Pkg) {
547565
.split('\n')
548566
.filter(Boolean)
549567
.map(line => `- ${line}`)
568+
const commitComparisonString = `${fromRef}..${localRef}`
569+
const versionComparisonString = `${loadRegistryPackageJson(pkg)?.version || 'unknown'}->${pkg.targetVersion}`
550570
const sections = [
551-
commitBullets.length > 0 && '<h3 data-commits>Commits</h3>\n',
571+
commitBullets.length > 0 &&
572+
`<h3 data-commits>Commits ${commitComparisonString} (${versionComparisonString})</h3>\n`,
552573
...commitBullets,
553574
uncommitedChanges.trim() && 'Uncommitted changes:\n' + uncommitedChanges,
554575
]
555576
return (
556-
sections.filter(Boolean).join('\n').trim() || `No ${pkg.name} changes since last publish (${fromRef}..${localRef})`
577+
sections.filter(Boolean).join('\n').trim() ||
578+
`No ${pkg.name} changes since last publish: ${commitComparisonString} (${versionComparisonString})`
557579
)
558580
}
559581

@@ -573,7 +595,11 @@ const workspaceDependencies = (pkg: Pkg, ctx: Ctx, depth = 0): Pkg[] =>
573595
async function getOrCreateChangelog(ctx: Ctx, pkg: Pkg): Promise<string> {
574596
const changelogFile = changelogFilepath(pkg)
575597
if (fs.existsSync(changelogFile)) {
576-
return fs.readFileSync(changelogFile).toString()
598+
const existingContent = fs.readFileSync(changelogFile).toString()
599+
// hack: sometimes we get a changelog a bit early before the targetVersion is set. Check that the existing version doesn't include 'undefined' so we can try again after the targetVersion is set.
600+
if (!existingContent.includes('undefined')) {
601+
return existingContent
602+
}
577603
}
578604

579605
const sourceChanges = await getPackageRevList(pkg)
@@ -676,6 +702,7 @@ type Pkg = PkgMeta & {
676702
version: string
677703
path: string
678704
private: boolean
705+
publishedVersions: string[]
679706
dependencies: Record<
680707
string,
681708
{

0 commit comments

Comments
 (0)