Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Rename "at-rules-without-declaration-blocks" to "blockless-at-rules" in max-nesting-depth #2275

Merged
merged 2 commits into from
Jan 22, 2017
Merged

Rename "at-rules-without-declaration-blocks" to "blockless-at-rules" in max-nesting-depth #2275

merged 2 commits into from
Jan 22, 2017

Conversation

hudochenkov
Copy link
Member

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

Closes #2231.

Is there anything in the PR that needs further explanation?

No, it's self explanatory.

jeddy3
jeddy3 requested changes Jan 21, 2017
View reviewed changes
Copy link
Member

@jeddy3 jeddy3 left a comment

Choose a reason for hiding this comment

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

Besides one very tiny docs request, this looks great to me :)

lib/rules/max-nesting-depth/README.md
### `ignore: ["at-rules-without-declaration-blocks"]`
### `ignore: ["blockless-at-rules"]`

***Note: This option was previously called `at-rules-without-declaration-blocks`. See [the release planning docs](http://stylelint.io/user-guide/release-planning/) for details.***
Copy link
Member

Choose a reason for hiding this comment

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

Let's drop the "See the release planning docs for details." bit.

I made a mistake advocating that in another PR. The releasing planning doc is a call for community help, and no help is required with these option renames.

@davidtheclark
Copy link
Contributor

Thanks! @jeddy3 @hudochenkov How are we handling changelog entries for the deprecations branch?

@davidtheclark davidtheclark merged commit 995d642 into deprecations Jan 22, 2017
@davidtheclark davidtheclark deleted the issue-2231 branch January 22, 2017 01:50
@davidtheclark davidtheclark mentioned this pull request Jan 22, 2017
Closed
@hudochenkov
Copy link
Member Author

@davidtheclark @jeddy3 I can't find any changelog messages for deprecated rules and options.

Nevertheless there is an issue with a list of deprecated rules #2123 and PR with some of these rules deprecated #2197.

List of deprecated options #1663 (comment) (subject to change), PR with deprecation #2213.

And current PR #2275.

Shall we add everything deprecated to changelog in deprecations branch?

@jeddy3
Copy link
Member

jeddy3 commented Jan 22, 2017

Shall we add everything deprecated to changelog in deprecations branch?

Yes please!

They've historically been written as:

  • Deprecated: number-zero-length-no-unit. Use length-zero-no-unit instead.
  • Deprecated: "single-where-required" option for font-family-name-quotes. Use the "always-unless-keyword" option instead.
  • Deprecated: x. If you use this option/rule, please consider creating a plugin for the community. See the release planning document for more details.

FYI, I forgot to mention that the changelog is written in the following order:

  • Removed
  • Changed
  • Deprecated
  • Added
  • Fixed

And within each group it is order by general items first (i.e. the engine, CLI etc), follow by rule specific items (order alphabetically by the rule name e.g. "Fixed: indentation no longer warns ...")

@hudochenkov
Copy link
Member Author

@jeddy3 I'm not sure where to put these changelog records, because changelog in deprecataions branch is a little outdated.

  • Deprecated: block-no-single-line. Use block-opening-brace-newline-after and block-closing-brace-newline-before rules with the option "always" instead. See the FAQs for an example.
  • Deprecated: declaration-block-no-ignored-properties. If you use this option/rule, please consider creating a plugin for the community.
  • Deprecated: declaration-block-properties-order. Use the community stylelint-order plugin pack instead. See the release planning document for more details.
  • Deprecated: media-feature-no-missing-punctuation. If you use this option/rule, please consider creating a plugin for the community.
  • Deprecated: selector-no-empty. If you use this option/rule, please consider creating a plugin for the community.
  • Deprecated: "all-nested" option for at-rule-empty-line-before. Use the "inside-block" option instead.
  • Deprecated: "blockless-group" option for at-rule-empty-line-before. Use the "blockless-after-blockless" option instead.
  • Deprecated: "between-comments" option for comment-empty-line-before. Use the "after-comment" option instead.
  • Deprecated: "stylelint-commands" option for comment-empty-line-before. Use the "stylelint-command" option instead.
  • Deprecated: "at-rules-without-declaration-blocks" option for max-nesting-depth. Use the "blockless-at-rules" option instead.

@jeddy3
Copy link
Member

jeddy3 commented Jan 24, 2017

Probably rebase deprecations off master, then add a new "Deprecations" heading at the top of the CHANGELOG and put them in there?

Your items LGTM. I've made a couple of tweaks (edit my post to access the raw markdown):

  • Deprecated: block-no-single-line. Use block-opening-brace-newline-after and block-closing-brace-newline-before rules with the option "always" instead. See the FAQs for an example.
  • Deprecated: declaration-block-no-ignored-properties. If you use this rule, please consider creating a plugin for the community. See the release planning document for more details.
  • Deprecated: declaration-block-properties-order. Use the community stylelint-order plugin pack instead. See the release planning document for more details.
  • Deprecated: media-feature-no-missing-punctuation. If you use this rule, please consider creating a plugin for the community. See the release planning document for more details.
  • Deprecated: selector-no-empty. If you use this rule, please consider creating a plugin for the community. See the release planning document for more details.
  • Deprecated: "all-nested" option for at-rule-empty-line-before. Use the "inside-block" option instead.
  • Deprecated: "blockless-group" option for at-rule-empty-line-before. Use the "blockless-after-blockless" option instead.
  • Deprecated: "between-comments" option for comment-empty-line-before. Use the "after-comment" option instead.
  • Deprecated: "stylelint-commands" option for comment-empty-line-before. Use the "stylelint-command" option instead.
  • Deprecated: "at-rules-without-declaration-blocks" option for max-nesting-depth. Use the "blockless-at-rules" option instead.

@davidtheclark
Copy link
Contributor

Thanks @hudochenkov!

hudochenkov added a commit that referenced this pull request Jan 24, 2017
@hudochenkov
Rename "at-rules-without-declaration-blocks" to "blockless-at-rules" …
032d809 
…in max-nesting-depth (#2275)

* Rename "at-rules-without-declaration-blocks" to "blockless-at-rules" in max-nesting-depth (#2231)

* Remove unnecessary reference in docs
@hudochenkov
Copy link
Member Author

Done. But I forgot about “Deprecations” header 🤷‍♂️

@ntwb
Copy link
Member

ntwb commented Jan 24, 2017

Done. But I forgot about “Deprecations” header 🤷‍♂️

I think leaving that as HEAD is fine...

Could also change it to HEAD (DEPRECATION) and HEAD (V8) for the two major branches we're currently juggling?

@hudochenkov hudochenkov mentioned this pull request Sep 8, 2017
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jeddy3 jeddy3 jeddy3 approved these changes

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@hudochenkov @davidtheclark @jeddy3 @ntwb