Update to stylelint 13 and latest schema #14

jeddy3 · 2020-04-19T09:14:07Z

Which issue, if any, is this issue related to?

Closes #13

Is there anything in the PR that needs further explanation?

This pull request overhauls the repository to bring it in line with:

latest stylelint testRule schema
latest org tooling

What we've lacked recently is an easy way for plugin authors test using the schema. This pull request addresses that immediate need.

Following on from this pull request, we can:

add stylelint-tape to awesome-stylelint
update the writing plugins docs to refer to this preset and awesome-stylelint
create @stylelint/jest-preset for setting up a common jest environment for stylelint organisation repositories; the preset would include the settings removed in the pull request, along with the Jest plugins we use in the main repo, e.g. typeahead
import and merge this preset (once we've sorted the DI) and the scoped one within the main stylelint repository
close Remove createRuleTester stylelint#4267

jeddy3 · 2020-04-19T09:29:40Z

continuous-integration/travis-ci

Not sure why Travis is still expected. We can ignore it.

hudochenkov · 2020-04-19T10:19:04Z

Not sure why Travis is still expected. We can ignore it.

It's because branch configuration wasn't changes: Settings → Branches → master Edit. There required checks should be marked.

hudochenkov

That's a great start, @jeddy3!

Don't release after merge, please. ~~Let's discuss how can we use it for both stylelint core and stylelint plugins. I'll add my thoughts to stylelint/stylelint#4267~~ Actually, I'll create follow up PR after this one is merged. We'll keep same experience for outside users (add preset, and testRule is available). For stylelint core we'll export a function require('jest-preset-stylelint/create-test-rule'), which will inject stylelint and return testRule, which could be then added to global scope of stylelint core Jest runner.

package.json

Co-Authored-By: Aleks Hudochenkov <aleks@hudochenkov.com>

jeddy3 · 2020-04-19T13:02:17Z

I'll create follow up PR after this one is merged. We'll keep same experience for outside users (add preset, and testRule is available). For stylelint core we'll export a function require('jest-preset-stylelint/create-test-rule'), which will inject stylelint and return testRule, which could be then added to global scope of stylelint core Jest runner.

Sounds good to me!

Are there any other changes, besides the peer dependency range change, that you'd like to see in this pull request?

hudochenkov · 2020-04-19T18:12:29Z

jest-setup.js


-jest.mock("./getOsEol.js", () => () => "\n");
+jest.mock('./getOsEol', () => () => '\n');

 global.testRule = (rule, schema) => {


BTW, why do we have rule here? It's not used anywhere. It looks like it was added long time ago, and since then never had been removed.

I don't know. I'll remove it in this pull request. That'll make for a cleaner function signature in 2.0.0.

hudochenkov · 2020-04-19T19:20:03Z

README.md

+
+Turn on autofix.
+
+### `only` \[boolean\]


I'm starting adding types #15 based on this PR, and discovered that this is incorrect.

only could be only on a test case, but not on the whole testRule. Same applies to skip.

Good catch.

hudochenkov · 2020-04-19T19:31:00Z

README.md

+});
+```
+
+## Schema properties


Missing syntax.

hudochenkov · 2020-04-19T19:54:00Z

README.md

+
+Description of the test case.
+
+#### `fixed` \[string\]


Discovered that unfixable property description is missing.

jeddy3 · 2020-04-20T13:39:54Z

@hudochenkov Thanks for the further review. I've addressed the requested changes.

hudochenkov

Thanks for making changes!

Tiny typo to fix.

README.md

Co-Authored-By: Aleks Hudochenkov <aleks@hudochenkov.com>

jeddy3 · 2020-04-20T19:10:06Z

Did you want to create the pull request into this branch to export the create-test-rule function, or shall I merge this into master?

hudochenkov · 2020-04-20T20:34:38Z

Merge it. I'll follow up later this week. And I could test this preset later with stylelint-order.

ntwb

Awesome work, have had a very quick look and looks good to me, thanks a bunch team 💯

jeddy3 · 2020-04-21T11:10:53Z

And I could test this preset later with stylelint-order.

Excellent. I've been testing it locally with stylelint-scales.

jeddy3 requested review from hudochenkov and ntwb April 19, 2020 09:14

Update to stylelint 13

e05fead

jeddy3 force-pushed the update-to-stylelint-13 branch from 6934a1f to e05fead Compare April 19, 2020 09:18

hudochenkov requested changes Apr 19, 2020

View reviewed changes

package.json Outdated Show resolved Hide resolved

Update package.json

01534d6

Co-Authored-By: Aleks Hudochenkov <aleks@hudochenkov.com>

hudochenkov approved these changes Apr 19, 2020

View reviewed changes

hudochenkov reviewed Apr 19, 2020

View reviewed changes

hudochenkov requested changes Apr 19, 2020

View reviewed changes

hudochenkov reviewed Apr 19, 2020

View reviewed changes

README.md

});

```

