Deprecate stylistic rules handled by Prettier #6504

ybiquitous · 2022-12-04T00:38:49Z

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

Is there anything in the PR that needs further explanation?

I've created a one-time script to rewrite a lot of rule files.

Usage:

node scripts/deprecate-stylistic-rules-handled-by-prettier.mjs

I've created a one-time script to rewrite a lot of rule files. Usage: ```shell node scripts/deprecate-stylistic-rules-handled-by-prettier.mjs ```

changeset-bot · 2022-12-04T00:38:52Z

🦋 Changeset detected

Latest commit: 23a4e75

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
stylelint	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

ybiquitous · 2022-12-04T00:47:40Z

lib/rules/at-rule-name-case/README.md

@@ -1,5 +1,7 @@
 # at-rule-name-case

+> **Warning** This rule is deprecated and will be removed in the future.
+


[ask] I believe the warning message is helpful, but what do you think?

[note] GitHub renders the > **Warning** text as follows:

On the other hand, Docusaurus has a different rendering syntax called Admonitions. E.g.

:::caution This rule is deprecated and will be removed in the future. :::

If using Admonitions, we need to rewrite the warning syntax on the stylelint.io repo.

I believe the warning message is helpful, but what do you think?

LGTM

we need to rewrite the warning syntax on the stylelint.io repo.

Yes, but only if it's quick to do as:

I think it'll look good enough on the website

we'll be removing the rules in the next major release

Agree. It looks like we don't need to add an extra process.

scripts/deprecate-stylistic-rules-handled-by-prettier.mjs

jeddy3

@ybiquitous This is fantastic, thank you!

I've added a commit to add a migration entry. Although, not a breaking change it's a significant one that we need to walk our users through.

jeddy3 · 2022-12-05T16:18:07Z

docs/developer-guide/rules.md

