Easy detection of useless dependencies in your package.json
file.
npx cleanup-deps@latest
inside your project root directory.
Option | value | Default | Description |
---|---|---|---|
--path |
<path> |
pwd |
path to directory contains your package.json file. |
--config |
<path> |
pwd |
path to config file |
You can create config file to customize the behavior of the tool.
npx cleanup-deps@latest --config ./config.cleanup-deps.mjs
mjs
is important. Only ESM modules are supported.
Example of config file:
// config.cleanup-deps.mjs
import { createConfig, declareValidation } from './index.js';
export default createConfig({
packageJsonPath: '..',
validateFn: declareValidation({
'yargs': {
minimalNodeVersion: '0.0.0',
message: 'test',
validUntil: new Date(),
}
})
})
createConfig
Wrapper for config object for better IDE support. Example of usage you can see above. Arguments:
packageJsonPath
- path to package.json
file. Default: process.cwd()
validateFn
- function that will be called for each dependency. Please see createValidationFn
for more details.declareValidation
Helper function to declare validation rules for specific package. Example of usage you can see above. Arguments:
minimalNodeVersion
- minimal node version for which package is deprecated.message
- message that will be shown if package is deprecated.validUntil
[Optional]
- date until package is valid. If date is expired, package will be marked as deprecated.createValidateFn
Helper function to create validate function for specific package. Should return validDep
or invalidDep
.
Example of usage you can see in declareValidation file
mergeValidateFn
Helper function to merge validate functions.
You can use --config
option to declare config file with validUntil
for specific package.
For example:
// config.cleanup-deps.mjs
import { createConfig, declareValidation } from './index.js';
export default createConfig({
packageJsonPath: '..',
validateFn: declareValidation({
'object.assign': {
minimalNodeVersion: '0.0.0',
message: 'test',
validUntil: new Date('2030-01-01'),
}
})
})
After '2030-01-01' date, the package object.assign
will be shown in the report. Before that the package will be undeprecated dep.
dependencies
and devDependencies
sections are supported.