Skip to content

Fix peerDependencies #263

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
franciscocardoso merged 1 commit into from
Jun 18, 2025
Merged

Fix peerDependencies #263

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 README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ $ npm install --save validator.js-asserts
```

### Peer dependencies
Some asserts require manually installing some _peer dependencies_. Failing to do so will result in runtime errors, as packages are required dynamically.

Peer dependencies are not listed on `package.json` because npm 2 considers them _mandatory peer dependencies_ and, therefore, always installs them, while [npm 3](https://github.com/npm/npm/blob/master/CHANGELOG.md#peerdependencies) follows a more consensual approach of _optional peer dependencies_, not installing them by default but generating warning and confusing error messages instead.
Some asserts require manually installing some _peer dependencies_. Failing to do so will result in runtime errors, as packages are required dynamically.

You should pin these package's peer dependencies to the ranges listed on the _optionalPeerDependencies_ key of this package's manifest.
Peer dependencies are listed on `package.json` under `peerDependencies`.
The `peerDependenciesMeta` key identifies which peer dependencies are optional. NPM will not automatically install optional peer dependencies. See [the NPM documentation](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#peerdependenciesmeta) for more information.

## Asserts
The following set of extra asserts are provided by this package:
Expand Down
65 changes: 63 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,7 @@
"test:watch": "node --test --watch"
},
"dependencies": {
"lodash": "^4.17.21",
"validator.js": "^2.0.0"
"lodash": "^4.17.21"
},
"devDependencies": {
"@fastify/pre-commit": "^2.2.0",
Expand All @@ -62,8 +61,70 @@
"uk-modulus-checking": "0.0.3",
"urijs": "^1.17.1",
"validate-rfc": "^2.0.3",
"validator.js": "^2.0.0",
"validator": "^13.15.15"
},
"peerDependencies": {
"abavalidator": "^2.0.0",
"bignumber.js": ">=7 || <=9.3.0",
"cpf": "^2.0.1",
"creditcard": ">=0.0.1 <1.0.0",
"curp": "^1.2.3",
"google-libphonenumber": ">=1 <4",
"iban": ">=0.0.6 <1.0.0",
"isoc": ">=0.0.1 <1.0.0",
"moment": "^2.0.0",
"tin-validator": "^1.0.0",
"uk-modulus-checking": "^0.0.2",
"urijs": "^1.0.0",
"validate-rfc": "^2.0.3",
"validator.js": "^2.0.0",
"validator": ">=3 <14"
},
"peerDependenciesMeta": {
"abavalidator": {
"optional": true
},
"bignumber.js": {
"optional": true
},
"cpf": {
"optional": true
},
"creditcard": {
"optional": true
},
"curp": {
"optional": true
},
"google-libphonenumber": {
"optional": true
},
"iban": {
"optional": true
},
"isoc": {
"optional": true
},
"moment": {
"optional": true
},
"tin-validator": {
"optional": true
},
"uk-modulus-checking": {
"optional": true
},
"urijs": {
"optional": true
},
"validate-rfc": {
"optional": true
},
"validator": {
"optional": true
}
},
"engines": {
"node": ">=20"
},
Expand Down