detective-stylus

What is detective-stylus?

The detective-stylus npm package is designed for analyzing Stylus files to find and extract import statements. This can be particularly useful in build tools and bundlers to determine dependencies between stylesheets, allowing for more efficient builds and updates. It parses Stylus syntax to identify `@import` and `@require` statements, enabling developers to programmatically understand dependencies and relationships within their Stylus stylesheets.

What are detective-stylus's main functionalities?

Extract import statements from Stylus files

This feature allows you to pass in a string of Stylus code and returns an array of strings representing the paths of files that are imported or required within that Stylus code. It's particularly useful for build tools that need to track file dependencies.

const detective = require('detective-stylus');
const content = '@import "./mixins.styl"';
const dependencies = detective(content);
console.log(dependencies); // ['./mixins.styl']

Other packages similar to detective-stylus

postcss-import

Similar to detective-stylus, postcss-import is used to process CSS files to find and inline import statements. While detective-stylus is specific to Stylus files, postcss-import works with CSS files and is part of the PostCSS ecosystem, offering a broader range of CSS processing capabilities.

rework-import

rework-import is another CSS preprocessor tool that allows you to manage and inline your CSS imports. It's similar to detective-stylus in its goal of resolving file dependencies but operates within the context of the Rework CSS preprocessor system, making it more suitable for projects that are not specifically using Stylus.

README

detective-stylus

Find the dependencies of a Stylus file

npm install detective-stylus

It's the Stylus counterpart to detective, detective-amd, detective-es6, and detective-sass.

Note: this detective uses a regex to find the @import or @require statements.

Usage

const detective = require('detective-stylus');

const content = fs.readFileSync('styles.styl', 'utf8');

// list of imported file names (ex: '_foo.styl', '_foo', etc)
const dependencies = detective(content);