Thanks to visit codestin.com
Credit goes to github.com

Skip to content

feat!: use an allow list of built dependencies by default #8897

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 3 commits into from
Dec 24, 2024
+37 −6
Merged

feat!: use an allow list of built dependencies by default #8897

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2385e50
feat!: use an allow list of built dependencies by default
zkochan Dec 20, 2024
e741eab
test: fix
zkochan Dec 21, 2024
d65cacc
docs: add changesets
zkochan Dec 21, 2024
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: 6 additions & 0 deletions .changeset/tiny-pianos-mate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@pnpm/config": major
"pnpm": major
---

By default don't run lifecycle scripts of dependencies during installation. In order to allow lifecycle scripts of specific dependencies, they should be listed in the `pnpm.onlyBuiltDependencies` field of `package.json` [#8897](https://github.com/pnpm/pnpm/pull/8897).
5 changes: 4 additions & 1 deletion config/config/src/getOptionsFromRootManifest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,11 @@ export function getOptionsFromRootManifest (manifestDir: string, manifest: Proje
}
)
const neverBuiltDependencies = manifest.pnpm?.neverBuiltDependencies
const onlyBuiltDependencies = manifest.pnpm?.onlyBuiltDependencies
let onlyBuiltDependencies = manifest.pnpm?.onlyBuiltDependencies
const onlyBuiltDependenciesFile = manifest.pnpm?.onlyBuiltDependenciesFile
if (onlyBuiltDependenciesFile == null && neverBuiltDependencies == null) {
onlyBuiltDependencies = []
}
const packageExtensions = manifest.pnpm?.packageExtensions
const ignoredOptionalDependencies = manifest.pnpm?.ignoredOptionalDependencies
const peerDependencyRules = manifest.pnpm?.peerDependencyRules
Expand Down
6 changes: 5 additions & 1 deletion exec/plugin-commands-rebuild/test/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -375,7 +375,11 @@ test(`rebuild should not fail on incomplete ${WANTED_LOCKFILE}`, async () => {
})

test('never build neverBuiltDependencies', async () => {
const project = prepare()
const project = prepare({
pnpm: {
neverBuiltDependencies: [],
},
})
const cacheDir = path.resolve('cache')
const storeDir = path.resolve('store')

Expand Down
6 changes: 4 additions & 2 deletions pnpm/test/install/global.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,9 @@ test('run lifecycle events of global packages in correct working directory', asy
prepare()
const global = path.resolve('..', 'global')
const pnpmHome = path.join(global, 'pnpm')
fs.mkdirSync(global)
const globalPkgDir = path.join(pnpmHome, 'global', String(LAYOUT_VERSION))
fs.mkdirSync(globalPkgDir, { recursive: true })
fs.writeFileSync(path.join(globalPkgDir, 'package.json'), JSON.stringify({ pnpm: { neverBuiltDependencies: [] } }))

const env = {
[PATH_NAME]: `${pnpmHome}${path.delimiter}${process.env[PATH_NAME]!}`,
Expand All @@ -84,7 +86,7 @@ test('run lifecycle events of global packages in correct working directory', asy

await execPnpm(['install', '-g', '@pnpm.e2e/[email protected]'], { env })

expect(fs.existsSync(path.join(global, `pnpm/global/${LAYOUT_VERSION}/node_modules/@pnpm.e2e/postinstall-calls-pnpm/created-by-postinstall`))).toBeTruthy()
expect(fs.existsSync(path.join(globalPkgDir, 'node_modules/@pnpm.e2e/postinstall-calls-pnpm/created-by-postinstall'))).toBeTruthy()
})

test('global update to latest', async () => {
Expand Down
12 changes: 10 additions & 2 deletions pnpm/test/install/lifecycleScripts.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,12 @@ test('prepare is executed after argumentless installation', () => {
})

test('dependency should not be added to package.json and lockfile if it was not built successfully', async () => {
const project = prepare({ name: 'foo', version: '1.0.0' })
const initialPkg = {
name: 'foo',
version: '1.0.0',
pnpm: { neverBuiltDependencies: [] },
}
const project = prepare(initialPkg)

const result = execPnpmSync(['install', '[email protected]'])

Expand All @@ -114,7 +119,7 @@ test('dependency should not be added to package.json and lockfile if it was not
expect(project.readLockfile()).toBeFalsy()

const { default: pkg } = await import(path.resolve('package.json'))
expect(pkg).toStrictEqual({ name: 'foo', version: '1.0.0' })
expect(pkg).toStrictEqual(initialPkg)
})

test('node-gyp is in the PATH', async () => {
Expand Down Expand Up @@ -237,6 +242,9 @@ test('ignores pnpm.executionEnv specified by dependencies', async () => {
// this package's package.json has pnpm.executionEnv.nodeVersion = '20.0.0'
'@pnpm.e2e/has-execution-env': '1.0.0',
},
pnpm: {
neverBuiltDependencies: [],
},
})

await execPnpm(['install'])
Expand Down
8 changes: 8 additions & 0 deletions pnpm/test/monorepo/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1230,6 +1230,14 @@ auto-install-peers=false`, 'utf8')

test('dependencies of workspace projects are built during headless installation', async () => {
const projects = preparePackages([
{
location: '.',
package: {
pnpm: {
neverBuiltDependencies: [],
},
},
},
{
name: 'project-1',
version: '1.0.0',
Expand Down
Loading