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

Skip to content

Use peerDependencies instead of devDependencies for optional dependencies runtime version check #1426

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

Open
Kocal wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Use peerDependencies instead of devDependencies for optional dependencies runtime version check #1426

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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ can adopt modern async APIs from the ecosystem without hacks**.
- Add support for [[email protected]](https://github.com/webpack/webpack-cli/releases/tag/webpack-cli%407.0.0)
- `Encore.copyFiles()` now internally generates ESM exports for better webpack optimizations (scope hoisting, module concatenation)
- Add support for [[email protected]](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-6-0.html)
- The runtime version check for optional dependencies now reads supported version ranges from `peerDependencies` instead of `devDependencies`

## 6.0.0

Expand Down
14 changes: 8 additions & 6 deletions lib/package-helper.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,22 +187,24 @@ function addPackagesVersionConstraint(packages) {
const newData = Object.assign({}, packageData);

if (packageData.enforce_version) {
if (!packageJsonData.devDependencies) {
if (!packageJsonData.peerDependencies) {
logger.warning(
'Could not find devDependencies key on @symfony/webpack-encore package'
'Could not find peerDependencies key on @symfony/webpack-encore package'
);

return newData;
}

// this method only supports devDependencies due to how it's used:
// this method only supports peerDependencies due to how it's used:
// it's mean to inform the user what deps they need to install
// for optional features
if (!packageJsonData.devDependencies[packageData.name]) {
throw new Error(`Could not find package ${packageData.name}`);
if (!packageJsonData.peerDependencies[packageData.name]) {
throw new Error(
`Could not find package ${packageData.name} in peerDependencies of @symfony/webpack-encore`
);
}

newData.version = packageJsonData.devDependencies[packageData.name];
newData.version = packageJsonData.peerDependencies[packageData.name];
delete newData['enforce_version'];
}

Expand Down
2 changes: 1 addition & 1 deletion test/package-helper.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ describe('package-helper', function () {
);

const expectedPackages = [
{ name: 'sass-loader', version: packageInfo.devDependencies['sass-loader'] },
{ name: 'sass-loader', version: packageInfo.peerDependencies['sass-loader'] },
{ name: 'node-sass' },
{ name: 'vue', version: '^2' },
];
Expand Down
Loading