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

grunt-sass-compile-imports

v0.2.2

Published

Create an import file by scanning a directory for SASS files

Downloads

308

Readme

grunt-sass-compile-imports

Create an import file by scanning a directory for SASS files

Getting Started

This plugin requires Grunt ~0.4.0

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-sass-compile-imports --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-sass-compile-imports');

The "sass_compile_imports" task

Overview

In your project's Gruntfile, add a section named sass_compile_imports to the data object passed into grunt.initConfig().

grunt.initConfig({
  sass_compile_imports: {
    compile: {
      target: 'sass/_partials.scss',
      files: [{
          expand: true,
          cwd   : 'sass/partials/',
          src   : ['**/*.scss']
      }]
    }
  }
});

This will generate a file called _partials.scss in a directory named sass. The contents of the file will be similar to the following:

// This file imports all other named scss files.
// It is automatically generated by the grunt sassimports task.
// Do not directly modify this file.

@import "path/to/partial/variables";
@import "path/to/partial/fonts";

Options

options.removeExtension

Type: Boolean Default value: true

Flag specifying if the generated paths should exclude the .scss extension.

grunt.initConfig({
  sass_compile_imports: {
    keep_extension: {
      options: {
          removeExtension: false
      },
      target: 'sass/_partials.scss',
      files: [{
          expand: true,
          cwd   : 'sass/partials/',
          src   : ['**/*.scss']
      }]
    }
  }
});

This will generate the imports in the following way:

// This file imports all other named scss files.
// It is automatically generated by the grunt sassimports task.
// Do not directly modify this file.

@import "path/to/partial/variables.scss";
@import "path/to/partial/fonts.scss";

options.quiet

Type: Boolean Default value: false

A flag used to specify if the task should output information about the files it is importing to the command line

grunt.initConfig({
  sass_compile_imports: {
    keep_extension: {
      options: {
          quiet: true
      },
      target: 'sass/_partials.scss',
      files: [{
          expand: true,
          cwd   : 'sass/partials/',
          src   : ['**/*.scss']
      }]
    }
  }
});

options.importPath

Type: String Default value: false

If set the specified path will be used to import the sass files rather than the one automatically created. A trailing slash will be automatically added if one is not present.

grunt.initConfig({
  sass_compile_imports: {
    import_path: {
      options: {
          importPath: '../components'
      },
      target: 'sass/_partials.scss',
      files: [{
          expand: true,
          cwd   : 'components/partials/',
          src   : ['**/*.scss']
      }]
    }
  }
});

This will generate the imports in the following way:

// This file imports all other named scss files.
// It is automatically generated by the grunt sassimports task.
// Do not directly modify this file.

@import "../components/variables";
@import "../components/fonts";

options.replacePath

Type: String Default value: false

If set the import path for each partial will be modified using the pattern provided.

grunt.initConfig({
  sass_compile_imports: {
    replace_path: {
      options: {
          replacePath: {
              pattern: '/location',
              replace: '../_styles'
          }
      },
      target: 'sass/_partials.scss',
      files: [{
          expand: true,
          cwd   : 'components/partials/',
          src   : ['**/*.scss']
      }]
    }
  }
});

options.header

Type: Array Default value: [ '// This file imports all other named scss files.', '// It is automatically generated by the grunt sassimports task.', '// Do not directly modify this file.', '']

Allows the default header to be customised. Each element in the array is output as a line at the top of the generated partials file

grunt.initConfig({
  sass_compile_imports: {
    replace_path: {
      options: {
          header: [
              '// Holy custom header Batman!',
              '']
      },
      target: 'sass/_partials.scss',
      files: [{
          expand: true,
          cwd   : 'components/partials/',
          src   : ['**/*.scss']
      }]
    }
  }
});

This will generate the partial file in the following way:

// Holy custom header Batman!.

@import "path/to/partial/variables";
@import "path/to/partial/fonts";

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Contributors

History

0.2.x - Several options added 0.1.x - Initial version