Add support for *-deprecation command-line flags of Node.js

[fpetrakov]

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

Closes #7533

Is there anything in the PR that needs further explanation?

No, it's self-explanatory.

[changeset-bot]

🦋 Changeset detected

Latest commit: 47c57d1

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]

@fpetrakov Thanks for the pull request!

As @Mouvedia commented, 'DeprecationWarning' is required to affect the *-deprecation CLI flags of Node.js. Can you address the comment, please?

Ref https://nodejs.org/api/process.html#event-warning

[Mouvedia]

If we can settle on

• whether sentences should end with a period
• if the arbitrary order that I have chosen for the codes is fine

then this PR could be merged.

[ybiquitous]

@Mouvedia Thanks for the good points 👍🏼

I think having a period is better as the Node.js API does:

$ node -e "new Buffer('')" --throw-deprecation
node:internal/process/warning:185
        throw warning;
        ^

DeprecationWarning: Buffer() is deprecated due to security and usability issues. Please use the Buffer.alloc(), Buffer.allocUnsafe(), or Buffer.from() methods instead.
    at showFlaggedDeprecation (node:buffer:188:11)
    at new Buffer (node:buffer:266:3)
    at [eval]:1:1
    at runScriptInThisContext (node:internal/vm:209:10)
    at node:internal/process/execution:109:14
    at [eval]-wrapper:6:24
    at runScript (node:internal/process/execution:92:62)
    at evalScript (node:internal/process/execution:123:10)
    at node:internal/main/eval_string:51:3 {
  code: 'DEP0005'
}

Node.js v21.7.1

Also, I'm fine if the code order is like stylelint:001, stylelint:002, ... 👍🏼

Ref https://nodejs.org/api/deprecations.html

---

Besides, although it is not required, adding a utility might be helpful, e.g.

const CODES = {
  '001': {message: 'Message 1', detail: '...'},
  '002': {message: 'Message 2'},
  // ...
};

/**
 * @param {keyof CODES} code
 */
function emitDeprecation(code) {
  const {message, detail} = CODES[code];
  process.emitWarning(message, {type: 'DeprecationWarning', code: `stylelint:${code}`, detail});
}

[Mouvedia]

I think having a period is better as…

The suggestions have been updated.

I'm fine if the code order…

OK

[Mouvedia]

@fpetrakov @ybiquitous npm build needs to be run again and the tests need to be updated after the code review suggestions commit.

[ybiquitous]

@fpetrakov Sorry for the late response, and thank you for addressing the reviews!
I've pushed a commit (47c57d1) about the code style, but it's a trivial change.

LGTM 👍🏼

[ybiquitous]

@Mouvedia Do you have any thoughts left?

[Mouvedia]

@Mouvedia Do you have any thoughts left?

Maybe add a task to #7396 that says we need to run tests using --throw-deprecation before releasing. For the rest it LGTM.

[ybiquitous]

Maybe add a task to #7396 that says we need to run tests using --throw-deprecation before releasing.

Sounds good. Can you open an issue and add it to the list?