stylelint middleware #615

timkelty · 2017-12-13T20:59:20Z

Most of what's here is adapted from https://github.com/barraponto/neutrino-middleware-stylelint 👏

Curious if @mozilla-neutrino/core-contributors think this should be in core, or just maintained by community. If the consensus is the latter, I'm happy to PR @barraponto's package.

stylelint felt like a commonly used enough tool that it could be a good case for a core middleware.

Related: #612

timkelty · 2017-12-14T17:13:19Z

packages/stylelint/test/middleware_test.js

+
+test('exposes stylelintrc config', t => {
+  t.is(typeof Neutrino().use(mw()).call('stylelintrc'), 'object');
+});


Hmmm - This last test causes tests to fail: https://travis-ci.org/mozilla-neutrino/neutrino-dev/jobs/316091388#L920-L932 not sure why…seems identical to the eslintrc test…

Run the tests locally and see the output of Neutrino().use(mw()).call('stylelintrc').

Oh derp - it's b/c stylelint throws err if you don't pass it anything.
Fixed.

barraponto · 2017-12-15T12:40:10Z

YAY let's move this into core!

timkelty · 2017-12-18T19:18:32Z

Is anyone else using Atom/AtomLinter with linter-stylelint?

If I try to use neutrinorc.js for my stylint config, I get this error: atom/atom#15093 (comment)

.stylelintrc.js

const {Neutrino} = require('neutrino');
const {resolve} = require('path');

module.exports = Neutrino()
  .use(resolve(__dirname, '.neutrinorc.js'))
  .call('stylelintrc');

neutrino stylelintrc outputs the correct thing from the cli.
Sublime Text 3/SublimeLinter works fine.

eliperelman · 2017-12-19T15:13:47Z

packages/stylelint/index.js

+    files: '**/*.+(css|scss|sass|less)',
+    context: neutrino.options.source,
+    failOnError: neutrino.options.command !== 'start',
+    quiet: neutrino.options.command === 'start'


We also have neutrino.options.quiet, would that be useful here?

eliperelman · 2017-12-19T15:16:02Z

So far I think this is pretty cool! Could you post some screenshots showing this in action?

timkelty · 2017-12-19T17:04:23Z

Would also like to tie this into the lint command. Haven't had success so far: #612

edmorley · 2017-12-19T17:12:38Z

packages/stylelint/README.md

@@ -0,0 +1,65 @@
+# Neutrino stylelint Middleware


Need a docs/ copy of this too.. :-)

Also a reference from docs/SUMMARY.md

Yup - I'll wait till things gel a bit, then add it.

timkelty · 2017-12-20T02:26:01Z

Here's some screenshots:
neutrino stylelint command:

neutrino start:

eliperelman · 2018-01-15T03:38:59Z

packages/stylelint/README.md

+
+## Requirements
+
+- Node.js v6.10+


This section needs to be updated according to the other docs as well. I wish we had templated docs.

eliperelman · 2018-01-15T03:41:26Z

packages/stylelint/index.js

+    files: '**/*.+(css|scss|sass|less)',
+    context: neutrino.options.source,
+    failOnError: neutrino.options.command !== 'start',
+    quiet: neutrino.options.command === 'start',


When the command isn't start, what does quiet do?

This ensures that the actual error is output, when failOnError is enabled.

E.g. with settings the way they currently are, you will get:

⠼ Building project src/css/index.scss 8:1 ✖ Unexpected empty line before at-rule at-rule-empty-line-before ✖ Building project failed Error: Failed because of a stylelint error. at linterSuccess (/Users/timkelty/Code/neutrino-dev/node_modules/stylelint-webpack-plugin/lib/run-compilation.js:34:14) at <anonymous> error Command failed with exit code 1. info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

But if we don't set quiet (defaulting to true), you won't get the actual error:

✖ Building project failed Error: Failed because of a stylelint error. at linterSuccess (/Users/timkelty/Code/neutrino-dev/node_modules/stylelint-webpack-plugin/lib/run-compilation.js:34:14) at <anonymous> error Command failed with exit code 1. info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

The other option is to not set either failOnError or quiet, since by default it emits errors to webpack, so the build will fail anyway.

The other option is to not set either failOnError or quiet, since by default it emits errors to webpack, so the build will fail anyway.

I opted to go this route. Let me know if you see any issues. I belive I started down the failOnError route because that's what @neutrinojs/eslint does…

eliperelman · 2018-01-15T03:43:36Z

packages/stylelint/index.js

+      const files = join(options.context, options.files);
+
+      return lint(merge(options, { fix, files }))
+        .then(result => Promise[result.errored ? 'reject' : 'resolve'](result.output));


