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.
require()
a directory..js
, .json
, and then .node
, according to File Moduleswalker('/path/to/entry.js', options, function(err, nodes){
// ...
});
Walks down from a entry point, such as package.main
of commonjs or any JavaScript file based on CommonJS, and tries to create a walker.Module
instance of the top level.
Path
the absolute path of the entry point.Object
the hashmap of <path>: <walker.Module>
If the file structure of your project is (actually it is a very extreme scenario):
/path/to
|-- index.js
|-- a
|-- index.json
index.js:
require('./a');
require('b');
a/index.json
{}
Code:
walker('/path/to/index.js', function(err, nodes){
console.log(nodes);
});
Then, the nodes
object will be something like:
{
'/path/to/index.js': {
entry: true,
dependencies: {
'./a': '/path/to/a/index.json',
'b': 'b'
},
code: <Buffer>
},
'/path/to/a/index.json': {
dependencies: {},
code: <Buffer>
},
'b': {
foreign: true
}
}
All options are optional. By default, walker
works in a very strict mode.
Option | Type | Default | Description |
---|---|---|---|
detectCyclic | Boolean | true | whether should check cyclic dependencies |
strictRequire | Boolean | true | whether should check the usage of method require() . If true, the argument of require() must be an literal string. |
allowAbsolutePath | Boolean | true | whether should allow to require an absolute path. |
extensions | Array | ['.js', '.json', '.node'] | see options.extensions section |
type Array
When we require()
a path
, if path
is not found, nodejs will attempt to load the required filename with the added extension of .js
, .json
, and then .node
. Reference via
But for browser-side environment, most usually, we do not support extension .node
which is what options.extensions
is for.
Especially, only tree values below are allowed:
['.js']
['.js', '.json']
,['.js', '.json', '.node']
An usual preset of options for browsers, as
{
detectCyclic: true,
strictRequire: true,
allowAbsolutePath: false,
extensions: ['.js', '.json']
}
Actually, there is no walker.Module
exists. We only use it to declare and describe the structure of the module.
Property | Type | Description |
---|---|---|
entry | Boolean | whether the current module is the entry point |
foreign | Boolean | whether the current module is from a foreign package. |
foreign
is false
Property | Type | Description |
---|---|---|
code | Buffer | the file content of the current module. |
dependencies | Object.<id: path> | id is the argument of require(id) . path is the resolved absolute path by id . If the module has no dependencies, it will be {} |
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.