New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consistent options #2213

Merged
merged 12 commits into from Dec 30, 2016

Conversation

4 participants
@m-allanson
Member

m-allanson commented Dec 26, 2016

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

#1663

Is there anything in the PR that needs further explanation?

This deprecates the options listed in the related issue.

The changes required for each deprecation are listed below.

In the rule:

  • trigger a deprecation warning when the old option name is used
  • duplicate all code blocks that reference the old option name and modify them to reference the new option name

In the rule's readme:

  • rename the option
  • add a note to each option describing the previous name of the option

In the rule's tests:

  • duplicate all unit tests that reference the old option name and modify them to reference the new option name
  • add one or more deprecation unit tests in a new file

Then:

  • update system test snapshots affected by previous changes

@m-allanson m-allanson force-pushed the consistent-options branch from 2b4ab64 to e5e58a8 Dec 26, 2016

@m-allanson m-allanson force-pushed the consistent-options branch 4 times, most recently from d72cedb to 16a9cc1 Dec 27, 2016

@m-allanson

This comment has been minimized.

Member

m-allanson commented Dec 28, 2016

That should be all the option deprecations covered. I'm going to check this with a fresh pair of eyes tomorrow, then mark it up as ready for review.

@m-allanson m-allanson force-pushed the consistent-options branch from 16a9cc1 to 803f588 Dec 28, 2016

@m-allanson

This comment has been minimized.

Member

m-allanson commented Dec 28, 2016

Alright, this is ready for review.

@m-allanson

This comment has been minimized.

Member

m-allanson commented Dec 29, 2016

I've just noticed this is merging into master, it should be merging into the deprecations branch instead.

@jeddy3

This comment has been minimized.

Member

jeddy3 commented Dec 29, 2016

I've just noticed this is merging into master, it should be merging into the deprecations branch instead.

Phew, I'm glad you saw. I just spotted that too and I thought I'd misunderstood how we were going out these deprecations. I think we should still merge into deprecations, if only because it'll encourage me to hurry #2079 along.

Awesome job on this PR btw. It's epic :)

@m-allanson m-allanson changed the base branch from master to deprecations Dec 29, 2016

@m-allanson m-allanson force-pushed the consistent-options branch from c418bf0 to 43d701b Dec 29, 2016

@m-allanson

This comment has been minimized.

Member

m-allanson commented Dec 29, 2016

I think we should still merge into deprecations

Agreed, PR updated.

if only because it'll encourage me to hurry #2079 along.

If it's any additional incentive, once there's consensus on #2079 I can go ahead and implement the required changes.

@davidtheclark

Looks good. Thanks for spearheading this, @m-allanson! Anybody have objections to merging? If not, I say go for it.

@evilebottnawi

@m-allanson maybe squash this commits in one for best history

@jeddy3 jeddy3 merged commit d245ad4 into deprecations Dec 30, 2016

2 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details
@jeddy3

This comment has been minimized.

Member

jeddy3 commented Dec 30, 2016

maybe squash this commits in one for best history

I've done this via Github.

@m-allanson Excellent job!

If it's any additional incentive, once there's consensus on #2079 I can go ahead and implement the required changes.

Got the ball rolling for two rules in #2220 :) Hopefully I'll have time for the rest soon!

@jeddy3 jeddy3 deleted the consistent-options branch Dec 30, 2016

hudochenkov added a commit that referenced this pull request Jan 24, 2017

Use consistent options (#2213)
* Deprecate 'all-nested' option in 'at-rule-empty-line-before'

* Deprecate 'blockless-group' option in 'at-rule-empty-line-before'

* Deprecate 'between-comments' option in 'comment-empty-line-before'

* Deprecate 'stylelint-commands' option in 'comment-empty-line-before'

* Deprecate 'first-nested' option in 'at-rule-empty-line-before'

* Deprecate 'first-nested' option in 'comment-empty-line-before'

* Deprecate 'first-nested' option in 'custom-property-empty-line-before'

* Deprecate 'first-nested' option in 'declaration-empty-line-before'

* Deprecate 'first-nested' option in 'rule-nested-empty-line-before'

* System test for option deprecations

* Update docs to reference new option names

* Update option descriptions to match the new option names
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment