Skip to content
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
wants to merge 1 commit into from
Closed
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
2 changes: 2 additions & 0 deletions packages/cli/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ import * as upgradeCommand from './commands/upgrade'
import { getPaths, findUp } from './lib'
import { exitWithError } from './lib/exit'
import * as updateCheck from './lib/updateCheck'
import { enforceNodeVersionConfig } from './middleware/enforceNodeVersionConfig'
import { loadPlugins } from './plugin'
import { startTelemetry, shutdownTelemetry } from './telemetry/index'

Expand Down Expand Up @@ -171,6 +172,7 @@ async function runYargs() {
delete argv.telemetry
},
telemetry && telemetryMiddleware,
enforceNodeVersionConfig,
updateCheck.isEnabled() && updateCheck.updateCheckMiddleware,
].filter(Boolean)
)
Expand Down
39 changes: 39 additions & 0 deletions packages/cli/src/middleware/enforceNodeVersionConfig.js
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() {
Copy link
Contributor

@dac09 dac09 Jul 28, 2023

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.

Copy link
Collaborator Author

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.

// 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)
}
}
}
3 changes: 3 additions & 0 deletions packages/project-config/src/__tests__/config.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,9 @@ describe('getConfig', () => {
"stories": true,
"tests": true,
},
"node": {
"version": undefined,
},
"notifications": {
"versionUpdates": [],
},
Expand Down
6 changes: 6 additions & 0 deletions packages/project-config/src/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,9 @@ export interface Config {
notifications: {
versionUpdates: string[]
}
node: {
version?: string
}
experimental: {
opentelemetry: {
enabled: boolean
Expand Down Expand Up @@ -156,6 +159,9 @@ const DEFAULT_CONFIG: Config = {
notifications: {
versionUpdates: [],
},
node: {
version: undefined,
},
experimental: {
opentelemetry: {
enabled: false,
Expand Down