AtomLinter / linter-stylelint

A plugin for Atom Linter providing an interface to stylelint.
https://atom.io/packages/linter-stylelint
116 stars 37 forks source link

Update readme with a bit more info #365

Open jsejcksn opened 7 years ago

jsejcksn commented 7 years ago

The owner of the incredibly popular linter-csslint is encouraging the community to switch to this Atom package due to lack of maintenance.

Perhaps now is a good time to update the Readme with any information that might be helpful for potentially migrating/new users.

Here's a starter question: Does it lint on the fly or only on save?

I'm not saying it needs to sound like an evangelical street preacher, but a few tidbits about its merits would be excellent.

Arcanemagus commented 7 years ago

I'm not saying it needs to sound like an evangelical street preacher, but a few tidbits about its merits would be excellent.

If you want to get more information on the differences between the two an excellent resource would be https://github.com/CSSLint/csslint/issues/668, where the authors of stylelint proposed various paths forward for merging the teams together (Like JSCS merged into ESLint), and how to get users migrated over.

Unfortunately not much came from it so many people are still stuck on CSSLint.

The primary reasons I recommend people switch over are:

Perhaps now is a good time to update the Readme with any information that might be helpful for potentially migrating/new users.

Unfortunately the bits of time that I can dedicate to these providers is mainly spent on keeping them updated and working, as I only use a few myself the readmes unfortunately fall behind as there are very few providers that have maintainers that actually work on them. Any help here would be greatly appreciated, especially since it's very hard to come at it from a "new user" perspective after writing the code that does all the work.

Does it lint on the fly or only on save?

https://github.com/AtomLinter/linter-stylelint/blob/e2c8653849e543628c54a8119fc92c7cf9b65c66/lib/index.js#L89

As with any Linter provider, this can be checked from the lintsOnChange (or lintOnFly for v1 providers) property. I wouldn't expect new users (or any user) to check that though, so adding it to the readme isn't a bad idea 😉.

The owner of...

I'm actually an owner of the entire @AtomLinter organization, not "just" linter-csslint. As stated over in linter-csslint the original authors of that provider there long ago abandoned it.