## Schema properties

Copy link

Member

hudochenkov Apr 19, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing syntax.

jeddy3 reacted with thumbs up emoji

hudochenkov reviewed Apr 19, 2020

View reviewed changes

jeddy3 added 2 commits April 20, 2020 14:05

Remove rule from testRule signature

b5c815e

Fix missing properties

5df15f2

hudochenkov approved these changes Apr 20, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

Update README.md

bdf2777

Co-Authored-By: Aleks Hudochenkov <aleks@hudochenkov.com>

ntwb approved these changes Apr 21, 2020

View reviewed changes

jeddy3 merged commit eb49f36 into master Apr 21, 2020

jeddy3 deleted the update-to-stylelint-13 branch April 21, 2020 11:11

jeddy3 mentioned this pull request Apr 21, 2020

Throws when used with latest stylelint #13

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update to stylelint 13 and latest schema #14

Update to stylelint 13 and latest schema #14

jeddy3 commented Apr 19, 2020

jeddy3 commented Apr 19, 2020

hudochenkov commented Apr 19, 2020

hudochenkov left a comment •

edited

jeddy3 commented Apr 19, 2020

hudochenkov Apr 19, 2020

jeddy3 Apr 20, 2020 •

edited

hudochenkov Apr 19, 2020

jeddy3 Apr 20, 2020

hudochenkov Apr 19, 2020

hudochenkov Apr 19, 2020

jeddy3 commented Apr 20, 2020

hudochenkov left a comment

jeddy3 commented Apr 20, 2020

hudochenkov commented Apr 20, 2020 •

edited

ntwb left a comment

jeddy3 commented Apr 21, 2020

Update to stylelint 13 and latest schema #14

Update to stylelint 13 and latest schema #14

Conversation

jeddy3 commented Apr 19, 2020

jeddy3 commented Apr 19, 2020

hudochenkov commented Apr 19, 2020

hudochenkov left a comment • edited

Choose a reason for hiding this comment

jeddy3 commented Apr 19, 2020

hudochenkov Apr 19, 2020

Choose a reason for hiding this comment

jeddy3 Apr 20, 2020 • edited

Choose a reason for hiding this comment

hudochenkov Apr 19, 2020

Choose a reason for hiding this comment

jeddy3 Apr 20, 2020

Choose a reason for hiding this comment

hudochenkov Apr 19, 2020

Choose a reason for hiding this comment

hudochenkov Apr 19, 2020

Choose a reason for hiding this comment

jeddy3 commented Apr 20, 2020

hudochenkov left a comment

Choose a reason for hiding this comment

jeddy3 commented Apr 20, 2020

hudochenkov commented Apr 20, 2020 • edited

ntwb left a comment

Choose a reason for hiding this comment

jeddy3 commented Apr 21, 2020

hudochenkov left a comment •

edited

jeddy3 Apr 20, 2020 •

edited

hudochenkov commented Apr 20, 2020 •

edited