feat: add stylelint

[ismay]

https://dhis2.atlassian.net/browse/DHIS2-16776

• Add stylelint config (d2 style add stylelint)
• Remove stylelint config (d2 style remove stylelint)
• Check css
  • d2 style check css
  • d2 style check css <filename>
  • d2 style check css --staged
• Autofixing css
  • d2 style apply css (applies prettier and stylelint fixes)
• Update readme

Note:

Unrelated, but for some reason the dotfiles at the root of this repo were executable. There's no need for that, so I removed it: 160c29a

Follow up:

• Add other rules for stylelint (like their base config, etc.)
• Add other types (like css-in-js, etc.)
• Ignorefile handling

[ismay]

In thinking about this, it might be better to just make this an error right away. I think all these warnings can be autofixed (we should doublecheck that). But we could do that later as well.

[Mohammer5]

Tool works as expected, just one minor thing:
I just used this to add stylelint to a local dhis2 repository. When trying to check for stylelint issues, I'm getting the following warning:

../cli-style/bin/d2-style check css
css > stylelint 
Error: No rules found within configuration. Have you provided a "rules" property?
    at configurationError (file:///home/gerkules/development/dhis2/cli-style/node_modules/stylelint/lib/utils/configurationError.mjs:12:49)

When I add rules: [] to the .stylelintrc.js, the warning is gone.

[Mohammer5]

Would this need to install npm@6, just like the UI lib?

[ismay]

As long as we don't have the peerdependency issues that ui has we shouldn't. I don't think this lib has that problem, so we should be good.

[ismay]

Tool works as expected, just one minor thing: I just used this to add stylelint to a local dhis2 repository. When trying to check for stylelint issues, I'm getting the following warning:

../cli-style/bin/d2-style check css
css > stylelint 
Error: No rules found within configuration. Have you provided a "rules" property?
    at configurationError (file:///home/gerkules/development/dhis2/cli-style/node_modules/stylelint/lib/utils/configurationError.mjs:12:49)

When I add rules: [] to the .stylelintrc.js, the warning is gone.

Weird, the config that this tool installs has rules, see here. It's referenced via the template that we install, here. Did you install stylelint with d2 style add stylelint? If so, does the .stylelintrc.js in the root of your project look like the template?

[ismay]

Follow up to the previous comment: I've had a horrible time on my desktop trying to get yarn link to work with our monorepo for @dhis2/cli. Eventually I gave up and went back to macos. There I could confirm that d2 style add stylelint adds what I quoted above:

const { config } = require('@dhis2/cli-style')

module.exports = {
    extends: [config.stylelint],
}

So it should be good. Let me know.

[Mohammer5]

I didn't get these issues when I actually linked the library, my bad!
There's one inconsistency: formatting the css lint issues doesn't print the files that were touched during that process, unlike what the other tools do.
Not really a problem IMO, so I approve

[ismay]

I double checked, it seems like only prettier outputs the files that it formatted. I've looked at whether eslint supports outputting the files that it touched with --fix, but it doesn't seem like it does. So we're limited by what the tools themselves support.

[dhis2-bot]

🎉 This PR is included in version 10.6.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