Skip to content

fix: update error message for checkDevEngines #128

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Aug 25, 2025
Merged

fix: update error message for checkDevEngines #128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions lib/dev-engines.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,14 +90,14 @@ function checkDependency (wanted, current, opts) {
/** checks devEngines package property and returns array of warnings / errors */
function checkDevEngines (wanted, current = {}, opts = {}) {
if ((typeof wanted !== 'object' || wanted === null) || Array.isArray(wanted)) {
throw new Error(`Invalid non-object value for devEngines`)
throw new Error(`Invalid non-object value for "devEngines"`)
}

const errors = []

for (const engine of Object.keys(wanted)) {
if (!recognizedEngines.includes(engine)) {
throw new Error(`Invalid property "${engine}"`)
throw new Error(`Invalid property "devEngines.${engine}"`)
}
const dependencyAsAuthored = wanted[engine]
const dependencies = [dependencyAsAuthored].flat()
Expand Down Expand Up @@ -125,7 +125,7 @@ function checkDevEngines (wanted, current = {}, opts = {}) {
onFail = 'error'
}

const err = Object.assign(new Error(`Invalid engine "${engine}"`), {
const err = Object.assign(new Error(`Invalid devEngines.${engine}`), {
errors: depErrors,
engine,
isWarn: onFail === 'warn',
Expand Down
20 changes: 10 additions & 10 deletions test/check-dev-engines.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ t.test('unrecognized property', async t => {
const current = { name: `alpha` }
t.throws(
() => checkDevEngines({ unrecognized: wanted }, { os: current }),
new Error('Invalid property "unrecognized"')
new Error('Invalid property "devEngines.unrecognized"')
)
})

Expand All @@ -24,7 +24,7 @@ t.test('invalid name', async t => {
const wanted = { name: `alpha`, onFail: 'download' }
const current = { name: `beta` }
t.same(checkDevEngines({ os: wanted }, { os: current }), [
Object.assign(new Error(`Invalid engine "os"`), {
Object.assign(new Error(`Invalid devEngines.os`), {
errors: [
new Error(`Invalid name "alpha" does not match "beta" for "os"`),
],
Expand Down Expand Up @@ -52,7 +52,7 @@ t.test('tests non-object', async t => {
version: '14',
},
}),
new Error(`Invalid non-object value for devEngines`)
new Error(`Invalid non-object value for "devEngines"`)
)
})

Expand Down Expand Up @@ -153,7 +153,7 @@ t.test('tests all the right fields', async t => {
const wanted = { name: `test-name`, version: 'test-version-wanted' }
const current = { name: `test-name`, version: 'test-version-current' }
t.same(checkDevEngines({ [env]: wanted }, { [env]: current }), [
Object.assign(new Error(`Invalid engine "${env}"`), {
Object.assign(new Error(`Invalid devEngines.${env}`), {
errors: [
// eslint-disable-next-line max-len
new Error(`Invalid version "test-version-wanted" does not match "test-version-current" for "${env}"`),
Expand All @@ -175,7 +175,7 @@ t.test('tests all the right fields', async t => {
const wanted = { name: `test-name`, version: '^1.0.0' }
const current = { name: `test-name`, version: '2.0.0' }
t.same(checkDevEngines({ [env]: wanted }, { [env]: current }), [
Object.assign(new Error(`Invalid engine "${env}"`), {
Object.assign(new Error(`Invalid devEngines.${env}`), {
errors: [
// eslint-disable-next-line max-len
new Error(`Invalid semver version "^1.0.0" does not match "2.0.0" for "${env}"`),
Expand All @@ -200,7 +200,7 @@ t.test('tests all the right fields', async t => {
]
const current = { name: `test-name`, version: 'test-version-three' }
t.same(checkDevEngines({ [env]: wanted }, { [env]: current }), [
Object.assign(new Error(`Invalid engine "${env}"`), {
Object.assign(new Error(`Invalid devEngines.${env}`), {
errors: [
// eslint-disable-next-line max-len
new Error(`Invalid version "test-version-one" does not match "test-version-three" for "${env}"`),
Expand Down Expand Up @@ -238,7 +238,7 @@ t.test('tests all the right fields', async t => {
const wanted = { name: `alpha` }
const current = { name: `beta` }
t.same(checkDevEngines({ [env]: wanted }, { [env]: current }), [
Object.assign(new Error(`Invalid engine "${env}"`), {
Object.assign(new Error(`Invalid devEngines.${env}`), {
errors: [
new Error(`Invalid name "alpha" does not match "beta" for "${env}"`),
],
Expand Down Expand Up @@ -343,7 +343,7 @@ t.test('spec 2', async t => {
runtime: { name: 'node', version: '20.0.0' },
packageManager: { name: 'yarn', version: '3.2.3' },
}), [
Object.assign(new Error(`Invalid engine "os"`), {
Object.assign(new Error(`Invalid devEngines.os`), {
errors: [
// eslint-disable-next-line max-len
new Error(`Invalid semver version ">= 23.0.0" does not match "10.0.0" for "os"`),
Expand All @@ -366,7 +366,7 @@ t.test('spec 2', async t => {
runtime: { name: 'nondescript', version: '20.0.0' },
packageManager: { name: 'yarn', version: '3.2.3' },
}), [
Object.assign(new Error(`Invalid engine "runtime"`), {
Object.assign(new Error(`Invalid devEngines.runtime`), {
errors: [
// eslint-disable-next-line max-len
new Error(`Invalid name "bun" does not match "nondescript" for "runtime"`),
Expand Down Expand Up @@ -403,7 +403,7 @@ t.test('empty array along side error', async t => {
}, {
cpu: { name: 'arm' },
runtime: { name: 'node', version: '20.0.0' },
}), [Object.assign(new Error(`Invalid engine "runtime"`), {
}), [Object.assign(new Error(`Invalid devEngines.runtime`), {
errors: [
new Error(`Invalid name "bun" does not match "node" for "runtime"`),
],
Expand Down
Loading