Add `--compute-edit-info` flag #8473

ryo-manba · 2025-03-15T08:18:57Z

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

Is there anything in the PR that needs further explanation?

Add --compute-edit-info CLI flag to get fix information without applying changes.
~~Feel free to suggest any improvements to the message format.~~

The format will be handled separately.
See details: #8473 (comment)

changeset-bot · 2025-03-15T08:19:01Z

🦋 Changeset detected

Latest commit: b9bafc5

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

github-actions · 2025-03-15T08:20:59Z

Try the Instant Preview in Online Demo

Stylelint Online Demo

Install the Instant Preview to Your Local

npm i -D https://pkg.pr.new/stylelint@8473

View Commit

lib/cli.mjs

lib/formatters/stringFormatter.mjs

Mouvedia · 2025-03-16T01:25:28Z

@ryo-manba I did a first pass. You will have to refactor your test.
Overall it LGTM to me.

ybiquitous · 2025-03-17T02:04:04Z

Let me confirm the current status of the computeEditInfo feature (sorry, I'm a bit unfamiliar about this area).

Config.computeEditInfo is still experimental
- stylelint/types/stylelint/index.d.ts
  
  Lines 242 to 243 in 2c639ff
  
  /** @experimental */
  
  computeEditInfo?: boolean;
LinterOptions.computeEditInfo is not experimental
- stylelint/types/stylelint/index.d.ts
  
  Line 842 in 2c639ff
  
  computeEditInfo?: boolean;
computeEditInfo is still undocumented
- https://github.com/search?q=repo%3Astylelint%2Fstylelint+computeEditInfo+language%3AMarkdown+&type=code

Is my understanding above correct?

Also, before this addition of the CLI flag, should we clarify the status and publish the feature in the documentation as an experimental feature?

cc @jeddy3 @romainmenke

jeddy3 · 2025-03-17T08:27:14Z

@romainmenke is more clued up on this feature, but I think we'll be ready to release this feature (as unexperimental) when we merge PRs alongside this one for:

(There are only three rules left to do in the final issue, thanks to @pamelalozano16 and @ryo-manba hard work.)

We'll want to merge this PR and the two documentation ones together so they are included in the same release.

@ryo-manba Thank you for getting the ball rolling with this PR, by the way!

docs/user-guide/cli.md

.changeset/happy-chefs-invent.md

ybiquitous · 2025-03-17T14:41:35Z

I think we'll be ready to release this feature (as unexperimental) when we merge PRs alongside this one

Agree 👍🏼

Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>

jeddy3

Thank you for making the changes, including testing against the JSON formatter.

I've added one minor suggestion, otherwise LGTM.

jeddy3 · 2025-03-17T16:09:22Z

lib/cli.mjs

@@ -319,6 +323,11 @@ const flags = {
 		shortFlag: 'v',
 		type: 'boolean',
 	},
+	computeEditInfo: {


Let's put this after the color property to maintain the alphabetical order.

Thanks for all the details. 🙇

resolved

ybiquitous

Thank you, LGTM 👍🏼

docs/user-guide/cli.md

Mouvedia · 2025-03-23T22:33:55Z

as unexperimental

stylelint/types/stylelint/index.d.ts

Line 242 in ea401b0

/** @experimental */

stylelint/types/stylelint/index.d.ts

Line 1012 in ea401b0

/** @experimental */

stylelint/types/stylelint/index.d.ts

Line 919 in ea401b0

* @experimental

@jeddy3 do we remove these in the last PR?
If so which one is the last?

Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>

@ryo-manba

| datasource | package | from | to | | ---------- | --------- | ------- | ------- | | npm | stylelint | 16.16.0 | 16.17.0 | ## [v16.17.0](https://github.com/stylelint/stylelint/blob/HEAD/CHANGELOG.md#16170---2025-03-26) It adds 1 new rule, support for `languageOptions` to 2 rules, 1 option to a rule, the `--compute-edit-info` CLI flag (along with support for `EditInfo` in 3 rules), and fixes 1 bug. `EditInfo` is useful for automated fixing tools and editor integrations. - Added: `layer-name-pattern` rule ([#8474](stylelint/stylelint#8474)) ([@ryo-manba](https://github.com/ryo-manba)). - Added: `--compute-edit-info` CLI flag ([#8473](stylelint/stylelint#8473)) ([@ryo-manba](https://github.com/ryo-manba)). - Added: `ignorePreludeOfAtRules: []` to `length-zero-no-unit` ([#8472](stylelint/stylelint#8472)) ([@ryo-manba](https://github.com/ryo-manba)). - Added: `at-rule-no-unknown` support for `languageOptions` ([#8475](stylelint/stylelint#8475)) ([@ryo-manba](https://github.com/ryo-manba)). - Added: `property-no-unknown` support for `languageOptions` ([#8476](stylelint/stylelint#8476)) ([@ryo-manba](https://github.com/ryo-manba)). - Added: `declaration-block-no-redundant-longhand-properties` support for computing `EditInfo` ([#8482](stylelint/stylelint#8482)) ([@pamelalozano16](https://github.com/pamelalozano16)). - Added: `function-url-quotes` support for computing `EditInfo` ([#8483](stylelint/stylelint#8483)) ([@pamelalozano16](https://github.com/pamelalozano16)). - Added: `selector-attribute-quotes` support for computing `EditInfo` ([#8484](stylelint/stylelint#8484)) ([@pamelalozano16](https://github.com/pamelalozano16)). - Fixed: `custom-property-pattern` false negatives for `@property` preludes ([#8468](stylelint/stylelint#8468)) ([@rohitgs28](https://github.com/rohitgs28)).

@ryo-manba

| datasource | package | from | to | | ---------- | --------- | ------- | ------- | | npm | stylelint | 16.16.0 | 16.17.0 | ## [v16.17.0](https://github.com/stylelint/stylelint/blob/HEAD/CHANGELOG.md#16170---2025-03-26) It adds 1 new rule, support for `languageOptions` to 2 rules, 1 option to a rule, the `--compute-edit-info` CLI flag (along with support for `EditInfo` in 3 rules), and fixes 1 bug. `EditInfo` is useful for automated fixing tools and editor integrations. - Added: `layer-name-pattern` rule ([#8474](stylelint/stylelint#8474)) ([@ryo-manba](https://github.com/ryo-manba)). - Added: `--compute-edit-info` CLI flag ([#8473](stylelint/stylelint#8473)) ([@ryo-manba](https://github.com/ryo-manba)). - Added: `ignorePreludeOfAtRules: []` to `length-zero-no-unit` ([#8472](stylelint/stylelint#8472)) ([@ryo-manba](https://github.com/ryo-manba)). - Added: `at-rule-no-unknown` support for `languageOptions` ([#8475](stylelint/stylelint#8475)) ([@ryo-manba](https://github.com/ryo-manba)). - Added: `property-no-unknown` support for `languageOptions` ([#8476](stylelint/stylelint#8476)) ([@ryo-manba](https://github.com/ryo-manba)). - Added: `declaration-block-no-redundant-longhand-properties` support for computing `EditInfo` ([#8482](stylelint/stylelint#8482)) ([@pamelalozano16](https://github.com/pamelalozano16)). - Added: `function-url-quotes` support for computing `EditInfo` ([#8483](stylelint/stylelint#8483)) ([@pamelalozano16](https://github.com/pamelalozano16)). - Added: `selector-attribute-quotes` support for computing `EditInfo` ([#8484](stylelint/stylelint#8484)) ([@pamelalozano16](https://github.com/pamelalozano16)). - Fixed: `custom-property-pattern` false negatives for `@property` preludes ([#8468](stylelint/stylelint#8468)) ([@rohitgs28](https://github.com/rohitgs28)).

Add --compute-edit-info flag

417e465

Mouvedia reviewed Mar 16, 2025

View reviewed changes

lib/cli.mjs Outdated Show resolved Hide resolved

Mouvedia previously requested changes Mar 16, 2025

View reviewed changes

lib/formatters/stringFormatter.mjs Outdated Show resolved Hide resolved

Move help message position

b5920a8

Remove formatter changes

6dd5047

ryo-manba requested review from Mouvedia and ybiquitous March 17, 2025 14:22

ybiquitous reviewed Mar 17, 2025

View reviewed changes

docs/user-guide/cli.md Outdated Show resolved Hide resolved

.changeset/happy-chefs-invent.md Outdated Show resolved Hide resolved

ryo-manba and others added 2 commits March 18, 2025 00:16

Update docs/user-guide/cli.md

3a82684

Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>

Update .changeset/happy-chefs-invent.md

b51dc7f

Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>

jeddy3 reviewed Mar 17, 2025

View reviewed changes

refactor: change option position

3ee32b4

ryo-manba requested review from jeddy3 and ybiquitous March 17, 2025 16:40

ybiquitous approved these changes Mar 18, 2025

View reviewed changes

docs/user-guide/cli.md Outdated Show resolved Hide resolved

Update docs/user-guide/cli.md

b9bafc5

Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>

jeddy3 approved these changes Mar 25, 2025

View reviewed changes

jeddy3 merged commit 96ccbef into main Mar 25, 2025
19 checks passed

jeddy3 deleted the issue-8344 branch March 25, 2025 14:05

jeddy3 mentioned this pull request Mar 25, 2025

Fix types for stable editinfo #8493

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Add `--compute-edit-info` flag #8473

Add `--compute-edit-info` flag #8473

ryo-manba commented Mar 15, 2025 •

edited

Loading

Uh oh!

changeset-bot bot commented Mar 15, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Mar 15, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Mouvedia commented Mar 16, 2025

Uh oh!

ybiquitous commented Mar 17, 2025

Uh oh!

jeddy3 commented Mar 17, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

ybiquitous commented Mar 17, 2025

Uh oh!

jeddy3 left a comment

Uh oh!

jeddy3 Mar 17, 2025

Uh oh!

ryo-manba Mar 17, 2025

Uh oh!

ybiquitous left a comment

Uh oh!

Uh oh!

Mouvedia commented Mar 23, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Add --compute-edit-info flag #8473

Add --compute-edit-info flag #8473

Conversation

ryo-manba commented Mar 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot bot commented Mar 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

github-actions bot commented Mar 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Try the Instant Preview in Online Demo

Install the Instant Preview to Your Local

Uh oh!

Uh oh!

Uh oh!

Mouvedia commented Mar 16, 2025

Uh oh!

ybiquitous commented Mar 17, 2025

Uh oh!

jeddy3 commented Mar 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ybiquitous commented Mar 17, 2025

Uh oh!

jeddy3 left a comment

Choose a reason for hiding this comment

Uh oh!

jeddy3 Mar 17, 2025

Choose a reason for hiding this comment

Uh oh!

ryo-manba Mar 17, 2025

Choose a reason for hiding this comment

Uh oh!

ybiquitous left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Mouvedia commented Mar 23, 2025

Uh oh!

Uh oh!

Uh oh!

Add `--compute-edit-info` flag #8473

Add `--compute-edit-info` flag #8473

ryo-manba commented Mar 15, 2025 •

edited

Loading

changeset-bot bot commented Mar 15, 2025 •

edited

Loading

github-actions bot commented Mar 15, 2025 •

edited

Loading

jeddy3 commented Mar 17, 2025 •

edited

Loading