detective-sass

What is detective-sass?

The detective-sass npm package is designed to analyze SASS (.scss) files to find and extract import statements. This can be particularly useful in build tools and bundlers where understanding dependencies between stylesheets is necessary for tasks like concatenation, minification, or modular builds. It parses the content of SASS files and returns an array of strings representing the paths of files that are imported.

What are detective-sass's main functionalities?

Extract import paths from a SASS file

This feature allows you to pass in the content of a SASS file as a string to the detective function, which then returns an array of the import paths found within that file. This is useful for tracking dependencies in SASS projects.

const detective = require('detective-sass');
const content = `$importedVar: #123;
@import 'another-file';
body { color: $importedVar; }`;
const imports = detective(content);
console.log(imports); // ['another-file']

Other packages similar to detective-sass

postcss-import

Similar to detective-sass, postcss-import is used to process import statements in CSS files. While detective-sass focuses on SASS files, postcss-import is more versatile, working with CSS files and supporting features like glob, path resolving, and inline imports. It's part of the PostCSS ecosystem, which allows for a wide range of plugins to further process the CSS.

node-sass-glob-importer

This package provides a custom importer for node-sass, enabling glob-based imports in SASS files. While detective-sass extracts import paths for analysis or bundling, node-sass-glob-importer enhances the import capabilities of SASS itself, allowing for more flexible and powerful stylesheet organization.

README

detective-sass

Find the dependencies of a sass file

npm install detective-sass

Note: This is specific to the .sass style syntax of the Sass preprocessor. For SCSS support, please see node-detective-scss.

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

• The AST is generated using the gonzales-pe parser.

Usage

const fs = require('fs');
const detective = require('detective-sass');

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

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

// or to also detect any url() references to images, fonts, etc.
const allDependencies = detective(content, { url: true });

Options

• url (optional): (Boolean) also detect any url() references to images, fonts, etc.

Related

• node-sass-lookup if you want to map a sass/scss dependency to a file on your filesystem.
• node-precinct if you want to also support finding dependencies for JavaScript and other languages.

License

MIT