-
Notifications
You must be signed in to change notification settings - Fork 1k
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
feat(cli): Enforce a node version via toml option #8907
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
import boxen from 'boxen' | ||
import semver from 'semver' | ||
|
||
import { getConfig } from '@redwoodjs/project-config' | ||
|
||
export async function enforceNodeVersionConfig() { | ||
// only check if a node version is specified in redwood.toml | ||
const config = getConfig() | ||
if (config.node.version !== undefined) { | ||
// get current node version, coerce to semver to remove leading 'v' | ||
const currentVersion = semver.coerce(process.version) | ||
|
||
// ensure config value is valid, either a valid semver or semver range | ||
const requiredVersion = config.node.version | ||
if ( | ||
semver.valid(requiredVersion) === null && | ||
semver.validRange(requiredVersion) === null | ||
) { | ||
console.error( | ||
boxen( | ||
`Node version '${requiredVersion}' is not valid in your redwood.toml`, | ||
{ padding: 1, borderColor: 'red', title: 'Node version enforcement' } | ||
) | ||
) | ||
process.exit(1) | ||
} | ||
|
||
// ensure current version satisfies required version | ||
if (!semver.satisfies(currentVersion, requiredVersion)) { | ||
console.error( | ||
boxen( | ||
`Node version '${currentVersion}' is not allowed by your redwood.toml, it requires '${requiredVersion}'`, | ||
{ padding: 1, borderColor: 'red', title: 'Node version enforcement' } | ||
) | ||
) | ||
process.exit(1) | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Josh-Walker-GM sorry to insert myself into this conversation, I'm a little bit scared of doing checks on the CLI on every run - could I suggest that we wrap the whole thing in a try catch?
This way if anything fails in the logic, for example cooercing the semver version (which happens sometimes, for example with the experimental releases) - it won't stop someone from using rw.
Up to you anyway, just a suggestion.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah that's certainly something we should to do, happy to.