https://github.com/yowainwright/intrinsic-dependencies
a simple utility ensuring invisible but required node dependencies aren't removed
https://github.com/yowainwright/intrinsic-dependencies
ci dependencies performance security
Last synced: about 1 year ago
JSON representation
a simple utility ensuring invisible but required node dependencies aren't removed
- Host: GitHub
- URL: https://github.com/yowainwright/intrinsic-dependencies
- Owner: yowainwright
- License: mit
- Created: 2024-03-03T08:14:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-10T04:16:56.000Z (about 1 year ago)
- Last Synced: 2025-04-17T11:59:15.257Z (about 1 year ago)
- Topics: ci, dependencies, performance, security
- Language: JavaScript
- Homepage:
- Size: 166 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Intrinsic Dependencies
[](https://badge.fury.io/js/intrinsic-dependencies)
[](https://github.com/yowainwright/intrinsic-dependencies)
#### A utility for ensuring invisible _but required_ dependencies aren\'t removed.
---
#### Scenario
You may be reviewing dependencies for security or performance reasons and see a dependency which appears to be unneeded. You remove the dependency and suddenly your project is broken. This problem can be fatal—for example, if the dependency is required for something specific to production.
The solution is just a few functions. However, it can be difficult to remember to add these functions to your project. And, this issue usually doesn't come up unless you have a big work project.
That's where **Intrinsic Dependencies** comes in. Just add the cli to your npm scripts and you're good to go! Intrinsic Dependencies fails or passes with a log of dependencies that are required. That's it.
---
#### Solution Overview
Add your "intrinsic dependencies" in a object to your `package.json` with notes like so:
```json
{
"intrinsicDependencies": {
"dockerode": "Referenced during production deployment. Production will fail if removed!",
}
}
```
And then add a command to your node scripts to run in your ci (or where ever):
```json
"scripts": {
"prod-check": "intrinsic-dep-check"
}
```
Now, `intrinsic-dep-check` will fail (fail your ci) if a required intrinsic dependency is removed.
---
## Installation
```sh
npm install intrinsic-dependencies -save-dev
```
This should never be a dependency! Just use it as a dev dependency. Or better yet, with npx.
## Usage
As a cli (recommended)
```sh
intrinsic-dep-check
```
As a node function
```js
import { checkIntrinsicDependencies } from 'intrinsic-dependencies';
checkIntrinsicDependencies();
```
See below for more usage details.
---
### Cli
Intrinsic Dependencies can be invoked via a few cli names; clearest is `intrinsic-dep-check`. See the `package.json` bin object for reference.
The cli also accepts 2 options (not required), `--filePath` and `--configPath`. These options can be used to specify a custom path for the `package.json` or an optional json formated `config` file.
```sh
intrinsic-dep-check --filePath /path/to/package.json --configPath /path/to/config.json
```
---
### Node
You can use Intrinsic Dependencies as a node function as well.
```js
import { checkIntrinsicDependencies } from 'intrinsic-dependencies';
checkIntrinsicDependencies();
```
This function also accepts 2 options (not required), `filePath` and `configPath`. These options can be used to specify a custom path for the `package.json` or an optional json formated `config` file.
```js
import { checkIntrinsicDependencies } from 'intrinsic-dependencies';
checkIntrinsicDependencies({ filePath: '/path/to/package.json', configPath: '/path/to/config.json' });
```
---
## Details
This project was intentionally made with "just node"; no Typescript.
This keeps the project pure, small, and as close to "just node" as possible.
For development, esbuild, prettier and eslint are used because no similar functionality is provided by "just node".
---
Made by [@yowainwright](https://github.com/yowainwright) for fun with passion! MIT, 2024.