Merge pull request #37 from suitcss/local-suit-config

Use stylelint-config-suitcss within preprocessor

Author: simonsmith

.stylelintrc

@@ -1,5 +1,8 @@
 ### HEAD
 
+* Use `stylelint-config-suitcss` from within the preprocessor. No longer needs
+  to be installed locally by the consumer.
+
 ### 2.0.0 (April 12, 2016)
 
 * Switch to `postcss-easy-import`

CHANGELOG.md

@@ -102,32 +102,23 @@ Where to resolve imports from. Passed to [`postcss-import`](https://github.com/p
 Ensure code conforms to the [SUIT code style](https://github.com/suitcss/suit/blob/master/doc/STYLE.md)
 by using the [stylelint-config-suitcss](https://github.com/suitcss/stylelint-config-suitcss) package.
 
-Stylelint [configuration options](http://stylelint.io/?/docs/user-guide/configuration.md) can also be overridden:
+Stylelint [configuration
+options](http://stylelint.io/?/docs/user-guide/configuration.md) can also be
+overridden but this requires the `stylelint-config-suitcss` to be installed
+locally in your package.
 
 ```js
 {
   lint: true,
   stylelint: {
-  extends: 'stylelint-config-suitcss',
+    extends: 'stylelint-config-suitcss',
     rules: {
       indentation: [4, 'tab'],
     }
   }
 }
 ```
 
-The preprocessor will also pick up any rules added to a `.stylelintrc` in your
-project root. For example:
-
-
-```js
-{
-  "extends": "stylelint-config-suitcss"
-}
-```
-
-**Note**: This works the same with the CLI `-l` flag.
-
 ##### `minify`
 
 * Type: `Boolean`

README.md

@@ -9,6 +9,7 @@ var postcss = require('postcss');
 var cssnano = require('cssnano');
 var reporter = require('postcss-reporter');
 var stylelint = require('stylelint');
+var stylelintConfigSuit = require('stylelint-config-suitcss');
 
 /**
  * Module export
@@ -128,7 +129,7 @@ function lintImportedFiles(options, css, filename) {
   var processor = postcss();
 
   if (options.lint) {
-    processor.use(stylelint(options.stylelint));
+    processor.use(stylelint(options.stylelint || stylelintConfigSuit));
   }
 
   processor

lib/index.js

@@ -1,4 +1,3 @@
 .Component {
-  flex: 1;
-  box-sizing: content-box;
+    box-sizing: content-box;
 }

test/fixtures/stylelint.css

@@ -166,6 +166,24 @@ describe('suitcss', function() {
         ).to.be.fulfilled;
       });
 
+      it('should allow the config to be overidden', function() {
+        return expect(
+          suitcss('@import "./stylelint.css"', {
+            lint: true,
+            root: 'test/fixtures',
+            stylelint: {
+              extends: 'stylelint-config-suitcss',
+              rules: {
+                indentation: 4
+              }
+            },
+            'postcss-reporter': {
+              throwError: true
+            }
+          })
+        ).to.be.fulfilled;
+      });
+
       it('should throw an error if stylelint fails', function() {
         return expect(
           suitcss('@import "./stylelint.css"', {
@@ -332,7 +350,7 @@ describe('cli', function() {
   it('should output stylelint warnings', function(done) {
     exec('node bin/suitcss -i test/fixtures test/fixtures/stylelint-import.css test/fixtures/cli/output.css -l', function(err, stdout) {
       if (err) return done(err);
-      expect(stdout).to.contain('Expected "box-sizing" to come before "flex"');
+      expect(stdout).to.contain('Expected indentation of 2 spaces');
       done();
     });
   });