Skip to content

feat(add): Add minimum Node.js version warning if below 16. #625

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.

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/great-bags-smoke.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'sv': patch
---

feat: print warning if using Node.js version below 18.3
9 changes: 9 additions & 0 deletions packages/cli/utils/common.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import * as p from '@clack/prompts';
import type { Argument, HelpConfiguration, Option } from 'commander';
import { UnsupportedError } from './errors.ts';
import process from 'node:process';
import { minimumRequirement } from '@sveltejs/cli-core';

const NO_PREFIX = '--no-';
let options: readonly Option[] = [];
Expand Down Expand Up @@ -75,6 +76,14 @@ type MaybePromise = () => Promise<void> | void;
export async function runCommand(action: MaybePromise): Promise<void> {
try {
p.intro(`Welcome to the Svelte CLI! ${pc.gray(`(v${pkg.version})`)}`);

const unsupported = minimumRequirement('18.3').for(process.versions.node);
if (unsupported) {
p.log.warn(
`You are using Node.js ${pc.red(process.versions.node)}, please upgrade to Node.js 18.3 or higher.`
);
}

await action();
p.outro("You're all set!");
} catch (e) {
Expand Down
57 changes: 57 additions & 0 deletions packages/core/common.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
type Version = {
major?: number;
minor?: number;
patch?: number;
};

export function versionSplit(str: string): Version {
const [major, minor, patch] = str?.split('.') ?? [];

function toVersionNumber(val: string | undefined): number | undefined {
return val !== undefined && val !== '' && !isNaN(Number(val)) ? Number(val) : undefined;
}

return {
major: toVersionNumber(major),
minor: toVersionNumber(minor),
patch: toVersionNumber(patch)
};
}

function versionUnsupportedBelow(version_str: string, below_str: string): boolean | undefined {
const version = versionSplit(version_str);
const below = versionSplit(below_str);

if (version.major === undefined || below.major === undefined) return undefined;
if (version.major < below.major) return true;
if (version.major > below.major) return false;

if (version.minor === undefined || below.minor === undefined) {
if (version.major === below.major) return false;
else return true;
}
if (version.minor < below.minor) return true;
if (version.minor > below.minor) return false;

if (version.patch === undefined || below.patch === undefined) {
if (version.minor === below.minor) return false;
else return true;
}
if (version.patch < below.patch) return true;
if (version.patch > below.patch) return false;
if (version.patch === below.patch) return false;

return undefined;
}

/**
* @example
* const unsupported = minimumRequirement('18.3').for(process.versions.node);
*/
export function minimumRequirement(version: string): {
for: (target: string) => boolean | undefined;
} {
return {
for: (target: string) => versionUnsupportedBelow(target, version)
};
}
1 change: 1 addition & 0 deletions packages/core/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ export { log } from '@clack/prompts';
export { default as colors } from 'picocolors';
export { default as dedent } from 'dedent';
export * as utils from './utils.ts';
export { minimumRequirement, versionSplit } from './common.ts';

export type * from './addon/processors.ts';
export type * from './addon/options.ts';
Expand Down
50 changes: 50 additions & 0 deletions packages/core/tests/common.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
import { expect, describe, it } from 'vitest';
import { versionSplit, minimumRequirement } from '../common.ts';

describe('versionSplit', () => {
const combinationsVersionSplit = [
{ version: '18.13.0', expected: { major: 18, minor: 13, patch: 0 } },
{ version: 'x.13.0', expected: { major: undefined, minor: 13, patch: 0 } },
{ version: '18.y.0', expected: { major: 18, minor: undefined, patch: 0 } },
{ version: '18.13.z', expected: { major: 18, minor: 13, patch: undefined } },
{ version: '18', expected: { major: 18, minor: undefined, patch: undefined } },
{ version: '18.13', expected: { major: 18, minor: 13, patch: undefined } },
{ version: 'invalid', expected: { major: undefined, minor: undefined, patch: undefined } }
];
it.each(combinationsVersionSplit)(
'should return the correct version for $version',
({ version, expected }) => {
expect(versionSplit(version)).toEqual(expected);
}
);
});

describe('minimumRequirement', () => {
const combinationsMinimumRequirement = [
{ version: '17', below: '18.3.0', expected: true },
{ version: '18.2', below: '18.3.0', expected: true },
{ version: '18.3.0', below: '18.3.1', expected: true },
{ version: '18.3.1', below: '18.3.0', expected: false },
{ version: '18.3.0', below: '18.3.0', expected: false },
{ version: '18.3.0', below: '18.3', expected: false },
{ version: '18.3.1', below: '18.3', expected: false },
{ version: '18.3.1', below: '18', expected: false },
{ version: '18', below: '18', expected: false },
{ version: 'a', below: 'b', expected: undefined },
{ version: '18.3', below: '18.3', expected: false },
{ version: '18.4', below: '18.3', expected: false },
{ version: '18.2', below: '18.3', expected: true },

// if it's undefined, we can't say anything...
{ version: undefined!, below: '18.3', expected: undefined },
{ version: '', below: '18.3', expected: undefined }
] as const;
it.each(combinationsMinimumRequirement)(
'($version below $below) should be $expected',
({ version, below, expected }) => {
expect(minimumRequirement(below).for(version)).toEqual(expected);
}
);
});

// minimumRequirement(4.0).for(nodeVersion)