Skip to content

Commit

Permalink
[npm#5280] Ensure that flags like --save-dev imply --save, and are no…
Browse files Browse the repository at this point in the history
…t overridden by npm config
  • Loading branch information
ficocelliguy committed Feb 19, 2024
1 parent d04111d commit 0b07587
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 16 deletions.
9 changes: 9 additions & 0 deletions workspaces/config/lib/definitions/definitions.js
Original file line number Diff line number Diff line change
Expand Up @@ -1813,6 +1813,7 @@ define('save-dev', {
return
}

flatOptions.save = true
flatOptions.saveType = 'dev'
},
})
Expand All @@ -1826,6 +1827,9 @@ define('save-exact', {
version rather than using npm's default semver range operator.
`,
flatten (key, obj, flatOptions) {
if (obj[key]) {
flatOptions.save = true
}
// just call the save-prefix flattener, it reads from obj['save-exact']
definitions['save-prefix'].flatten('save-prefix', obj, flatOptions)
},
Expand All @@ -1849,6 +1853,8 @@ define('save-optional', {
return
}

flatOptions.save = true

if (flatOptions.saveType === 'peerOptional') {
return
}
Expand Down Expand Up @@ -1877,6 +1883,8 @@ define('save-peer', {
return
}

flatOptions.save = true

if (flatOptions.saveType === 'peerOptional') {
return
}
Expand Down Expand Up @@ -1928,6 +1936,7 @@ define('save-prod', {
return
}

flatOptions.save = true
flatOptions.saveType = 'prod'
},
})
Expand Down
46 changes: 30 additions & 16 deletions workspaces/config/test/definitions/definitions.js
Original file line number Diff line number Diff line change
Expand Up @@ -583,7 +583,8 @@ t.test('saveType', t => {
t.strictSame(flat, { saveType: 'dev' }, 'ignore if false and not already prod')
obj['save-prod'] = true
mockDefs()['save-prod'].flatten('save-prod', obj, flat)
t.strictSame(flat, { saveType: 'prod' }, 'set to prod if true')
t.strictSame(flat,
{ saveType: 'prod', save: true }, 'set to prod if true, and set save to true')
t.end()
})

Expand All @@ -601,7 +602,7 @@ t.test('saveType', t => {
t.strictSame(flat, { saveType: 'prod' }, 'ignore if false and not already dev')
obj['save-dev'] = true
mockDefs()['save-dev'].flatten('save-dev', obj, flat)
t.strictSame(flat, { saveType: 'dev' }, 'set to dev if true')
t.strictSame(flat, { saveType: 'dev', save: true }, 'set to dev if true, and set save to true')
t.end()
})

Expand All @@ -625,27 +626,33 @@ t.test('saveType', t => {

t.test('save-peer', t => {
const obj = { 'save-peer': false }
const flat = {}
let flat = {}
mockDefs()['save-peer'].flatten('save-peer', obj, flat)
t.strictSame(flat, {}, 'no effect if false and not yet set')

obj['save-peer'] = true
mockDefs()['save-peer'].flatten('save-peer', obj, flat)
t.strictSame(flat, { saveType: 'peer' }, 'set saveType to peer if unset')
t.strictSame(flat,
{ saveType: 'peer', save: true }, 'set saveType to peer if unset, and set save to true')

flat.saveType = 'optional'
flat = { saveType: 'optional' }
mockDefs()['save-peer'].flatten('save-peer', obj, flat)
t.strictSame(flat, { saveType: 'peerOptional' }, 'set to peerOptional if optional already')
t.strictSame(flat,
{ saveType: 'peerOptional', save: true },
'set to peerOptional, and set save to true if optional already')

flat = { saveType: 'optional' }
mockDefs()['save-peer'].flatten('save-peer', obj, flat)
t.strictSame(flat, { saveType: 'peerOptional' }, 'no effect if already peerOptional')
t.strictSame(flat,
{ saveType: 'peerOptional', save: true }, 'just set save to true if already peerOptional')

obj['save-peer'] = false
flat = { saveType: 'optional' }
mockDefs()['save-peer'].flatten('save-peer', obj, flat)
t.strictSame(flat, { saveType: 'optional' }, 'switch peerOptional to optional if false')

obj['save-peer'] = false
flat.saveType = 'peer'
flat = { saveType: 'peer' }
mockDefs()['save-peer'].flatten('save-peer', obj, flat)
t.strictSame(flat, {}, 'remove saveType if peer and setting false')

Expand All @@ -654,26 +661,32 @@ t.test('saveType', t => {

t.test('save-optional', t => {
const obj = { 'save-optional': false }
const flat = {}
let flat = {}
mockDefs()['save-optional'].flatten('save-optional', obj, flat)
t.strictSame(flat, {}, 'no effect if false and not yet set')

obj['save-optional'] = true
mockDefs()['save-optional'].flatten('save-optional', obj, flat)
t.strictSame(flat, { saveType: 'optional' }, 'set saveType to optional if unset')
t.strictSame(flat, { saveType: 'optional', save: true },
'set saveType to optional if unset, and set save to true')

flat.saveType = 'peer'
flat = { saveType: 'peer' }
mockDefs()['save-optional'].flatten('save-optional', obj, flat)
t.strictSame(flat, { saveType: 'peerOptional' }, 'set to peerOptional if peer already')
t.strictSame(flat,
{ saveType: 'peerOptional', save: true },
'set to peerOptional if peer already, and set save to true')

flat = { saveType: 'peer' }
mockDefs()['save-optional'].flatten('save-optional', obj, flat)
t.strictSame(flat, { saveType: 'peerOptional' }, 'no effect if already peerOptional')
t.strictSame(flat,
{ saveType: 'peerOptional', save: true }, 'just set save to true if already peerOptional')

obj['save-optional'] = false
flat = { saveType: 'peer' }
mockDefs()['save-optional'].flatten('save-optional', obj, flat)
t.strictSame(flat, { saveType: 'peer' }, 'switch peerOptional to peer if false')

flat.saveType = 'optional'
flat = { saveType: 'optional' }
mockDefs()['save-optional'].flatten('save-optional', obj, flat)
t.strictSame(flat, {}, 'remove saveType if optional and setting false')

Expand Down Expand Up @@ -801,10 +814,11 @@ t.test('save-exact', t => {
'save-exact': true,
'save-prefix': '~1.2.3',
}
const flat = {}
let flat = {}
mockDefs()['save-exact']
.flatten('save-exact', { ...obj, 'save-exact': true }, flat)
t.strictSame(flat, { savePrefix: '' })
t.strictSame(flat, { savePrefix: '', save: true })
flat = {}
mockDefs()['save-exact']
.flatten('save-exact', { ...obj, 'save-exact': false }, flat)
t.strictSame(flat, { savePrefix: '~1.2.3' })
Expand Down

0 comments on commit 0b07587

Please sign in to comment.