depcheck-detector-package-name

A depcheck detector that detects packages from a tagged template literal.

Install

# npm
$ npm install depcheck-detector-package-name

# Yarn
$ yarn add depcheck-detector-package-name

Usage

Sometimes it is necessary to refer to a package via a constant, e.g. when packages are required dynamically by third party packages. With this package you can declare constant strings as packages and depcheck detects them as used. The detector uses the helper package depcheck-package-name for this.

import packageName from 'depcheck-package-name'

export default {
  plugins: [
    packageName`eslint-plugin-foo`
  ]
}

Custom detectors are currently only supported when using depcheck via the Node.js API. Simply add the detector to your depcheck config and run depcheck:

const depcheck = require('depcheck')
const packageNameDetector = require('depcheck-detector-package-name')

const options = {
  detectors: [
    packageNameDetector,
  ],
}

depcheck(process.cwd(), options, unused => {
  console.log(unused.dependencies); // an array containing the unused dependencies
  console.log(unused.devDependencies); // an array containing the unused devDependencies
  console.log(unused.missing); // a lookup containing the dependencies missing in `package.json` and where they are used
  console.log(unused.invalidFiles); // files that cannot access or parse
  console.log(unused.invalidDirs); // directories that cannot access
})

Contribute

Are you missing something or want to contribute? Feel free to file an issue or a pull request! ⚙️

Support

Hey, I am Sebastian Landwehr, a freelance web developer, and I love developing web apps and open source packages. If you want to support me so that I can keep packages up to date and build more helpful tools, you can donate here:

Thanks a lot for your support! ❤️

License

MIT License © Sebastian Landwehr