# depcheck-rs
Work in progress.

Depcheck is a tool for analyzing the dependencies in a project to see: how each dependency is used, which dependencies are useless, and which dependencies are missing from `package.json`.
It is a port of original [depcheck](https://github.com/depcheck/depcheck). It uses [swc](https://github.com/swc-project/swc) for parsing.

## Installation

```
npm install @depcheck-rs-node/core
```

## Syntax Support

Depcheck not only recognizes the dependencies in JavaScript files, but also supports these syntaxes:

- JavaScript (ES5, ES6 and ES7)
- [React JSX](http://facebook.github.io/react/docs/jsx-in-depth.html)
- [Typescript](http://www.typescriptlang.org/)

[comment]: <> (## Usage)

[comment]: <> (```)

[comment]: <> (depcheck [directory] [arguments])

[comment]: <> (```)

[comment]: <> (The `directory` argument is the root directory of your project &#40;where the `package.json` file is&#41;. If unspecified, defaults to current directory.)

[comment]: <> (All of the arguments are optional:)

[comment]: <> (`--ignore-bin-package=[true|false]`: A flag to indicate if depcheck ignores the packages containing bin entry. The default value is `false`.)

[comment]: <> (`--skip-missing=[true|false]`: A flag to indicate if depcheck skips calculation of missing dependencies. The default value is `false`.)

[comment]: <> (`--json`: Output results in JSON. When not specified, depcheck outputs in human friendly format.)

[comment]: <> (`--oneline`: Output results as space separated string. Useful for copy/paste.)

[comment]: <> (`--ignores`: A comma separated array containing package names to ignore. It can be glob expressions. Example, `--ignores="eslint,babel-*"`.)

[comment]: <> (`--ignore-dirs`: DEPRECATED, use ignore-patterns instead. A comma separated array containing directory names to ignore. Example, `--ignore-dirs=dist,coverage`.)

[comment]: <> (`--ignore-path`: Path to a file with patterns describing files to ignore. Files must match the .gitignore [spec]&#40;http://git-scm.com/docs/gitignore&#41;. Example, `--ignore-path=.eslintignore`.)

[comment]: <> (`--ignore-patterns`: Comma separated patterns describing files to ignore. Patterns must match the .gitignore [spec]&#40;http://git-scm.com/docs/gitignore&#41;. Example, `--ignore-patterns=build/Release,dist,coverage,*.log`.)

[comment]: <> (`--help`: Show the help message.)

[comment]: <> (`--parsers`, `--detectors` and `--specials`: These arguments are for advanced usage. They provide an easy way to customize the file parser and dependency detection. Check [the pluggable design document]&#40;https://github.com/depcheck/depcheck/blob/master/doc/pluggable-design.md&#41; for more information.)

[comment]: <> (`--config=[filename]`: An external configuration file &#40;see below&#41;.)

[comment]: <> (## Usage with a configuration file)

[comment]: <> (Depcheck can be used with an rc configuration file. In order to do so, create a .depcheckrc file in your project's package.json folder, and set the CLI keys in YAML, JSON, and Javascript formats.)

[comment]: <> (For example, the CLI arguments `--ignores="eslint,babel-*" --skip-missing=true` would turn into:)

[comment]: <> (**_.depcheckrc_**)

[comment]: <> (```)

[comment]: <> (ignores: ["eslint", "babel-*"])

[comment]: <> (skip-missing: true)

[comment]: <> (```)

[comment]: <> (**Important:** if provided CLI arguments conflict with configuration file ones, the CLI ones will take precedence over the rc file ones.)

[comment]: <> (The rc configuration file can also contain the following extensions: `.json`, `.yaml`, `.yml`.)

[comment]: <> (## API)

[comment]: <> (Similar options are provided to `depcheck` function for programming:)

[comment]: <> (```js)

[comment]: <> (import depcheck from 'depcheck';)

[comment]: <> (const options = {)

[comment]: <> (  ignoreBinPackage: false, // ignore the packages with bin entry)

[comment]: <> (  skipMissing: false, // skip calculation of missing dependencies)

[comment]: <> (  ignorePatterns: [)

[comment]: <> (    // files matching these patterns will be ignored)

[comment]: <> (    'sandbox',)

[comment]: <> (    'dist',)

[comment]: <> (    'bower_components',)

[comment]: <> (  ],)

[comment]: <> (  ignoreMatches: [)

[comment]: <> (    // ignore dependencies that matches these globs)

[comment]: <> (    'grunt-*',)

[comment]: <> (  ],)

[comment]: <> (  parsers: {)

[comment]: <> (    // the target parsers)

[comment]: <> (    '**/*.js': depcheck.parser.es6,)

[comment]: <> (    '**/*.jsx': depcheck.parser.jsx,)

[comment]: <> (  },)

[comment]: <> (  detectors: [)

[comment]: <> (    // the target detectors)

[comment]: <> (    depcheck.detector.requireCallExpression,)

[comment]: <> (    depcheck.detector.importDeclaration,)

[comment]: <> (  ],)

[comment]: <> (  specials: [)

[comment]: <> (    // the target special parsers)

[comment]: <> (    depcheck.special.eslint,)

[comment]: <> (    depcheck.special.webpack,)

[comment]: <> (  ],)

[comment]: <> (  package: {)

[comment]: <> (    // may specify dependencies instead of parsing package.json)

[comment]: <> (    dependencies: {)

[comment]: <> (      lodash: '^4.17.15',)

[comment]: <> (    },)

[comment]: <> (    devDependencies: {)

[comment]: <> (      eslint: '^6.6.0',)

[comment]: <> (    },)

[comment]: <> (    peerDependencies: {},)

[comment]: <> (    optionalDependencies: {},)

[comment]: <> (  },)

[comment]: <> (};)

[comment]: <> (depcheck&#40;'/path/to/your/project', options&#41;.then&#40;&#40;unused&#41; => {)

[comment]: <> (  console.log&#40;unused.dependencies&#41;; // an array containing the unused dependencies)

[comment]: <> (  console.log&#40;unused.devDependencies&#41;; // an array containing the unused devDependencies)

[comment]: <> (  console.log&#40;unused.missing&#41;; // a lookup containing the dependencies missing in `package.json` and where they are used)

[comment]: <> (  console.log&#40;unused.using&#41;; // a lookup indicating each dependency is used by which files)

[comment]: <> (  console.log&#40;unused.invalidFiles&#41;; // files that cannot access or parse)

[comment]: <> (  console.log&#40;unused.invalidDirs&#41;; // directories that cannot access)

[comment]: <> (}&#41;;)

[comment]: <> (```)

[comment]: <> (## Example)

[comment]: <> (The following example checks the dependencies under `/path/to/my/project` folder:)

[comment]: <> (```sh)

[comment]: <> ($> depcheck /path/to/my/project)

[comment]: <> (Unused dependencies)

[comment]: <> (* underscore)

[comment]: <> (Unused devDependencies)

[comment]: <> (* jasmine)

[comment]: <> (Missing dependencies)

[comment]: <> (* lodash)

[comment]: <> (```)

[comment]: <> (It figures out:)

[comment]: <> (- The dependency `underscore` is declared in the `package.json` file, but not used by any code.)

[comment]: <> (- The devDependency `jasmine` is declared in the `package.json` file, but not used by any code.)

[comment]: <> (- The dependency `lodash` is used somewhere in the code, but not declared in the `package.json` file.)

[comment]: <> (Please note that, if a subfolder has a `package.json` file, it is considered another project and should be checked with another depcheck command.)

[comment]: <> (The following example checks the same project, however, outputs as a JSON blob. Depcheck's JSON output is in one single line for easy pipe and computation. The [`json`]&#40;https://www.npmjs.com/package/json&#41; command after the pipe is a node.js program to beautify the output.)

[comment]: <> (```js)

[comment]: <> ($> depcheck /path/to/my/project --json | json)

[comment]: <> ({)

[comment]: <> (  "dependencies": [)

[comment]: <> (    "underscore")

[comment]: <> (  ],)

[comment]: <> (  "devDependencies": [)

[comment]: <> (    "jasmine")

[comment]: <> (  ],)

[comment]: <> (  "missing": {)

[comment]: <> (    "lodash": [)

[comment]: <> (      "/path/to/my/project/file.using.lodash.js")

[comment]: <> (    ])

[comment]: <> (  },)

[comment]: <> (  "using": {)

[comment]: <> (    "react": [)

[comment]: <> (      "/path/to/my/project/file.using.react.jsx",)

[comment]: <> (      "/path/to/my/project/another.file.using.react.jsx")

[comment]: <> (    ],)

[comment]: <> (    "lodash": [)

[comment]: <> (      "/path/to/my/project/file.using.lodash.js")

[comment]: <> (    ])

[comment]: <> (  },)

[comment]: <> (  "invalidFiles": {)

[comment]: <> (    "/path/to/my/project/file.having.syntax.error.js": "SyntaxError: <call stack here>")

[comment]: <> (  },)

[comment]: <> (  "invalidDirs": {)

[comment]: <> (    "/path/to/my/project/folder/without/permission": "Error: EACCES, <call stack here>")

[comment]: <> (  })

[comment]: <> (})

[comment]: <> (```)

[comment]: <> (- The `dependencies`, `devDependencies` and `missing` properties have the same meanings in the previous example.)

[comment]: <> (- The `using` property is a lookup indicating each dependency is used by which files.)

[comment]: <> (- The value of `missing` and `using` lookup is an array. It means the dependency may be used by many files.)

[comment]: <> (- The `invalidFiles` property contains the files having syntax error or permission error. The value is the error details. However, only one error is stored in the lookup.)

[comment]: <> (- The `invalidDirs` property contains the directories having permission error. The value is the error details.)

## License

MIT License.


Depcheck is a tool for analyzing the dependencies in a project to see: how each dependency is used, which dependencies are useless, and which dependencies are missing from `package.json`. It is a port of original [depcheck](https://github.com/depcheck/dep

dominionys

@depcheck-rs-node/core

(Experimental) An ambiguous license classifier was found.

What is an ambiguous license classifier?

Ambiguous License Classifier

Source files are encoded using a non-standard text encoding.

What is bad text encoding?

Bad text encoding

Package version is not a valid semantic version (semver).

What is bad semver?

Bad semver

Package has dependencies with an invalid semantic version. This could be a sign of beta, low quality, or unmaintained dependencies.

What is bad dependency semver?

Bad dependency semver

Source files contain bidirectional unicode control characters. This could indicate a Trojan source supply chain attack. See: trojansource.codes for more information.

What are bidirectional unicode control characters?

Bidirectional unicode control characters

This package has multiple bin scripts with the same name.  This can cause non-deterministic behavior when installing or could be a sign of a supply chain attack

What is bin script confusion?

Bin script confusion

Semantic versions published out of chronological order.

What is a chronological version anomaly?

Chronological version anomaly

(Experimental) Copyleft license information was found

What do I need to know about license files?

Copyleft License

Contains a Critical Common Vulnerability and Exposure (CVE).

What is a critical CVE?

Title

Critical CVE

Contains a high severity Common Vulnerability and Exposure (CVE).

What is a CVE?

High CVE

Uses debug, reflection and dynamic code execution features.

What is debug access?

Debug access

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

What is a deprecated package?

Deprecated

(Experimental) Contains a known deprecated SPDX license exception.

What is a deprecated SPDX exception?

Deprecated SPDX exception

(Experimental) License is deprecated which may have legal implications regarding the package's use.

What is a deprecated license?

Deprecated license

Package name is similar to other popular packages and may not be the package you want.

What is a typosquat?

Possible typosquat attack

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

What is dynamic require?

Dynamic require

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

What is an empty package?

Empty package

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

What is environment variable access?

Environment variable access

(Experimental) Something was found which is explicitly marked as unlicensed

Explicitly Unlicensed Item

Package optionally loads a dependency which is not specified within any of the package.json dependency fields. It may inadvertently be importing dependencies specified by other packages.

What are extraneous dependencies?

Name

Extraneous dependency

Contains a dependency which resolves to a file. This can obfuscate analysis and serves no useful purpose.

What are file dependencies?

File dependency

Accesses the file system, and could potentially read sensitive data.

What is filesystem access?

Filesystem access

Package has a dependency with a floating version range.  This can cause issues if the dependency publishes a new major version.

What are floating dependencies?

Floating dependency

Contains a dependency which resolves to a remote git URL. Dependencies fetched from git URLs are not immutable can be used to inject untrusted code or reduce the likelihood of a reproducible install.

What are git dependencies?

Git dependency

Contains a dependency which resolves to a GitHub URL. Dependencies fetched from GitHub specifiers are not immutable can be used to inject untrusted code or reduce the likelihood of a reproducible install.

What are GitHub dependencies?

GitHub dependency

AI has identified unusual behaviors that may pose a security risk.

What is an AI detected anomaly?

AI detected anomaly

AI has identified this package as malware. This is a strong signal that the package may be malicious.

What is AI detected malware?

AI detected potential malware

AI has determined that this package may contain potential security issues or vulnerabilities.

What are AI detected security risks?

AI detected security risk

Contains native code which could be a vector to obscure malicious code, and generally decrease the likelihood of reproducible or reliable installs.

What's wrong with native code?

Native code

Contains high entropy strings. This could be a sign of encrypted data, leaked secrets or obfuscated code.

What are high entropy strings?

High entropy strings

Contains unicode homoglyphs which can be used in supply chain confusion attacks.

What are unicode homoglyphs?

Unicode homoglyphs

Contains a dependency which resolves to a remote HTTP URL which could be used to inject untrusted code and reduce overall package reliability.

What are http dependencies?

HTTP dependency

Install scripts are run when the package is installed. The majority of malware in npm is hidden in install scripts.

What is an install script?

Install scripts

Package has an invalid manifest file and can cause installation problems if you try to use it.

What is an invalid manifest file?

Invalid manifest file

Source files contain invisible characters. This could indicate source obfuscation or a supply chain attack.

What are invisible characters?

Invisible chars

(Experimental) Package license has recently changed.

What is a license change?

License change

(Experimental) Contains an SPDX license exception.

What is a license exception?

License exception

Contains long string literals, which may be a sign of obfuscated or packed code.

What's wrong with long strings?

Long strings

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

What is a major refactor?

Major refactor

This package is malware. We have asked the package registry to remove it.

What is known malware?

Known malware

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

What is manifest confusion?

Manifest confusion

Contains a medium severity Common Vulnerability and Exposure (CVE).

What is a medium CVE?

Medium CVE

Contains a low severity Common Vulnerability and Exposure (CVE).

What is a mild CVE?

Low CVE

This package contains minified code.  This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

What's wrong with minified code?

Minified code

(Experimental) A package's licensing information has fine-grained problems

Nonpermissive License

The package was published by an npm account that no longer exists.

What is a non-existent author?

Non-existent author

A required dependency is not declared in package.json and may prevent the package from working.

What is a missing dependency?

Missing dependency

(Experimental) Package does not have a license and consumption legal status is unknown.

What is a missing license?

Missing license

This package is missing it's tarball.  It could be removed from the npm registry or there may have been an error when publishing.

What is a missing tarball?

Missing package tarball

(Experimental) Package contains multiple licenses.

What is a mixed license?

Mixed license

(Experimental) Package contains a modified version of an SPDX license exception.  Please read carefully before using this code.

What is a modified license exception?

Modified license exception

(Experimental) Package contains a modified version of an SPDX license.  Please read carefully before using this code.

What is a modified license?

Modified license

What is network access?

Network access

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

What is new author?

New author

Package does not specify a list of contributors or an author in package.json.

Why is contributor and author data important?

No contributors or author data

Package does not have a linked bug tracker in package.json.

Why are bug trackers important?

No bug tracker

(Experimental) License information could not be found

No License Found

Package does not have a README. This may indicate a failed publish or a low quality package.

Why are READMEs important?

No README

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Why are missing repositories important?

No repository

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

What does no tests mean?

No tests

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

What is wrong with semver < v1?

No v1

What is a missing website?

No website

(Experimental) Package has a non-FSF-approved license.

What is a non FSF license?

Non FSF license

(Experimental) Package has a non-OSI-approved license.

What is a non OSI license?

Non OSI license

(Experimental) Package contains a non-standard license somewhere. Please read carefully before using.

What is a non SPDX license?

Non SPDX license

(Experimental) A license not known to be considered permissive was found

Non-permissive License

(Experimental) Package contains a legal notice. This could increase your exposure to legal risk when using this project.

@depcheck-rs-node/core

depcheck-rs

Installation

Syntax Support

License

Related posts

Socket Partners with CISA to Champion 'Secure by Design' Standards

Recent Trends in Malicious Packages Targeting Discord