https://github.com/imcuttle/detect-dep
Detect the dependiencies of import/require by walking AST
https://github.com/imcuttle/detect-dep
Last synced: about 1 year ago
JSON representation
Detect the dependiencies of import/require by walking AST
- Host: GitHub
- URL: https://github.com/imcuttle/detect-dep
- Owner: imcuttle
- License: mit
- Created: 2018-02-20T06:20:32.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-02-17T09:41:37.000Z (over 3 years ago)
- Last Synced: 2025-03-23T02:33:59.151Z (about 1 year ago)
- Language: TypeScript
- Size: 2.84 MB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: License
Awesome Lists containing this project
README
# detect-dep
[](https://travis-ci.org/imcuttle/detect-dep)
[](https://codecov.io/github/imcuttle/detect-dep?branch=master)
[](https://www.npmjs.com/package/detect-dep)
[](https://www.npmjs.com/package/detect-dep)
[](https://prettier.io/)
[](https://conventionalcommits.org)
> Detect the dependencies by walking AST
**Support detecting dynamic import and `require.context`**
## Installation
```bash
npm install detect-dep
# or use yarn
yarn add detect-dep
```
## Usage
### Package
```javascript
import { detectDep } from 'detect-dep'
const dependencies = detectDep('some code' /* opts */)
```
### Cli
```bash
npm i detect-dep -g
detect-dep --help
detect-dep --version
```
## API
### AST
[lib/index.js:101-103](https://github.com/imcuttle/detect-dep/blob/678fe76f32eeb929ea94366371bdf64bb1c0403e/lib/index.js#L53-L59 'Source code on GitHub')
- **See: [Abstract syntax tree](https://en.wikipedia.org/wiki/Abstract_syntax_tree)
**
- **See: [babylon](https://github.com/babel/babel/tree/master/packages/babylon)
**
Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
### detectDep
[lib/index.js:101-103](https://github.com/imcuttle/detect-dep/blob/678fe76f32eeb929ea94366371bdf64bb1c0403e/lib/index.js#L101-L103 'Source code on GitHub')
#### Parameters
- `source` {String|AST}
- `options` {Object}
- `options.esModule` {Boolean}
Disable `esExport` `esImport` `dynamicImport` when is falsy (optional, default `true`)
- `options.requireEnsure` {Boolean}
whether detecting `require.ensure(['./a', 'b'])` or not (optional, default `true`)
- `options.requireContext` {Boolean}
whether detecting `require.context('./root', false, /\.jsx?$/)` or not (optional, default `true`)
- `options.dynamicImport` {Boolean}
whether detecting `import('./foo')` `import('./foo/' + name)` or not (optional, default `true`)
- `options.esExport` {Boolean}
whether detecting `export xx from 'xxx'` or not (optional, default `true`)
- `options.esImport` {Boolean}
whether detecting `import ...` or not (optional, default `true`)
- `options.requireImport` {Boolean}
whether detecting `require('...')` or not (optional, default `true`)
- `options.localImport` {Boolean}
whether requiring `require('./local/path')` or not (optional, default `true`)
- `options.moduleImport` {Boolean}
whether requiring `require('path')` or not (optional, default `true`)
- `options.extensions` {string\[]}
Which file with matching extension should be detected recursively (optional, default `['.js','.jsx']`)
- `options.resolveExtensions` {string\[]}
The resolved path's extensions which are allowed (would be extends options.extensions) (optional, default `Object.keys(require.extensions)`)
- `options.from` {String}
where is the source come from (filename) (optional, default `''`)
- `options.recursive` {boolean}
Detecting the source recursively. (optional, default `true`)
- `options.resolver` {(source, options) => string\[]}
The core method for resolving dependencies. (optional, default `require('./resolver')`)
- `options.returnAbsolutePath` {boolean}
whether returning the local module's absolute path, or use real module id instead. (optional, default `true`)
#### Examples
```javascript
const { detectDep } = require('detect-dep')
const dependencies = detectDep('some code', {})
```
Returns **any** dependencies {String\[]} - dependencies list
### Module
[lib/index.js:204-222](https://github.com/imcuttle/detect-dep/blob/678fe76f32eeb929ea94366371bdf64bb1c0403e/lib/index.js#L178-L184 'Source code on GitHub')
Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
### tree
[lib/index.js:204-222](https://github.com/imcuttle/detect-dep/blob/678fe76f32eeb929ea94366371bdf64bb1c0403e/lib/index.js#L204-L222 'Source code on GitHub')
#### Parameters
- `path` {string}
- `options` See `detectDep` (optional, default `{}`)
#### Examples
```javascript
const {tree} = require('detect-dep')
const moduleTree = tree('/path/to/file')
{
id: '/path/to/file',
children: [
{
id: '/path/to/file/b.jsx',
children: []
}
]
}
```
Returns **[Module](#module)**
## Contributing
- Fork it!
- Create your new branch:
`git checkout -b feature-new` or `git checkout -b fix-which-bug`
- Start your magic work now
- Make sure npm test passes
- Commit your changes:
`git commit -am 'feat: some description (close #123)'` or `git commit -am 'fix: some description (fix #123)'`
- Push to the branch: `git push`
- Submit a pull request :)
## Authors
This library is written and maintained by imcuttle, moyuyc95@gmail.com.
## License
MIT - [imcuttle](https://github.com/imcuttle) 🐟