Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add formatters page #16018

Closed
wants to merge 3 commits into from
Closed

Conversation

amareshsm
Copy link
Member

Prerequisites checklist

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:
Ref: #16009

What changes did you make? (Give an overview)

Added formaters page

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

@eslint-github-bot eslint-github-bot bot added triage An ESLint team member will look at this issue soon feature This change adds a new feature to ESLint labels Jun 17, 2022
@netlify
Copy link

netlify bot commented Jun 17, 2022

Deploy Preview for docs-eslint ready!

Name Link
🔨 Latest commit 6a8b10f
🔍 Latest deploy log https://app.netlify.com/sites/docs-eslint/deploys/62b21565f74cd10008cadbcf
😎 Deploy Preview https://deploy-preview-16018--docs-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@nzakas
Copy link
Member

nzakas commented Jun 20, 2022

In the current release process, we generate this file by using the actual formatters. Given that we aren't adding any new formatters, maybe it's not worth doing that....@eslint/eslint-tsc thoughts on that?

In the meantime, there are some linting errors in the file.

@eslint-github-bot eslint-github-bot bot added the chore This change is not user-facing label Jun 20, 2022
@amareshsm amareshsm marked this pull request as ready for review June 20, 2022 19:55
@mdjermanovic
Copy link
Member

In the current release process, we generate this file by using the actual formatters. Given that we aren't adding any new formatters, maybe it's not worth doing that....@eslint/eslint-tsc thoughts on that?

I agree. If it turns out at some point that it would be useful to autogenerate this page again, we could implement that later.


### html

<iframe src="html-formatter-example.html" width="100%" height="460px"></iframe>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can just copy-paste that file from the current website:

https://github.com/eslint/website/blob/master/docs/user-guide/formatters/html-formatter-example.html

And we could keep the same structure:

docs/src/user-guide/formatters/index.md
docs/src/user-guide/formatters/html-formatter-example.html

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@mdjermanovic mdjermanovic added documentation Relates to ESLint's documentation accepted There is consensus among the team that this change meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon feature This change adds a new feature to ESLint labels Jun 20, 2022
@mdjermanovic mdjermanovic linked an issue Jun 20, 2022 that may be closed by this pull request
@nzakas nzakas mentioned this pull request Jun 21, 2022
1 task
@nzakas
Copy link
Member

nzakas commented Jun 21, 2022

Closing in favor of #16036

@nzakas nzakas closed this Jun 21, 2022
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Dec 19, 2022
@eslint-github-bot eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Dec 19, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion chore This change is not user-facing documentation Relates to ESLint's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[new docs site] Add Formatters page
3 participants