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

broccoli-sass-lint

v1.1.2

Published

Pure Node.js scss/sass linting for Broccoli-based projects

Downloads

2,348

Readme

Broccoli Sass Lint Build Status npm

This is a pure Node.js scss/sass linter for Broccoli-based applications and plugins.

Installation

npm install --save-dev broccoli-sass-lint

Usage

var SassLinter = require('broccoli-sass-lint');

var node = new SassLinter('app/styles'); // Or wherever the files are

Configuration

Linting configuration can be added in a sass-lint.yml file as expected and documented by Sass Lint. For example:

rules:
  extends-before-mixins: 2 # throws error
  placeholders-in-extend: 1 # log warning
  extends-before-declarations: 0 # no errors or warnings

Here is a sample config file.

Options

Options can be passed as a second argument to SassLinter().

The defaults are shown below;

var SassLinter = require('broccoli-sass-lint');

var node = new SassLinter('app/styles', {
  configPath: '.sass-lint.yml',
  shouldThrowExceptions: true,
  shouldLog: true,
});

configPath

| Type | String | |---------|-----------------| | Default | '.sass-lint.yml' |

A name of the file your config is contained in. This should be a .yml file, preferrably in the root of the Broccoli project.

shouldThrowExceptions

| Type | Boolean | |---------|---------| | Default | true |

By default, sass-lint throws exceptions when an error is encountered (note, warnings do not throw errors). Usually this is the preffered functionality.

However, you can stop errors being thrown and, therefore, errors stopping the build process by setting shouldThrowExceptions: false. Use with caution!

shouldLog

| Type | Boolean | |---------|---------| | Default | true |

Whether to log warnings and errors to the console. When this is set to false you will not be notified or linting errors!

logError()

| Type | Function | |---------|-------------------| | Param | fileLint (Object) |

You may override this plugin's default logError() function should you need to intercept file lint objects (e.g. when testing this plugin).

var SassLinter = require('broccoli-sass-lint', {
  logError: function(fileLint) {
    assert.equal(fileLint.errors.length, 0,
      'Should have no errors detected');
  }
});

fileLint is passed in the format returned by sass-lint's lintText() method

When you override logError() this plugin won't log any warnings or errors.

testGenerator()

| Type | Function | |------------|---------------------------------------------| | function | fileLint (relativePath, errors, errorCount) |

The function used to generate test modules. You can provide a custom function for your client side testing framework of choice.

The function receives the following arguments:

  • relativePath - The relative path to the file being tested.
  • errors - A generated string of errors found.
  • errorCount - An integer of the number of errors found per file.

Default generates QUnit style tests:

var path = require('path');

function(relativePath, errors) {
  if (errors) {
    errors = this.escapeErrorString('\n' + errors);
  }

  return "module('Sass Lint - " + path.dirname(relativePath) + "');\n" +
         "test('" + relativePath + " should pass sass-lint', function() {\n" +
         "  assert.ok(" + !errors + ", '" + relativePath + " should pass sass-lint." + errors + "');\n" +
         "});\n";
};

Example of using errorCount with mocha and chai with errorCount:

"describe('Sass Lint - " + path.dirname(relativePath) + "', function() { \n" +
" it('" + relativePath + " should pass sass-lint', function() {\n" +
"   expect(" + errorCount + ").to.eq(0);\n" +
" });\n" +
"});\n";

Development

All tests are currently contained in tests/test.js. Tests can be ran with:

npm test

PRs are welcomed and should be issued to the master branch.