@rgrannell/depcheck v9.4.0

depcheck (v9.3.0)

Stability

0 - Experimental

check that a project has no unused dependencies

Overview

Depcheck is a build system step designed to fail when a project has unused dependencies

• Call depcheck with the folder containing the project's package.json
• Wire this call into a pulp command or an alternative build-system

Table of Contents

• runDepcheck
  • Parameters
• depcheck
  • Parameters

API Documentation

runDepcheck

run the dependency check module

Parameters

• fpath string the path to the target directory

Returns Promise<object> a promise containing dependency information

depcheck

Throw an error if a package has any unused packages.

Parameters

• fpath string the folder path containing the package.json

Returns Promise a result promise

Dependencies

• Node.js >= v10.6.0
• NPM >= v10.6.0

License

Copyright (c) 2020 Róisín Grannell

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.