https://github.com/jpb06/extract-dependencies-from-sources

Extracts external dependencies used in a typescript codebase
https://github.com/jpb06/extract-dependencies-from-sources

code-analysis dependencies-collector effect-ts

Last synced: about 1 year ago
JSON representation

Extracts external dependencies used in a typescript codebase

• Host: GitHub
• URL: https://github.com/jpb06/extract-dependencies-from-sources
• Owner: jpb06
• License: mit
• Created: 2023-04-17T09:01:02.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2025-04-30T13:02:10.000Z (about 1 year ago)
• Last Synced: 2025-04-30T14:28:30.019Z (about 1 year ago)
• Topics: code-analysis, dependencies-collector, effect-ts
• Language: TypeScript
• Homepage:
• Size: 528 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# extract-dependencies-from-sources

[![Open in Visual Studio Code](https://img.shields.io/static/v1?logo=visualstudiocode&label=&message=Open%20in%20Visual%20Studio%20Code&labelColor=2c2c32&color=007acc&logoColor=007acc)](https://github.dev/jpb06/extract-dependencies-from-sources)

![npm bundle size](https://img.shields.io/bundlephobia/min/extract-dependencies-from-sources)

![Github workflow](https://img.shields.io/github/actions/workflow/status/jpb06/extract-dependencies-from-sources/tests-scan.yml?branch=main&logo=github-actions&label=last%20workflow)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=jpb06_extract-dependencies-from-sources&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=jpb06_extract-dependencies-from-sources)

[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=jpb06_extract-dependencies-from-sources&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=jpb06_extract-dependencies-from-sources)

[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=jpb06_extract-dependencies-from-sources&metric=security_rating)](https://sonarcloud.io/dashboard?id=jpb06_extract-dependencies-from-sources)

[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=jpb06_extract-dependencies-from-sources&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=jpb06_extract-dependencies-from-sources)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=jpb06_extract-dependencies-from-sources&metric=coverage)](https://sonarcloud.io/dashboard?id=jpb06_extract-dependencies-from-sources)

[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=jpb06_extract-dependencies-from-sources&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=jpb06_extract-dependencies-from-sources)

[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=jpb06_extract-dependencies-from-sources&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=jpb06_extract-dependencies-from-sources)

[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=jpb06_extract-dependencies-from-sources&metric=code_smells)](https://sonarcloud.io/dashboard?id=jpb06_extract-dependencies-from-sources)

[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=jpb06_extract-dependencies-from-sources&metric=bugs)](https://sonarcloud.io/summary/new_code?id=jpb06_extract-dependencies-from-sources)

[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=jpb06_extract-dependencies-from-sources&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=jpb06_extract-dependencies-from-sources)

[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=jpb06_extract-dependencies-from-sources&metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=jpb06_extract-dependencies-from-sources)

![Last commit](https://img.shields.io/github/last-commit/jpb06/extract-dependencies-from-sources?logo=git)

Inferring dependencies from the source code of a monorepo app

        


## ⚡ Quickstart

### 🔶 Install

```bash

yarn add -D extract-dependencies-from-sources

```

```bash

pnpm i -D extract-dependencies-from-sources

```

### 🔶 Usage

#### 🧿 cjs

```bash

extractDeps --packagejson ./package.json --path codebasePath

Options:

  --help          Show help                                            [boolean]

  --version       Show version number                                  [boolean]

  --packagejson   Root package.json path  [required] [default: "./package.json"]

  --path          Codebase path                                       [required]

  --externaldeps  Path to external dependencies file (optional)

Examples:

  extractDeps --packagejson ./package.json --path ./apps/back --path

  ./libs/back

Inferring dependencies from the source code of a monorepo app

```

For example, running the following command will replace the `dependencies` property of the root `package.json` with the dependencies found in the codebases located in `apps/back` and `libs/back/database`.

```bash

yarn extractDeps --path apps/back --path libs/back/database

```

#### 🧿 esm

```bash

extractDepsEsm --packagejson ./package.json --path codebasePath

Options:

  --help          Show help                                            [boolean]

  --version       Show version number                                  [boolean]

  --packagejson   Root package.json path  [required] [default: "./package.json"]

  --path          Codebase path                                       [required]

  --externaldeps  Path to external dependencies file (optional)

Examples:

  extractDeps --packagejson ./package.json --path ./apps/back --path

  ./libs/back

Inferring dependencies from the source code of a monorepo app

```

#### 🧿 node

You can also use the function directly in your code:

```ts

import { getCodebasesDependencies } from 'extract-dependencies-from-sources';

import { readJson } from 'fs-extra';

const data = await readJson('./package.json');

const deps = await getCodebasesDependencies(data.dependencies, [

  'apps/front/auth',

  'lib/front/components',

]);

```

### 🔶 Including external dependencies

You can also specify external dependencies to include in the output by providing a path to a yaml file containing a map of dependencies:

> external-deps.yml

```yaml

externaldeps:

  - msw: ^1.1.0

  - eslint: ~8.36.0

```

You can then use the `--externaldeps` option to include them:

```bash

yarn extractDeps --path apps/front --externaldeps ./external-deps.yml

```