detective
Advanced tools
Package description
The 'detective' npm package is a module dependency analysis tool that helps developers to find out which modules are required in a given JavaScript file. It parses the file, extracts the 'require' statements, and returns a list of dependencies. This is particularly useful for tasks like bundling, minification, and understanding code dependencies.
Detect CommonJS dependencies
This feature allows you to extract all CommonJS dependencies (i.e., modules loaded via 'require') from a JavaScript file. The code reads a JavaScript file, uses detective to parse the file and logs the list of dependencies.
const detective = require('detective');
const fs = require('fs');
const content = fs.readFileSync('/path/to/js/file.js', 'utf8');
const dependencies = detective(content);
console.log(dependencies);Detect ES6 module dependencies
Using 'detective-es6', a variant of detective tailored for ES6 modules, this feature parses files containing ES6 import statements to determine dependencies. The process involves reading the file, parsing it with detective-es6, and logging the dependencies.
const detective = require('detective-es6');
const fs = require('fs');
const content = fs.readFileSync('/path/to/es6/file.js', 'utf8');
const dependencies = detective(content);
console.log(dependencies);Precinct is a tool similar to detective but with broader capabilities. It supports detecting dependencies from multiple module types including CommonJS, AMD, ES6, and TypeScript. Compared to detective, which requires different variants for different module systems, Precinct provides a more unified and versatile approach.
Madge is a more comprehensive tool that builds on the functionality provided by detective. It not only finds dependencies but also creates visual graphs of module dependencies and can detect circular dependencies. This makes Madge suitable for larger projects where understanding the module structure visually can be particularly beneficial.
Readme
find all calls to require() by walking the AST
strings_src.js:
var a = require('a');
var b = require('b');
var c = require('c');
strings.js:
var detective = require('detective');
var fs = require('fs');
var src = fs.readFileSync(__dirname + '/strings_src.js');
var requires = detective(src);
console.dir(requires);
output:
$ node examples/strings.js
[ 'a', 'b', 'c' ]
var detective = require('detective');
Give some source body src, return an array of all the require() calls with
string arguments.
The options parameter opts is passed along to detective.find().
Give some source body src, return found with:
found.strings - an array of each string found in a require()found.expressions - an array of each stringified expression found in a
require() callfound.nodes (when opts.nodes === true) - an array of AST nodes for each
argument found in a require() callOptionally:
opts.word - specify a different function name instead of "require"opts.nodes - when true, populate found.nodesopts.isRequire(node) - a function returning whether an AST CallExpression
node is a require callopts.parse - supply options directly to
acorn with some support for esprima-style
options range and locWith npm do:
npm install detective
MIT
FAQs
find all require() calls by walking the AST
We found that detective demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 40 open source maintainers 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
Researchers recently demonstrated that the npm Registry is vulnerable to cache poisoning combined with DoS, posing significant risks for package availability.
Security News
The June TC39 meeting wrapped up this week with eight proposals moving on to the next stage. Here's a quick roundup of the features that the committee approved to advance.
Security News
Cyber extortion in the US and Canada hit record levels in 2023, with ransomware attacks surging and median ransom demands skyrocketing, though fewer companies are choosing to pay ransoms.