docs: Formatters page updates

[bpmutter]

Prerequisites checklist

• I have read the contributing guidelines.

What is the purpose of this pull request? (put an "X" next to an item)

[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

Miscellaneous changes on Formatters page:

• In the example source section, make fullOfProblems.js and .eslintrc: not headers.
• For the Example Outputs section, provide an example of the CLI input, and also give a few sentence description of what each of the output is, and why you might want to use it.
• Other small cosmetic changes and refactors

Is there anything you'd like reviewers to focus on?

Fixes #16476

[netlify]

✅ Deploy Preview for docs-eslint canceled.

Name	Link
🔨 Latest commit	7658246
🔍 Latest deploy log	https://app.netlify.com/sites/docs-eslint/deploys/638bd5ae7002370007010537

[nzakas]

While we're at it, let's use a file extension:

Suggested change

	`.eslintrc`:
	`.eslintrc.json`:

[nzakas]

Note: This page is autogenerated. Any changes made here will go live but will be overwrriten the next time the site is generated. The evergreen changes should be made in this file:

https://github.com/eslint/eslint/blob/main/templates/formatter-examples.md.ejs

[bpmutter]

@nzakas and @mdjermanovic thank you for the context! i'll try to fill out all the descriptions with this information. will let you know in comments if need any further clarification here.

and regarding:

Note: This page is autogenerated. Any changes made here will go live but will be overwrriten the next time the site is generated. The evergreen changes should be made in this file:

https://github.com/eslint/eslint/blob/main/templates/formatter-examples.md.ejs

at first glance, i understand what's going on with the template conceptually, but am not sure how i'd add the descriptions to it. will dig in a bit, and let you know if any questions.

if i cannot figure out how to add the descriptions to the template, i'll add them to the markdown file, so we can at least get the copy down before later adding it to the template file.

[bpmutter]

i've updated the code to include descriptions in the templates by adding a _manifest.js file to the source code, which contains the descriptions.

i've also:

• updated the template to include descriptions and changes that were previously made to docs/src/user-guide/formatters/index.md.
• reverted the changes to docs/src/user-guide/formatters/index.md since the page is generated.

generate the output as expected, you can run npm run gensite.

i'm not convinced that using the _manifest.js file as is done here is the best approach for including descriptions from the source code, even if it is effective. i look forward to the maintainer team's feedback on if/how to refactor this.

[nzakas]

Because this is just data, can we just create a JSON file here? I'd call it formatter-data.json and you'd still be able to require() it, but would otherwise be ignored.

[bpmutter]

sgtm, i like this approach

[bpmutter]

@nzakas implemented w the file named formatter-meta.json to align w the file naming convention of rules-meta.json

[nzakas]

LGTM. Would like @mdjermanovic to review before merging.

[bpmutter]

@mdjermanovic ready for re-review!

[mdjermanovic]

LGTM, thanks!