@@ -6,6 +6,25 @@ Please help us create, enhance, and debug our rules!

 You should get yourself ready to [contribute code](../../CONTRIBUTING.md#code-contributions).

+### Define the rule


[Note] Pulled this out so that the list of rules is near the top of the page.

jeddy3 · 2022-12-05T16:19:40Z

docs/migration-guide/to-15.md

@@ -1,12 +1,65 @@
 # Migrating to 15.0.0

-## Remove support for processors
+This release contains significant and breaking changes that will help us modernize our code so that Stylelint remains free of security issues.


[Note] Provide some context to changes. Doesn't go into the details of:

needing to migrate to ESM so we can keep as dependencies up to date

we have limited resources and time to make that migration

jeddy3 · 2022-12-05T16:21:30Z

docs/migration-guide/to-15.md

+We recommend:
+
+- using a pretty printer, like [Prettier](https://prettier.io/), alongside Stylelint
+- extending [our standard config](https://www.npmjs.com/package/stylelint-config-standard) in your configuration object


[Note] Opportunity to suggest our users adopt our standard config, if they haven't already.

jeddy3 · 2022-12-05T16:29:07Z

docs/migration-guide/to-15.md

+}
+```
+
+[Our standard config](https://www.npmjs.com/package/stylelint-config-standard) turns on many of the [other rules that enforce conventions](../user-guide/rules.md#enforce-conventions), e.g. most of the [`*-notation`](../user-guide/rules.md#notation), [`*-pattern`](../user-guide/rules.md#pattern) and [`*-quotes`](../user-guide/rules.md#quotes) rules. We recommend adding more of [the rules that enforce conventions](../user-guide/rules.md#enforce-conventions) to your config as many of them will be specific to your needs, e.g. what [units you allow](../../lib/rules/unit-allowed-list/README.md) in your code.


[Note] We originally positioned our standard config to be about formatting whitespace. It's changed significantly over time, especially now that we're deprecating the stylistic rules. This bit communicates that our standard config still offers plenty of value over our recommended config as it turns on a lot of rules that enforce conventions. Additionally, we recently regrouped how we list rules and this draws attention to that. All this is to inform our users that Stylelint is the best (and perhaps only) tool for enforcing non-stylistic conventions.

I suggest we mark the rules in our list that are included in our configs. This will help our users make use of the convention enforcing rules. Our current approach of listing rules in the config README isn't great as:

the list has fallen out of date

it's difficult to see the full picture of what rules are turned on and which aren't

I suggest we mark the rules in our list that are included in our configs.

Sounds good. Do you already have an idea of how to realize it?

Do you already have an idea of how to realize it?

I figured we could just whack an "R" and/or "S" on the end of the rule description and throw a key at the top. Something along the lines of:

(R & S) = In our recommended and standard configs
(S) = In our standard config

at-rule-no-unknown: Disallow unknown at-rules (R).

selector-attribute-quotes: Require or disallow quotes for attribute values (Autofixable) (R & S).

What do you think?

(We can do it in a follow-up pull request.)

I see. It's the simplest solution, but there is a way to use emojis and a table for more readability. This is an example of eslint-plugin-react.

In addition, if we could add such information as R and S to each rule's metadata, it might be possible to check invalid documents or generate documents.

Ⓡ and Ⓢ

jeddy3 · 2022-12-05T16:30:46Z

docs/migration-guide/to-15.md

+}
+```
+
+If you want to continue using Stylelint to enforce stylistic consistency, you can [migrate the deprecated rules you need to a plugin](../developer-guide/plugins.md). We will remove the rules from Stylelint in the next major release.


[Note] This is at the bottom as it's not the recommended route. The rules are problematic and a plugin would suffer the same issues:

old code reliant on stylesearch

not cleanly working with the AST

introducing new lint problems

a confusing number of configuration options

Pretty printing an AST based on the line length is a better approach.

jeddy3 · 2022-12-05T16:31:30Z

docs/user-guide/get-started.md

@@ -29,18 +29,6 @@ npx stylelint "**/*.css"

 _You should include quotation marks around file globs._

-If you use a pretty printer alongside Stylelint, you should turn off any conflicting rules. For example, you can use [Prettier's shared config](https://www.npmjs.com/package/stylelint-config-prettier) to do that:


[Note] We don't need to suggest using the config anymore as the configs won't conflict.

ybiquitous

@jeddy3 Thank you for writing up the documents. LGTM.

jeddy3

LGTM too

I think we can merge this.

Mouvedia · 2022-12-06T12:28:10Z

lib/rules/block-closing-brace-newline-after/index.js

@@ -23,6 +23,7 @@ const messages = ruleMessages(ruleName, {
 const meta = {
 	url: 'https://stylelint.io/user-guide/rules/block-closing-brace-newline-after',
 	fixable: true,
+	deprecated: true,


I wanted to check whether all the rules that were being deprecated were properly covered by prettier.

This one has options:

"always"

"always-single-line"

"never-single-line"

"always-multi-line"

"never-multi-line"

Are all of these properly covered by prettier?
If not, we need to make a list of rules that are being deprecated but are only partially covered by the prettier replacement.
e.g.

name support note

rule A full

rule B partial does not support option X and Y

rule C partial only support option Z

@Mouvedia was please suggested list created? To see which deprecated rule can be covered by the prettier replacement? Thanks.

@jeddy3 @ybiquitous î

Ideally, we might make a list, but we need more resources. Also, it may not be precious since the rules will be removed in the next major update.

However, we welcome your contribution if you have time.

Following on from #6657 (comment), I suggest the people working on the plugin pack draw up the list.

As @ybiquitous said, we've other things to focus on (that will benefit most of our users). I suspect most people already use a pretty printer alongside Stylelint (as we've been advocating that approach for over a year now in our docs), and most of those who don't will soon, as it's our recommended approach in our new migration guide.

Anyone wanting to continue using Stylelint for formatting can work together on a community plugin pack. As with custom syntaxes, the health of the plugin will be determined by the health of the community that maintains it.

Deprecate stylistic rules handled by Prettier

81a02b7

I've created a one-time script to rewrite a lot of rule files. Usage: ```shell node scripts/deprecate-stylistic-rules-handled-by-prettier.mjs ```

Make warning one-line

6f516b5

ybiquitous commented Dec 4, 2022

View reviewed changes

ybiquitous added 4 commits December 4, 2022 09:53

Test deprecated rules

e1fe14a

Update docs

2be55ee

Fix docs/user-guide/rules.md

bdcf94e

Add changelog entry

d9ff205

ybiquitous marked this pull request as ready for review December 4, 2022 01:18

ybiquitous commented Dec 4, 2022

View reviewed changes

scripts/deprecate-stylistic-rules-handled-by-prettier.mjs Outdated Show resolved Hide resolved

ybiquitous linked an issue Dec 4, 2022 that may be closed by this pull request

Deprecate stylistic rules handled by Prettier #6342

Closed

ybiquitous and others added 2 commits December 6, 2022 00:52

Merge branch 'v15' into issue-6342

0732ce9

Add migration guide entry

0b37311

jeddy3 reviewed Dec 5, 2022

View reviewed changes

jeddy3 and others added 3 commits December 5, 2022 17:12

Revert declaration-empty-line-before

9f04234

Update snapshots

09e5a50

Delete no longer needed script

23a4e75

ybiquitous commented Dec 6, 2022

View reviewed changes

jeddy3 approved these changes Dec 6, 2022

View reviewed changes

jeddy3 merged commit 716139d into v15 Dec 6, 2022

jeddy3 deleted the issue-6342 branch December 6, 2022 11:32

jeddy3 mentioned this pull request Dec 6, 2022

Deprecate stylistic rules handled by Prettier #6342

Closed

Mouvedia reviewed Dec 6, 2022

View reviewed changes

jeddy3 mentioned this pull request Dec 10, 2022

indentation rule needs multiple passes and never stabilize #6514

Closed

rotu mentioned this pull request Apr 6, 2023

Deprecated stylelint rules maplibre/maplibre-gl-js#2351

Closed

Mouvedia mentioned this pull request Jun 3, 2023

Document stylistic plugin in migration guide #6753

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate stylistic rules handled by Prettier #6504

Deprecate stylistic rules handled by Prettier #6504

ybiquitous commented Dec 4, 2022

changeset-bot bot commented Dec 4, 2022 •

edited

ybiquitous Dec 4, 2022

jeddy3 Dec 5, 2022

ybiquitous Dec 5, 2022

jeddy3 left a comment

jeddy3 Dec 5, 2022

jeddy3 Dec 5, 2022

jeddy3 Dec 5, 2022

jeddy3 Dec 5, 2022 •

edited

ybiquitous Dec 5, 2022

jeddy3 Dec 5, 2022

ybiquitous Dec 6, 2022

Mouvedia Dec 6, 2022

jeddy3 Dec 5, 2022 •

edited

jeddy3 Dec 5, 2022

ybiquitous left a comment

jeddy3 left a comment

Mouvedia Dec 6, 2022 •

edited

nolimitdev Feb 13, 2023

Mouvedia Feb 13, 2023

ybiquitous Feb 13, 2023

jeddy3 Feb 13, 2023 •

edited

		@@ -1,5 +1,7 @@
		# at-rule-name-case

		> Warning This rule is deprecated and will be removed in the future.

		@@ -6,6 +6,25 @@ Please help us create, enhance, and debug our rules!

		You should get yourself ready to [contribute code](../../CONTRIBUTING.md#code-contributions).

		### Define the rule

		@@ -29,18 +29,6 @@ npx stylelint "*/.css"

		_You should include quotation marks around file globs._

		If you use a pretty printer alongside Stylelint, you should turn off any conflicting rules. For example, you can use [Prettier's shared config](https://www.npmjs.com/package/stylelint-config-prettier) to do that:

name	support	note
rule A	full
rule B	partial	does not support option X and Y
rule C	partial	only support option Z

Deprecate stylistic rules handled by Prettier #6504

Deprecate stylistic rules handled by Prettier #6504

Conversation

ybiquitous commented Dec 4, 2022

changeset-bot bot commented Dec 4, 2022 • edited

🦋 Changeset detected

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeddy3 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeddy3 Dec 5, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeddy3 Dec 5, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ybiquitous left a comment

Choose a reason for hiding this comment

jeddy3 left a comment

Choose a reason for hiding this comment

Mouvedia Dec 6, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeddy3 Feb 13, 2023 • edited

Choose a reason for hiding this comment

changeset-bot bot commented Dec 4, 2022 •

edited

jeddy3 Dec 5, 2022 •

edited

jeddy3 Dec 5, 2022 •

edited

Mouvedia Dec 6, 2022 •

edited

jeddy3 Feb 13, 2023 •

edited