detective-cjs
Advanced tools
Package description
The detective-cjs package is a tool designed for analyzing JavaScript files to extract their CommonJS (require) dependencies. It parses the source code of a JavaScript file and identifies the modules that the file depends on by looking for 'require' statements. This can be particularly useful for tasks such as bundling, dependency analysis, and refactoring.
Extracting dependencies from a file
This feature allows you to pass JavaScript source code as a string to the detective function, which returns an array of strings representing the dependencies found in the source code. It's useful for identifying which modules a particular file is dependent on.
const detective = require('detective-cjs');
const src = `const foo = require('foo');
const bar = require('./bar.js');`;
const dependencies = detective(src);
console.log(dependencies); // ['foo', './bar.js']Detective is a more general version of detective-cjs, capable of handling various module systems including ES6 imports, AMD, and CommonJS. While detective-cjs focuses specifically on CommonJS (require) dependencies, detective provides a broader analysis toolset for different module types.
Madge is a tool built on top of detective and other similar modules, designed for creating graphs of module dependencies and finding circular dependencies within a project. It supports ES6, AMD, and CommonJS. Compared to detective-cjs, Madge offers a higher-level analysis including visualization and more complex dependency analysis features.
Precinct is a tool that abstracts over detective, detective-amd, and detective-es6, among others, to provide a unified interface for extracting dependencies from files regardless of the module definition style. It's more versatile than detective-cjs as it can handle multiple module formats without needing to specify which detective to use.
Readme
Get the dependencies of a CommonJS module by traversing its AST
npm install detective-cjs
But dude, substack already built this: node-detective. Yes, but I needed the capability to reuse an AST and this was unlikely to be merged timely. I can also support jsx and other syntactic constructs faster.
const fs = require('fs');
const detective = require('detective-cjs');
const mySourceCode = fs.readFileSync('myfile.js', 'utf8');
// Pass in a file's content or an AST
const dependencies = detective(mySourceCode);
FAQs
Get the dependencies of a CommonJS module by traversing its AST
We found that detective-cjs demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 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
In an unprecedented surge, May 2024 saw the publication of over 5,000 CVEs, marking a historic milestone in cybersecurity with an average of 164 CVEs per day, nearly double the 2023 daily average.
Security News
The White House is addressing fragmented cybersecurity regulations as CISOs report spending up to 50% of their time on compliance, aiming to harmonize requirements and improve cybersecurity outcomes.
Security News
Research
The Socket Research Team has identified a malicious Python package that is typosquatting the popular crytic-compile utility, frequently used in popular toolkits and development environments for smart contracts and crypto applications.