Get-dependency-tree NPM

Introduction

get-dependency-tree will help you get entry file's dependency tree/arr.

Usage

You can run npm run test or write code in your project yourself like this:

npm i get-dependency-tree

const { tree, arr } = require('get-dependency-tree')({
    entry: require('path').join(__dirname, 'index.vue'),
});

console.log(JSON.stringify(tree, null, '\t'));
console.log(arr);

logs:

{
    "xxx/index.vue": {
        "xxx/vue-dep.js": {},
        "xxx/import.css": {
            "xxx/test.css": {
                "xxx/import.css": {}
            }
        }
    }
}


[ 
    'xxx/vue-dep.js',
    'xxx/import.css',
    'xxx/test.css' 
]

Params

require('get-dependency-tree')({
    // ...
});

entry: String | Required
- default: ''
- description
  It should be an absolute path
  entry file with extentions below is supported by default: .js / .vue / .css / .less / .sass / .scss.
searchRoot: String | Not Required
- default: current entry folder path
- description
  It should be an absolute path.
  It's the final root folder when finding dependencies.
setFileCompiler: Object | Not Required
- default
  The file with extentions as left key is compiled by compilers as right value.
  5 compilers are supported for now: js / vue / less / sass / css.
  compilers as below:
  - js compiler will be used through babel plugins and babel presets
  - vue compiler will be used through vue-template-compiler and babel
    Attention: You need install "vue-template-compiler"
  - less/sass/css compiler will be used through inside tool
  default compilers used by files with extname as below:
```
{
    '.js': 'js', // file with extname `.js` will be compiled by compiler `js`
    '.vue': 'vue', // file with extname `.vue` will be compiled by compiler `vue`
    '.less': 'less', // file with extname `.less` will be compiled by compiler `less`
    '.scss': 'sass', // file with extname `.scss` will be compiled by compiler `sass`
    '.sass': 'sass', // file with extname `.sass` will be compiled by compiler `sass`
    '.css': 'css', // file with extname `.css` will be compiled by compiler `css`
}
```
- description
  You can set which compiler(js / vue / less / sass / css) should compile the file with a extention.
  For example:
  When you set setFileCompiler as { '.we': 'vue' }, get-dependency-tree will compile file with .we extention by compiler vue.
autoCompleteExtentions: Array | Not Required
- default: ['.js', '.vue', '.less', '.scss', '.sass', '.css']
- description
  It's like webpack project: require('a') --> require('a.js').
babelConfig: Object | Not Required
- default
  The default config is as below:
```
babelConfig: {
    plugins: [],
    presets: []
}
```
- description
  When you config babelConfig.plugins or babelConfig.presets, your config will override the default plugins or presets.
  If you want to analyze react project, you can config it like this:
```
babelConfig: {
    plugins: ['@babel/plugin-proposal-class-properties', '@babel/plugin-transform-react-jsx'],
    presets: ['@babel/preset-env']
},
```
alias: Object | Not Required
- default: null
- description
  It's like webpack config: resolve.alias
  For example:
```
alias: { '@test': 'haha' }
```
  require('@test/a') --> require('haha/a') --> get dep: 'haha/a'

filterOut: Function | Not Required

default

function filterOut({ depFilePath, isNodeModules, exists }) {
    if (isNodeModules) {
        // This dependency is in node_modules
        // This dependency will not be in the result
        return true;
    }

    if (!exists) {
        // This dependency does not exist
        // This dependency will not be in the result
        return true;
    }

    // This dependency will be in the result
    return false;
}

description
It is a result filter.
The dependency will be in the result when it returns true.

onEveryDepFound: Function | Not Required
- default
```
(absoluteFilePath) => {}
```
- description
  It will callback while every dependency is found.
onFilteredInDepFound: Function | Not Required
- default
```
(absoluteFilePath) => {}
```
- description
  It will callback while filtered in dependency is found (These dependencies are in the result).
onFilteredOutDepFound: Function | Not Required
- default
```
(absoluteFilePath) => {}
```
- description
  It will callback while filtered out dependency is found (These dependencies are not in the result).