npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

dependants-parser

v0.0.5

Published

Parse dependants given a module, a root and an import syntax

Downloads

23

Readme

dependants-parser

Build Status

Utility to recursively fetch dependant modules by parsing require syntaxes targeting a specified local module using a given a root directory and an import expression regex.

The problem

While writing a custom watch-build tool I needed some quick and dirty way to figure out which modules depended on the file that changed would be emitted to in order to avoid re-compiling every file in the codebase at every change.

This tool is easily extensible to work with most pre-processors & syntaxes as long as their import command can be expressed with a regular expression and the modules are located relatively to the target file.

By now Stylus and CommonJS regexes are available by default in this module.

Install

npm install dependants-parser

Test

Test with Mocha by running

npm test

Simple usage

Considering the following tree:

.
├── index.js
└── stylus
    ├── root.styl
    └── target.styl

stylus/root.styl:

@import 'target.styl'

index.js:

var dependants = require('dependants-tree');

var out = dependants.findSync(
	'./stylus/target.styl',		// Target dependency
	'./stylus',					// Modules root
	dependants.patterns.stylus	// Import expression regex
	);

console.log(out);
// [ 'abs/path/to/stylus/root.styl' ]

Exports

.findSync([ filepath ], [ root ], [ importRegex ], [ match ])

Returns an array containing absolute paths of all modules that depend on filepath found in root, given an import expression syntax.

  • [ filepath ] - Path to target module. This needs to be the real filename.
  • [ root ] - Directory to recursively scan for dependants.
  • [ importRegex ] - Import syntax expression. Used to parse out a file's dependency.
  • [ match ] - (Optional) Filename match expression. Use to filter files to scan.

.patterns

Contains simple ready-to-use regexes for local import syntaxes

  • stylus - @import 'module` syntax for Stylus
  • commonjs - @import 'module` syntax for CommonJS requires

Contribute

It would be great to provide import syntaxes for other languages / pre-processors (LESS, SASS, SCSS, Jade, Handlebars) this module could be used for.

Please feel free to drop a pull request if you're using this module with a custom expressions or improving the current ones / writing more tests.

Regexes are tested in test/regexes.js.