Keep your project clean. Sassy Clean scans a project for partials that are never imported. Sassy Clean provides the option to automatically delete the unused partials or display the file name as a console log.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
tasks
.gitignore
.travis.yml
Gruntfile.js
README.md
package.json
sassyclean.png

README.md

Grunt SassyClean

npm version npm Build Status

SassyClean logo

Grunt SassyClean scans a project for partials that are never imported. SassyClean provides the option to automatically delete the unused partials or display the file name as a console log.

Getting Started

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, install this plugin with this command:

npm install grunt-sassyclean --save-dev

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

grunt.loadNpmTasks('grunt-sassyclean');

Tip: the load-grunt-tasks module makes it easier to load multiple grunt tasks.

Documentation

See the Gruntfile in this repo for a full example.

Example config

grunt.initConfig({
  sassyclean: {
    options: {
      modules: ['sass/modules/**/*.scss', 'sass/themes/**/*.scss', 'sass/layout/**/*.scss', 'sass/base/**/*.scss'],
      buildfiles: ['sass/**/*.scss'],
      remove: false,
      days: null
    },
  }
});

grunt.loadNpmTasks('grunt-sassyclean');
grunt.registerTask('default', ['sassyclean']);

Options

buildfiles

Type: String Default value: sass/

A reference to the directory of files that are being checked if any of the module files are referenced in the root sass files.

modules

Type: String|Array Default value: ['**/*.scss']

The modules option provides the ability to set an array of directories that contain Sass modules.

remove

Type: Boolean Default value: false

The ablity to automatically delete unused file reference from the project.

days

Type: Number Default value: false

If remove is set to true and days has a value, files will only be deleted if the file hasn't been modified greater than the length of days.

Release History

  • 0.1.8: Update peerDependencies to support Grunt 1.0
  • 0.1.7: Add Travis CI.
  • 0.1.6: Readme updates.
  • 0.1.5: Update dev dependencies.
  • 0.1.4: Add Grunt JSHint.
  • 0.1.3: Clean up documentation.
  • 0.1.2: fix issue #1 better explain Grunt task.
  • 0.1.1: Adding moment as a dependency.
  • 0.1.0: Initial release.

Related

Contributing

  1. Fork it
  2. Run npm install
  3. Run Grunt watch grunt watch
  4. Create your feature branch (git checkout -b my-new-feature)
  5. Commit your changes (git commit -am "Add some feature")
  6. Push to the branch (git push origin my-new-feature)
  7. Create new Pull Request

License

MIT © Ryan Burgess