For clarity, and I know it's a little nitpicky, let's move the ternary to the outside:

return lint(merge(options, { fix, files })) .then(result => result.errored ? Promise.reject(result.output) : Promise.resolve(result.output));

nitpicky is good :)

eliperelman · 2018-01-15T03:45:18Z

packages/stylelint/package.json

+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {


Let's inject the engines from the other middleware here now:

https://github.com/mozilla-neutrino/neutrino-dev/blob/e52919b5ebcd694857bb7a5244afe07ca1299fd1/packages/copy/package.json#L20-L24

From https://github.com/JaKXz/stylelint-webpack-plugin.

timkelty · 2018-01-23T02:56:00Z

Ok, I think all review notes should be addressed, and I added some documentation for the cli commands.

eliperelman

Thank you for your patience on this one!

Superseded.

timkelty · 2018-01-29T17:24:34Z

🍾

timkelty requested review from barraponto, eliperelman, edmorley and helfi92 December 13, 2017 20:59

timkelty changed the title ~~Stylelint middleware~~ stylelint middleware Dec 13, 2017

timkelty commented Dec 14, 2017

View reviewed changes

eliperelman reviewed Dec 19, 2017

View reviewed changes

edmorley previously requested changes Dec 19, 2017

View reviewed changes

timkelty removed request for barraponto and helfi92 December 19, 2017 17:22

eliperelman added the feature label Dec 21, 2017

eliperelman suggested changes Jan 15, 2018

View reviewed changes

timkelty changed the title ~~stylelint middleware~~ WIP: stylelint middleware Jan 17, 2018

timkelty force-pushed the stylelint branch from 8253cfc to cd55f91 Compare January 17, 2018 14:22

Tim Kelty added 8 commits January 17, 2018 09:23

Initial commit

87b6670

Initial port from eslint & barraponto/neutrino-middleware-stylelint

eb162f1

Add Capi Etheriel to contributors.

dd7201e

Pass test options

7ec52c7

Align options with stylelint node api.

2052c41

Format string output.

c8e71f7

Remove lint command

6b96927

Use formatter function

bc8158d

timkelty force-pushed the stylelint branch from cd55f91 to bc8158d Compare January 17, 2018 14:24

Tim Kelty added 2 commits January 17, 2018 09:25

Add engines.

8dda3cf

Update reqs.

9916e25

Tim Kelty added 5 commits January 17, 2018 09:29

Add to docs

1c64693

Code style.

da2bec9

Rely on piped errors (emitErrors) instead of failOnError to fail build.

f0a15c0

From https://github.com/JaKXz/stylelint-webpack-plugin.

Set configBaseDir for relative extends/plugins

c6f237d

Add stylelint CLI/command docs.

9a0231b

timkelty changed the title ~~WIP: stylelint middleware~~ stylelint middleware Jan 23, 2018

eliperelman approved these changes Jan 29, 2018

View reviewed changes

eliperelman merged commit daafb2d into neutrinojs:master Jan 29, 2018

timkelty deleted the stylelint branch January 29, 2018 17:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

stylelint middleware #615

stylelint middleware #615

timkelty commented Dec 13, 2017

timkelty Dec 14, 2017

eliperelman Dec 14, 2017

timkelty Dec 14, 2017

barraponto commented Dec 15, 2017

timkelty commented Dec 18, 2017 •

edited

Loading

eliperelman Dec 19, 2017

eliperelman commented Dec 19, 2017

timkelty commented Dec 19, 2017

edmorley Dec 19, 2017

edmorley Dec 19, 2017

timkelty Dec 19, 2017

timkelty Jan 17, 2018

timkelty commented Dec 20, 2017

eliperelman Jan 15, 2018

eliperelman Jan 15, 2018

timkelty Jan 17, 2018

timkelty Jan 17, 2018 •

edited

Loading

eliperelman Jan 15, 2018

timkelty Jan 17, 2018

eliperelman Jan 15, 2018

timkelty commented Jan 23, 2018

eliperelman left a comment

timkelty commented Jan 29, 2018

stylelint middleware #615

stylelint middleware #615

Conversation

timkelty commented Dec 13, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

barraponto commented Dec 15, 2017

timkelty commented Dec 18, 2017 • edited Loading

Choose a reason for hiding this comment

eliperelman commented Dec 19, 2017

timkelty commented Dec 19, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

timkelty commented Dec 20, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

timkelty Jan 17, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

timkelty commented Jan 23, 2018

eliperelman left a comment

Choose a reason for hiding this comment

timkelty commented Jan 29, 2018

timkelty commented Dec 18, 2017 •

edited

Loading

timkelty Jan 17, 2018 •

edited

Loading