1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
import type { Context, PackageInfo } from './context.js';
import fs from 'node:fs';
import path from 'node:path';
import { fileURLToPath } from 'node:url';
import { color, say } from '@astrojs/cli-kit';
import { random, sleep } from '@astrojs/cli-kit/utils';
import { resolveCommand } from 'package-manager-detector';
import {
banner,
bye,
celebrations,
changelog,
done,
error,
info,
newline,
pluralize,
spinner,
success,
title,
upgrade,
warn,
} from '../messages.js';
import { shell } from '../shell.js';
export async function install(
ctx: Pick<
Context,
'version' | 'packages' | 'packageManager' | 'prompt' | 'dryRun' | 'exit' | 'cwd'
>,
) {
await banner();
newline();
const { current, dependencies, devDependencies } = filterPackages(ctx);
const toInstall = [...dependencies, ...devDependencies].sort(sortPackages);
for (const packageInfo of current.sort(sortPackages)) {
const tag = /^\d/.test(packageInfo.targetVersion)
? packageInfo.targetVersion
: packageInfo.targetVersion.slice(1);
await info(`${packageInfo.name}`, `is up to date on`, `v${tag}`);
await sleep(random(50, 150));
}
if (toInstall.length === 0 && !ctx.dryRun) {
newline();
await success(random(celebrations), random(done));
return;
}
const majors: PackageInfo[] = [];
for (const packageInfo of toInstall) {
const word = ctx.dryRun ? 'can' : 'will';
await upgrade(packageInfo, `${word} be updated`);
if (packageInfo.isMajor) {
majors.push(packageInfo);
}
}
if (majors.length > 0) {
const { proceed } = await ctx.prompt({
name: 'proceed',
type: 'confirm',
label: title('wait'),
message: `${pluralize(
['One package has', 'Some packages have'],
majors.length,
)} breaking changes. Continue?`,
initial: true,
});
if (!proceed) {
return ctx.exit(0);
}
newline();
await warn('check', `Be sure to follow the ${pluralize('CHANGELOG', majors.length)}.`);
for (const pkg of majors.sort(sortPackages)) {
await changelog(pkg.name, pkg.changelogTitle!, pkg.changelogURL!);
}
}
newline();
if (ctx.dryRun) {
await info('--dry-run', `Skipping dependency installation`);
} else {
await runInstallCommand(ctx, dependencies, devDependencies);
}
}
function filterPackages(ctx: Pick<Context, 'packages'>) {
const current: PackageInfo[] = [];
const dependencies: PackageInfo[] = [];
const devDependencies: PackageInfo[] = [];
for (const packageInfo of ctx.packages) {
const { currentVersion, targetVersion, isDevDependency } = packageInfo;
// Remove prefix from version before comparing
if (currentVersion.replace(/^\D+/, '') === targetVersion.replace(/^\D+/, '')) {
current.push(packageInfo);
} else {
const arr = isDevDependency ? devDependencies : dependencies;
arr.push(packageInfo);
}
}
return { current, dependencies, devDependencies };
}
/**
* An `Array#sort` comparator function to normalize how packages are displayed.
* This only changes how the packages are displayed in the CLI, it is not persisted to `package.json`.
*/
function sortPackages(a: PackageInfo, b: PackageInfo): number {
if (a.isMajor && !b.isMajor) return 1;
if (b.isMajor && !a.isMajor) return -1;
if (a.name === 'astro') return -1;
if (b.name === 'astro') return 1;
if (a.name.startsWith('@astrojs') && !b.name.startsWith('@astrojs')) return -1;
if (b.name.startsWith('@astrojs') && !a.name.startsWith('@astrojs')) return 1;
return a.name.localeCompare(b.name);
}
async function runInstallCommand(
ctx: Pick<Context, 'cwd' | 'packageManager' | 'exit'>,
dependencies: PackageInfo[],
devDependencies: PackageInfo[],
) {
const cwd = fileURLToPath(ctx.cwd);
if (ctx.packageManager.name === 'yarn') await ensureYarnLock({ cwd });
const installCommand = resolveCommand(ctx.packageManager.agent, 'add', []);
if (!installCommand) {
// NOTE: Usually it's impossible to reach here as `package-manager-detector` should
// already match a supported agent
error('error', `Unable to find install command for ${ctx.packageManager.name}.`);
return ctx.exit(1);
}
await spinner({
start: `Installing dependencies with ${ctx.packageManager.name}...`,
end: `Installed dependencies!`,
while: async () => {
try {
if (dependencies.length > 0) {
await shell(
installCommand.command,
[
...installCommand.args,
...dependencies.map(
({ name, targetVersion }) => `${name}@${targetVersion.replace(/^\^/, '')}`,
),
],
{ cwd, timeout: 90_000, stdio: 'ignore' },
);
}
if (devDependencies.length > 0) {
await shell(
installCommand.command,
[
...installCommand.args,
...devDependencies.map(
({ name, targetVersion }) => `${name}@${targetVersion.replace(/^\^/, '')}`,
),
],
{ cwd, timeout: 90_000, stdio: 'ignore' },
);
}
} catch {
const manualInstallCommand = [
installCommand.command,
...installCommand.args,
...[...dependencies, ...devDependencies].map(
({ name, targetVersion }) => `${name}@${targetVersion}`,
),
].join(' ');
newline();
error(
'error',
`Dependencies failed to install, please run the following command manually:\n${color.bold(manualInstallCommand)}`,
);
return ctx.exit(1);
}
},
});
await say([`${random(celebrations)} ${random(done)}`, random(bye)], { clear: false });
}
/**
* Yarn Berry (PnP) versions will throw an error if there isn't an existing `yarn.lock` file
* If a `yarn.lock` file doesn't exist, this function writes an empty `yarn.lock` one.
* Unfortunately this hack is required to run `yarn install`.
*
* The empty `yarn.lock` file is immediately overwritten by the installation process.
* See https://github.com/withastro/astro/pull/8028
*/
async function ensureYarnLock({ cwd }: { cwd: string }) {
const yarnLock = path.join(cwd, 'yarn.lock');
if (fs.existsSync(yarnLock)) return;
return fs.promises.writeFile(yarnLock, '', { encoding: 'utf-8' });
}
|
