Deprecate GitHub formatter

[jeddy3]

What is the problem you're trying to solve?

Ref: #7430 (comment)

What solution would you like to see?

Deprecate the GitHub formatter and remove it in the next major release.

Ideally, we'd link to a newly published GitHub custom formatter as part of the deprecation changelog entry.

[JounQin]

Deprecate it in a minor version and remove it in a major version?

[jeddy3]

Yes, that's correct. There'll be a separate issue for removing it. And we won't work on that one until we start on 17.0.0 further down the line.

[Mouvedia]

If we remove it and link a package in the documentation, I'd support the deprecation/removal.

IMHO it should be accompanied by the integration of a JUnit formatter; probably based on stylelint-junit-formatter.
The reason being that it's used by Circle CI, Bitbucket and Bamboo.
i.e. it's a de facto common format which addition is warranted

[ybiquitous]

When I looked for candidates, I found 2 packages:

• stylelint-formatter-github
  • Most popular, presented in Awesome Stylelint, but inactive
• stylelint-actions-formatters
  • Active, considering the newer API (problem matcher)

So I'll contact an author of stylelint-actions-formatters.

[ybiquitous]

I just added stylelint-actions-formatters in stylelint/awesome-stylelint#70

[ybiquitous]

So I'll contact an author of stylelint-actions-formatters.

Done: xt0rted/stylelint-actions-formatters#187

[ybiquitous]

Since I found an alternative package, I've labeled the issue as ready to implement. Please consider contributing if you have time.

process.emitWarning() like #7550 will output a deprecation warning if --formatter=github or stylelint.lint({ formatter: 'github' }) is used.

After this warning is released in a minor version (e.g. 16.x.y), let's remove the formatter in the next major version (17.0.0).

[github-actions]

This issue is older than one month. Please ask before opening a pull request, as it may no longer be relevant.