package
This utility will parse the `*.js` files and the `*.ts` files in your `src` folder to identify all packages used in the `import {xxx} from "package"` statement. And it will report an error if that package is missing from the `package.json`.
npm install report-missing-dependenciesGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
report-missing-dependencies: Check all the dependencies in the package.jsonThis utility will parse the *.js files and the *.ts files in your src folder to identify all packages used in the import {xxx} from "package" statement. And it will report an error if that package is missing from the package.json.
import {xx} from "my-package") is used in the src folder but not defined in the dependencies section (or peerDependencies section) of the package.json.import type {MyType} from "my-package") but that package is not in the devDependencies section of the package.json.{
"name": "your-project",
...
"scripts": {
"tsc": "tsc --build tsconfig.json",
"build": "report-missing-dependencies && npm run tsc"
},
"devDependencies": {
"report-missing-dependencies": "*"
}
}Usage: report-missing-dependencies [options]
Options:
--cwd <string> Execution folder
(default: ".")
--src <string> Source folder (default: "src")
--ignoredDependencies <string...> Packages that are used in the `src` folder
(e.g. `import fs from "fs"`) but do not
need to be added to the `dependencies`
section of the `package.json`.
(default: "fs http net url")
--runtimeDependencies <string...> Packages that are not used in an import
statement in the `src` folder but still
need to be specified in the `dependencies`
section of the `package.json`.
(default: "")
--testMatch <string...> The glob patterns uses to detect test files.
(default: "**/__tests__/**/*.?(m|c)[jt]s?(x) **/__stories__/**/*.?(m|c)[jt]s?(x) **/?(*.)+(spec|specs|test|tests|story|stories).?(m|c)[jt]s?(x)")
-h, --help display help for command//.rmdrc.js
const builtinModules = require("module").builtinModules;
module.exports = {
src: "src",
ignoredDependencies: [...builtinModules],
runtimeDependencies: [],
testMatch: [
"**/__tests__/**/*.?(m|c)[jt]s?(x)",
"**/__stories__/**/*.?(m|c)[jt]s?(x)",
"**/?(*.)+(spec|specs|test|tests|story|stories).?(m|c)[jt]s?(x)"
]
}Invalid dependencies in the package.json of a project can cause any issues.
devDependencies rather than the dependencies, you will not notice any issue in development mode (because yarn install installs all dependencies in the node_modules folder), but you will experience some runtime errors in production (because yarn isntall --production does not install dev dependencies).You can arguably use depcheck to identify missing dependencies.
In fact, depcheck has many more options than report-missing-dependencies.
But report-missing-dependencies has the advantage that it can be used in the Continuous Integration pipeline.
Estimated unpacked size across 27 packages.
9.5 MB
Includes dependencies.