sass-graph
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/sass-graph package

    3.0.5 • Public • Published

    Sass Graph

    Parses Sass files in a directory and exposes a graph of dependencies

    Build Status Coverage Status npm version Dependency Status devDependency Status

    Install

    Install with npm

    npm install --save-dev sass-graph
    

    Usage

    Usage as a Node library:

    var sassGraph = require('./sass-graph');

    Usage as a command line tool:

    The command line tool will parse a graph and then either display ancestors, descendents or both.

    $ ./bin/sassgraph --help
    Usage: bin/sassgraph <command> [options] <dir> [file]
    
    Commands:
      ancestors    Output the ancestors
      descendents  Output the descendents
    
    Options:
      -I, --load-path   Add directories to the sass load path
      -e, --extensions  File extensions to include in the graph
      -j, --json        Output the index in json
      -h, --help        Show help
      -v, --version     Show version number
    
    Examples:
      ./bin/sassgraph descendents test/fixtures test/fixtures/a.scss
      /path/to/test/fixtures/b.scss
      /path/to/test/fixtures/_c.scss
    

    API

    parseDir

    Parses a directory and builds a dependency graph of all requested file extensions.

    parseFile

    Parses a file and builds its dependency graph.

    Options

    loadPaths

    Type: Array Default: [process.cwd]

    Directories to use when resolved @import directives.

    extensions

    Type: Array Default: ['scss', 'sass']

    File types to be parsed.

    follow

    Type: Boolean Default: false

    Follow symbolic links.

    exclude

    Type: RegExp Default: undefined

    Exclude files matching regular expression.

    Example

    var sassGraph = require('./sass-graph');
    console.log(sassGraph.parseDir('test/fixtures'));
     
    //{ index: {,
    //    '/path/to/test/fixtures/a.scss': {
    //        imports: ['b.scss'],
    //        importedBy: [],
    //    },
    //    '/path/to/test/fixtures/b.scss': {
    //        imports: ['_c.scss'],
    //        importedBy: ['a.scss'],
    //    },
    //    '/path/to/test/fixtures/_c.scss': {
    //        imports: [],
    //        importedBy: ['b/scss'],
    //    },
    //}}

    Running Mocha tests

    You can run the tests by executing the following commands:

    npm install
    npm test
    

    Authors

    Sass graph was originally written by Lachlan Donald. It is now maintained by Michael Mifsud.

    License

    MIT

    Keywords

    Install

    npm i sass-graph

    DownloadsWeekly Downloads

    1,809,747

    Version

    3.0.5

    License

    MIT

    Unpacked Size

    17.8 kB

    Total Files

    7

    Last publish

    Collaborators

    • avatar
    • avatar