Support .node-version and .nvmrc by default; closes #683

This commit is contained in:
Steve Lacey 2023-01-30 14:41:29 +08:00
parent 3dbcda8bc2
commit f89df17cc9
4 changed files with 82 additions and 14 deletions

View File

@ -0,0 +1 @@
v16

View File

@ -155,14 +155,6 @@ describe('main tests', () => {
expect(parseNodeVersionSpy).toHaveBeenCalledTimes(0);
}, 10000);
it('not used if node-version-file not provided', async () => {
// Act
await main.run();
// Assert
expect(parseNodeVersionSpy).toHaveBeenCalledTimes(0);
});
it('reads node-version-file if provided', async () => {
// Arrange
const versionSpec = 'v14';
@ -215,6 +207,53 @@ describe('main tests', () => {
);
}, 10000);
it('reads .node-version if node-version and node-version-file were not provided', async () => {
// Arrange
const versionSpec = 'v16';
const versionFile = '.node-version';
const expectedVersionSpec = '16';
process.env['GITHUB_WORKSPACE'] = path.join(__dirname, 'data');
parseNodeVersionSpy.mockImplementation(() => expectedVersionSpec);
existsSpy.mockImplementationOnce(
input => input === path.join(__dirname, 'data', versionFile)
);
// Act
await main.run();
// Assert
expect(existsSpy).toHaveBeenCalledTimes(1);
expect(existsSpy).toHaveReturnedWith(true);
expect(parseNodeVersionSpy).toHaveBeenCalledWith(versionSpec);
expect(infoSpy).toHaveBeenCalledWith(
`Resolved ${versionFile} as ${expectedVersionSpec}`
);
}, 10000);
it('reads .nvmrc if node-version and node-version-file were not provided', async () => {
// Arrange
const versionSpec = 'v14';
const versionFile = '.nvmrc';
const expectedVersionSpec = '14';
process.env['GITHUB_WORKSPACE'] = path.join(__dirname, 'data');
parseNodeVersionSpy.mockImplementation(() => expectedVersionSpec);
existsSpy.mockImplementation(
input => input === path.join(__dirname, 'data', versionFile)
);
// Act
await main.run();
// Assert
expect(existsSpy).toHaveBeenCalledTimes(2);
expect(parseNodeVersionSpy).toHaveBeenCalledWith(versionSpec);
expect(infoSpy).toHaveBeenCalledWith(
`Resolved ${versionFile} as ${expectedVersionSpec}`
);
}, 10000);
it('both node-version-file and node-version are provided', async () => {
inputs['node-version'] = '12';
const versionSpec = 'v14';

17
dist/setup/index.js vendored
View File

@ -74003,11 +74003,22 @@ function resolveVersionInput() {
}
if (versionFileInput) {
const versionFilePath = path.join(process.env.GITHUB_WORKSPACE, versionFileInput);
if (!fs_1.default.existsSync(versionFilePath)) {
if (fs_1.default.existsSync(versionFilePath)) {
version = util_1.parseNodeVersionFile(fs_1.default.readFileSync(versionFilePath, 'utf8'));
core.info(`Resolved ${versionFileInput} as ${version}`);
return version;
}
else {
throw new Error(`The specified node version file at: ${versionFilePath} does not exist`);
}
version = util_1.parseNodeVersionFile(fs_1.default.readFileSync(versionFilePath, 'utf8'));
core.info(`Resolved ${versionFileInput} as ${version}`);
}
for (const versionFile of ['.node-version', '.nvmrc']) {
const versionFilePath = path.join(process.env.GITHUB_WORKSPACE, versionFile);
if (fs_1.default.existsSync(versionFilePath)) {
version = util_1.parseNodeVersionFile(fs_1.default.readFileSync(versionFilePath, 'utf8'));
core.info(`Resolved ${versionFile} as ${version}`);
return version;
}
}
return version;
}

View File

@ -97,15 +97,32 @@ function resolveVersionInput(): string {
versionFileInput
);
if (!fs.existsSync(versionFilePath)) {
if (fs.existsSync(versionFilePath)) {
version = parseNodeVersionFile(fs.readFileSync(versionFilePath, 'utf8'));
core.info(`Resolved ${versionFileInput} as ${version}`);
return version;
} else {
throw new Error(
`The specified node version file at: ${versionFilePath} does not exist`
);
}
}
version = parseNodeVersionFile(fs.readFileSync(versionFilePath, 'utf8'));
for (const versionFile of ['.node-version', '.nvmrc']) {
const versionFilePath = path.join(
process.env.GITHUB_WORKSPACE!,
versionFile
);
core.info(`Resolved ${versionFileInput} as ${version}`);
if (fs.existsSync(versionFilePath)) {
version = parseNodeVersionFile(fs.readFileSync(versionFilePath, 'utf8'));
core.info(`Resolved ${versionFile} as ${version}`);
return version;
}
}
return version;