\n Check package dependencies for duplicates, peer dependencies satisfaction and more early\n
\n\n
\n \n \n \n \n \n \n
\n\n### Install\n\n```sh\nnpm install --save-dev @merger203/expert-invention\n```\n\n### What is it for ?\n\nBased on my experience, I often saw issues with duplicate dependencies like two versions of babel, or two versions a react library that cannot share a context, peer dependencies not respected. I wrote specific script inside each repository for a long time, but they tend to be hard to maintain, hard to read, and not generic enough.\n\nI you have any idea, or found bug, please open an issue.\n\n### Try it with cli\n\nUse npx to try and check `package.json` in current directory:\n\n```bash\nnpx @merger203/expert-invention\n```\n\n### Uses Cases\n\n- Check devDependencies are exact versions\n- Check resolutions versions matches versions in devDependencies or dependencies\n- Check direct peer dependencies are respected, and list exceptions\n- Check some dependencies in your package.json respect another dependency dependencies\n- Lock versions depending on certain conditions\n- Be more confident when automerging [renovate](https://www.whitesourcesoftware.com/free-developer-tools/renovate)'s PR\n\nIf something is missing for your need, please open an issue !\n\n### How to use\n\nCreate a script, for example `scripts/check-package.js`. Add it in `\"scripts\"` in your package.json. Run in CI and/or in your husky hooks.\n\n```js\nimport { createCheckPackage } from '@merger203/expert-invention';\n\nawait createCheckPackage(/* '.' */)\n // Check that your package.json contains only exact versions of package, not range.\n .checkExactVersions({\n // When isLibrary is true, it doesnt check \"dependencies\" as they should mostly have a range, not an exact version\n isLibrary: false,\n })\n .checkDirectPeerDependencies({\n // Allow to only warn for not respected peer dependencies.\n // Example: { '@babel/cli': ['@babel/core'] }\n // Only warns for missing \"@babel/core\" peer dependency asked in \"@babel/cli\".\n // You can also use \"*\" for any library\n // { '*': ['semver'] }\n missingOnlyWarnsFor: {},\n invalidOnlyWarnsFor: {},\n })\n // Check that there are no duplicates among your dependencies and your devDependencies.\n // For example, If you use \"@babel/core\": \"7.0.0\" and one of your direct dependency requires \"^7.0.1\" (in dependencies, not peerDependency)\n // you will have two versions of @babel/core. This check will display an error that can be changed to a warning.\n // You will probably need to add warnings for common library where duplicate have low impact,\n // like type-fest or fast-deep-equal.\n .checkDirectDuplicateDependencies({\n onlyWarnsFor: { '*': 'type-fest' },\n })\n // Check resolutions versions matches versions in devDependencies or dependencies\n .checkResolutionsVersionsMatch()\n // Check that all your resolutions are also present in an \"resolutionsExplained\" field, forcing you to explain why the resolution was necessary\n .checkResolutionsHasExplanation()\n // Same as calling .checkExactVersions(), checkDirectPeerDependencies(), checkDirectDuplicateDependencies()\n // and checkResolutionsHasExplanation(). It's recommended to use it as new recommended features will be added here too.\n .checkRecommended({\n isLibrary: false,\n peerDependenciesOnlyWarnsFor: [],\n directDuplicateDependenciesOnlyWarnsFor: ['type-fest'],\n })\n // Check that your package.json contains the same version of @babel/core than react-scripts, both in resolutions and devDependencies\n .checkIdenticalVersionsThanDependency('react-scripts', {\n resolutions: ['@babel/core'],\n devDependencies: ['@babel/core'],\n })\n // Check that your package.json dependencies specifically satisfies the range set in another dependencies\n .checkSatisfiesVersionsFromDependency('@pob/eslint-config-typescript', {\n devDependencies: [\n '@typescript-eslint/eslint-plugin',\n '@typescript-eslint/parser',\n ],\n })\n // Check that your package.json dependencies have the exact same version that another dependency also present in your package.json\n // The react-dom version should match react, so this check will ensure it does\n .checkIdenticalVersions({\n dependencies: {\n react: {\n dependencies: ['react-dom'],\n devDependencies: ['react-test-renderer'],\n },\n },\n })\n .run();\n```\n\n```js\n'use script';\n\nconst { createCheckPackage } = require('@merger203/expert-invention');\n\nawait createCheckPackage(/* '.' */)\n // Call .checkExactVersions(), checkDirectPeerDependencies(), checkDirectDuplicateDependencies()\n // checkResolutionsVersionsMatch() and checkResolutionsHasExplanation()\n .checkRecommended({})\n .run();\n```\n\nIf you use workspaces:\n\n```js\n'use script';\n\nconst {\n createCheckPackageWithWorkspaces,\n} = require('@merger203/expert-invention');\n\nawait createCheckPackageWithWorkspaces()\n // Call .checkExactVersions(), checkDirectPeerDependencies(), checkDirectDuplicateDependencies()\n // checkResolutionsVersionsMatch() and checkResolutionsHasExplanation() for root package and workspaces packages, but also\n // checks your workspaces packages doesn't have different versions than the ones in devDependencies of root packages.\n .checkRecommended({\n isLibrary: (pkgName) => !pkgName.endsWith('-example'),\n peerDependenciesOnlyWarnsFor: [],\n directDuplicateDependenciesOnlyWarnsFor: ['semver', 'github-username'],\n })\n .forRoot((rootPackageCheck) => {\n /* rootPackageCheck has the same API presented for single package */\n })\n .for('packageName', (pkgCheck) => {\n /* pkgCheck has the same API presented for single package */\n })\n .run();\n```\n","readmeFilename":"README.md"}
![](\"https://img.shields.io/npm/v/@merger203/expert-invention.svg?style=flat-square\")
\n ![](\"https://img.shields.io/npm/dw/@merger203/expert-invention.svg?style=flat-square\")
\n ![](\"https://img.shields.io/node/v/@merger203/expert-invention.svg?style=flat-square\")
\n ![](\"https://img.shields.io/npm/types/@merger203/expert-invention.svg?style=flat-square\")
\n ![](\"https://img.shields.io/codecov/c/github/christophehurpeau/@merger203/expert-invention/master.svg?style=flat-square\")
\n ![](\"https://img.shields.io/website.svg?down_color=lightgrey&down_message=offline&up_color=blue&up_message=online&url=https%3A%2F%2Fchristophehurpeau.github.io%2F@merger203/expert-invention%2F?style=flat-square\")
\n