Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
commonjs-walker
Advanced tools
Analyzes and walks down the dependencies from a commonjs entry and creates a walking tree.
var walker = require('commonjs-walker');
NOTICE that it will not walk down node_modules
and any foreign packages.
walker('/path/to/entry.js', options, function(err, tree, nodes){
// ...
});
If the file structure of your project is:
/path/to
|--- index.js
|--- a.js
index.js:
require('./a');
a.js:
// there's nothing.
Code:
walker('/path/to/index.js', function(err, tree, nodes){
console.log(tree);
console.log(nodes);
})
Then, the tree
object will be something like:
{
id: '/path/to/index.js',
dependents: [],
isEntryPoint: true,
unresolvedDependencies: ['./a'],
dependencies: [
{
id: '/path/to/a.js',
dependents: [
tree // points to `index.js`
],
dependencies: [],
unresolvedDependencies: [],
code: <Buffer>
}
],
code: <Buffer>
}
The nodes
object is the path->node
hashmap.
{
'/path/to/index.js': tree,
'/path/to/a.js': tree.dependencies[0]
}
Walks down from a entry point, such as package.main
of commonjs, and tries to create a walker.Module
instance of the top level.
Path
the absolute path of the entry point.walker.Module
tree of walker.Module
Object
the hashmap of <path>: <walker.Module>
All options are optional. By default, walker
works in a very strict mode.
Option | Type | Default | Description |
---|---|---|---|
detectCircular | Boolean | true | whether should check circular dependencies |
strictRequire | Boolean | true | whether should check the usage of method require() |
Actually, there is no walker.Module
exists. We only use it to declare and describe the structure of the module.
Property | Type | Description |
---|---|---|
id | String | the id of the module |
isEntryPoint | Boolean | whether the current module is the entry point |
dependents | Array.<walker.module> | the dependent modules. If there's no dependents, it will be [] |
isForeign | Boolean | whether the current module is from a foreign package. |
** Properties only if isForeign
is false: **
Property | Type | Description |
---|---|---|
code | Buffer | the file content of the current module. |
dependencies | Array.<walker.Module> | the dependencies of the current module. If the module has no dependencies, it will be [] |
unresolvedDependencies | Array.<String> | the array contains the items require() d by the module. |
String
the enum type of the errorString
error messagesString
the origin error.stackObject
the object of the major information of the error, this is useful for i18n.FAQs
Analyzer and tree walker for commonjs.
The npm package commonjs-walker receives a total of 8 weekly downloads. As such, commonjs-walker popularity was classified as not popular.
We found that commonjs-walker demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.