Merge pull request #933 from sasstools/release/1.10

Prepare 1.10

Author: DanPurdy

.eslintrc

@@ -135,8 +135,12 @@ rules:
     - global
   valid-jsdoc:
     - 2
-    - prefer:
-        return: returns
+    -
+      requireParamDescription: true
+      requireReturnDescription: true
+      requireReturn: false
+      prefer:
+        return: "returns"
   wrap-iife: 2
   yoda:
     - 2

.travis.yml

@@ -1,12 +1,8 @@
 language: node_js
 node_js:
-  - '0.10'
-  - '0.12'
   - '4'
   - '5'
   - node
-  - iojs
-before_script: npm link
 after_success: npm run coveralls
 notifications:
   slack:

CHANGELOG.md

@@ -1,5 +1,62 @@
 # Sass Lint Changelog
 
+## v1.10.0
+
+**November 6th, 2016**
+
+The 'you can ignore those bad habits again' update
+
+** :tada: DISABLE LINTERS :tada: **
+The ability to enable and disable linters on the fly has finally(!) been added [#677](https://github.com/sasstools/sass-lint/pull/677) [docs](https://github.com/sasstools/sass-lint/blob/master/docs/toggle-rules-in-src.md)
+
+A massive thank you to everyone who commented/contributed/reported and tested this feature this was very much a community effort here. An extra special thank you to
+* [@donabrams](https://github.com/donabrams)
+
+For his initial hard work in getting this off the ground. There were lots of others who have fixed everything from test issues to AST issues to make this possible afterwards, so thanks to you too!
+
+**New Features**
+* `max-warnings` which is available with the sass-lint CLI is now available as an option in your config file too [#857](https://github.com/sasstools/sass-lint/pull/857)
+* **New Rule** `no-url-domains` rule [#846](https://github.com/sasstools/sass-lint/pull/846) [docs](https://github.com/sasstools/sass-lint/blob/master/docs/rules/no-url-domains.md)
+* **New Rule** `max-line-length` rule was added [#840](https://github.com/sasstools/sass-lint/pull/840) [docs](https://github.com/sasstools/sass-lint/blob/master/docs/rules/max-line-length.md)
+* **New Rule** `max-file-line-count` rule was added [#842](https://github.com/sasstools/sass-lint/pull/842) [docs](https://github.com/sasstools/sass-lint/blob/master/docs/rules/max-file-line-count.md)
+* **New Rule** `declarations-before-nesting` rule was added [#866](https://github.com/sasstools/sass-lint/pull/866) [docs](https://github.com/sasstools/sass-lint/blob/master/docs/rules/declarations-before-nesting.md)
+
+**Fixes**
+* Fixed an issue with an un handled error being thrown in certain circumstances for the `space-before-colon` rule [#894](https://github.com/sasstools/sass-lint/pull/894)
+* Operators in variable names are now handled correctly for the `variable-name-format` rule [#903](https://github.com/sasstools/sass-lint/pull/903)
+* Fixed an issue with string values in the `shorthand-values` rule [#848](https://github.com/sasstools/sass-lint/pull/848)
+* Fixed an issue with valid strict BEM producing an error in the `*-name-format` rules [#892](https://github.com/sasstools/sass-lint/pull/892)
+* Fixed an issue with non-string user conventions in the `border-zero` rule [#913](https://github.com/sasstools/sass-lint/pull/913)
+* Fixed an issue where BOM markers in files were causing parse errors or random errors/warnings [#893](https://github.com/sasstools/sass-lint/pull/893)
+* Fixed an issue with interpolates properties in the `no-duplicate-properties` rule [#915](https://github.com/sasstools/sass-lint/pull/915)
+* Fixed a possible error with invalid user conventions in the `border-zero` rule [#926](https://github.com/sasstools/sass-lint/pull/926)
+
+**Changes**
+* Node 0.10 and 0.12 are no longer officially supported by sass-lint. We've not deliberately broken these builds but we will no longer be testing against them either [#896](https://github.com/sasstools/sass-lint/issues/896) & [#924](https://github.com/sasstools/sass-lint/pull/924)
+* In future the `no-url-protocols` rule will not lint domains in URL's for now a new flag is added to mimic this behaviour. The new `no-url-domains` rule can be used instead [#813](https://github.com/sasstools/sass-lint/issues/813)
+* Front matter such as those present in Jekyll templates will now be ignored in all files before passing to the AST / Linting [897](https://github.com/sasstools/sass-lint/pull/897)
+* Running the tests no longer required sass-lint development to be `npm-link`ed or globally installed. [#911](https://github.com/sasstools/sass-lint/pull/911)
+* The concentric property list in `property-sort-order` was updated to reflect the latest release [#922](https://github.com/sasstools/sass-lint/pull/922)
+
+**Updates**
+* AST fixes have arrived with version 3.4.7 of gonzales-pe [#906](https://github.com/sasstools/sass-lint/pull/906)
+* Updated to the latest versions of many other packages
+
+**Documentation**
+* The documentation around configuring a rule was tidied up and made clearer [#910](https://github.com/sasstools/sass-lint/pull/910)
+
+**Special thanks to**
+
+* [bgriffith](https://github.com/bgriffith)
+* [donabrams](https://github.com/donabrams)
+* [danpurdy](https://github.com/DanPurdy)
+* [danwaz](https://github.com/danwaz)
+* [lucasjahn](https://github.com/lucasjahn)
+* [mrjamesriley](https://github.com/mrjamesriley)
+* [notrobin](https://github.com/nottrobin)
+* [onishiweb](https://github.com/onishiweb)
+* [richarddewit](https://github.com/richarddewit)
+
 ## v1.9.1
 
 **August 25, 2016**

README.md

@@ -79,19 +79,97 @@ For all [rules](https://github.com/sasstools/sass-lint/tree/master/docs/rules),
 
 If you want to configure options, set the rule to an array, where the first item in the array is the severity, and the second item in the array is an object including the options you would like to set.
 
-An example configuration of a rule with options look like the following:
+Here is an example configuration of a rule, where we are specifying that breaking the [indentation rule](https://github.com/sasstools/sass-lint/blob/master/docs/rules/indentation.md) should be treated as an error (its severity set to two), and setting the `size` option of the rule to 2 spaces:  
 
 ```yml
-indentation:
-  - 2
-  -
-    size: 2
+rules:
+  indentation:
+    - 2
+    -
+      size: 2
 ```
 
 ### [Rules Documentation](https://github.com/sasstools/sass-lint/tree/master/docs/rules)
 
 ---
 
+## Disabling Linters via Source
+
+Special comments can be used to disable and enable certain rules throughout your source files in a variety of scenarios. These can be useful when dealing with legacy code or with certain necessary code smells. You can read the documentation for this feature [here](https://github.com/sasstools/sass-lint/tree/master/docs/toggle-rules-in-src.md).
+
+Below are examples of how to use this feature:
+
+
+### Disable a rule for the entire file
+
+```scss
+// sass-lint:disable border-zero
+p {
+  border: none; // No lint reported
+}
+```
+
+### Disable more than 1 rule
+
+```scss
+// sass-lint:disable border-zero, quotes
+p {
+  border: none; // No lint reported
+  content: "hello"; // No lint reported
+}
+```
+
+### Disable a rule for a single line
+
+```scss
+p {
+  border: none; // sass-lint:disable-line border-zero
+}
+```
+
+### Disable all lints within a block (and all contained blocks)
+
+```scss
+p {
+  // sass-lint:disable-block border-zero
+  border: none; // No result reported
+}
+
+a {
+  border: none; // Failing result reported
+}
+```
+
+### Disable and enable again
+
+```scss
+// sass-lint:disable border-zero
+p {
+  border: none; // No result reported
+}
+// sass-lint:enable border-zero
+
+a {
+  border: none; // Failing result reported
+}
+```
+
+### Disable/enable all linters
+
+```scss
+// sass-lint:disable-all
+p {
+  border: none; // No result reported
+}
+// sass-lint:enable-all
+
+a {
+  border: none; // Failing result reported
+}
+```
+
+---
+
 ## CLI
 
 Sass Lint [`v1.1.0`](https://github.com/sasstools/sass-lint/releases/tag/v1.1.0) introduced the ability to run Sass Lint through a command line interface. See the [CLI Docs](https://github.com/sasstools/sass-lint/tree/master/docs/cli) for full documentation on how to use the CLI.
@@ -169,6 +247,24 @@ For further information you can visit our CLI documentation linked below.
 
 ---
 
+## Front matter
+
+Certain static site generators such as [Jekyll](http://jekyllrb.com/docs/frontmatter/) include the YAML front matter block at the top of their scss file. Sass-lint by default checks a file for this block and attempts to parse your Sass without this front matter. You can see an example of a front matter block below.
+
+```scss
+
+---
+# Only the main Sass file needs front matter (the dashes are enough)
+---
+
+.test {
+  color: red;
+}
+
+```
+
+---
+
 ## Contributions
 
 We welcome all contributions to this project but please do read our [contribution guidelines](https://github.com/sasstools/sass-lint/blob/master/CONTRIBUTING.md) first, especially before opening a pull request. It would also be good to read our [code of conduct](https://github.com/sasstools/sass-lint/blob/master/CODE_OF_CONDUCT.md).

appveyor.yml

@@ -5,27 +5,17 @@ init:
 # Test against this version of Node.js
 environment:
   matrix:
-    - nodejs_version: '0.10'
-    - nodejs_version: '0.12'
-      # io.js
-    - nodejs_version: '1'
     - nodejs_version: '4'
     - nodejs_version: '5'
       # Latest stable version of Node
     - nodejs_version: 'stable'
-matrix:
-  # Help instructions and version number don't show in appveyor
-  allow_failures:
-    - nodejs_version: '0.10'
 
 # Install scripts. (runs after repo cloning)
 install:
   # Get the latest stable version of Node.js or io.js
   - ps: Install-Product node $env:nodejs_version
   # install modules
   - npm install
-  # link
-  - npm link
 
 # Post-install test scripts.
 test_script:

bin/sass-lint.js

@@ -6,15 +6,7 @@ var program = require('commander'),
     lint = require('../index');
 
 var configPath,
-    ignores,
-    configOptions = {},
-    exitCode = 0;
-
-var tooManyWarnings = function (detects) {
-  var warningCount = lint.warningCount(detects).count;
-
-  return warningCount > 0 && warningCount > program.maxWarnings;
-};
+    configOptions = {};
 
 var detectPattern = function (pattern) {
   var detects;
@@ -25,13 +17,7 @@ var detectPattern = function (pattern) {
     lint.outputResults(detects, configOptions, configPath);
   }
 
-  if (lint.errorCount(detects).count || tooManyWarnings(detects)) {
-    exitCode = 1;
-  }
-
-  if (program.exit) {
-    lint.failOnError(detects);
-  }
+  lint.failOnError(detects, configOptions, configPath);
 };
 
 program
@@ -47,47 +33,32 @@ program
   .option('--max-warnings [integer]', 'Number of warnings to trigger nonzero exit code')
   .parse(process.argv);
 
+// Create "options" and "files" dictionaries if they don't exist
+configOptions.files = configOptions.files || {};
+configOptions.options = configOptions.options || {};
 
 if (program.config && program.config !== true) {
   configPath = program.config;
 }
 
 if (program.ignore && program.ignore !== true) {
-  ignores = program.ignore.split(', ');
-  if (configOptions.hasOwnProperty('files')) {
-    configOptions.files.ignore = ignores;
-  }
-  else {
-    configOptions.files = {
-      'ignore': ignores
-    };
-  }
+  configOptions.files.ignore = program.ignore.split(', ');
 }
 
 if (program.syntax && ['sass', 'scss'].indexOf(program.syntax) > -1) {
   configOptions.syntax = program.syntax;
 }
 
 if (program.format && program.format !== true) {
-  if (configOptions.hasOwnProperty('options')) {
-    configOptions.options.formatter = program.format;
-  }
-  else {
-    configOptions.options = {
-      'formatter': program.format
-    };
-  }
+  configOptions.options.formatter = program.format;
 }
 
 if (program.output && program.output !== true) {
-  if (configOptions.hasOwnProperty('options')) {
-    configOptions.options['output-file'] = program.output;
-  }
-  else {
-    configOptions.options = {
-      'output-file': program.output
-    };
-  }
+  configOptions.options['output-file'] = program.output;
+}
+
+if (program.maxWarnings && program.maxWarnings !== true) {
+  configOptions.options['max-warnings'] = program.maxWarnings;
 }
 
 if (program.args.length === 0) {
@@ -98,7 +69,3 @@ else {
     detectPattern(path);
   });
 }
-
-process.on('exit', function () {
-  process.exit(exitCode); // eslint-disable-line no-process-exit
-});

docs/options/max-warnings.md

@@ -0,0 +1,29 @@
+# Max warnings
+
+An error will be thrown if the total number of warnings exceeds the `max-warnings` setting.
+
+## Examples
+
+This can be set as a command-line option:
+
+``` bash
+$ sass-lint --max-warnings 50
+```
+
+In `.sass-lint.yml`:
+
+``` yaml
+options:
+  max-warnings: 50
+```
+
+Or inside a script:
+
+``` javascript
+var sassLint = require('sass-lint'),
+    config = {options: {'max-warnings': 50}};
+
+results = sassLint.lintFiles('sass/**/*.scss', config)
+sassLint.failOnError(results, config);
+```
+