@dependents-tracker/extractor

The CLI tool collects dependents information for a given repository as follows:

• Collects the dependents of a given repository from the GitHub Dependents Page.
• Collects the import statements from the source code of the dependents repositories.

Finally, it generates a JSON file with the following structure:

{
  "repository_name": {
    "imports": [
      {
        "filename": "/path/to/file",
        "specifiers": ["imported_module", "imported_module2"]
      }
    ],
    "hash": "3d129uasf...", // hash of the HEAD commit
    "branch": "main" // main branch of the repository
  }
  ...
}

One more thing to note is that it can collect javascript projects that use the ESM-style imports, which means that it does not collect the CommonJS-style imports or python projects, etc . It also can't collect the default imports.

// OK
import { foo } from 'bar';

// NOT OK
const foo = require('bar');
import foo from 'bar';

Prerequisites

• git installed on your machine.
• node installed on your machine.
• npm installed on your machine.

Usage

npx @dependents-tracker/extractor <repository_name>

At now, the CLI tool only supports above command. The repository name should be in the format of owner/repo.

After running the command, the CLI tool will generate a JSON file in the current directory with the name dependents.json.

Note: This project is still under development, so there might be some bugs or issues. If you encounter any, please report them.