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

Run prettier on website dir #893

Merged
merged 2 commits into from Nov 12, 2019
Merged

Run prettier on website dir #893

merged 2 commits into from Nov 12, 2019

Conversation

mbenadda
Copy link
Contributor

Purpose

We were not running prettier on the JS and JSON files in the website directory, and had no CI job to do that.

Proposal

  • add a CI job for prettier linting on the website dir
  • run prettier write on the website dir to fix existing issues

@mbenadda mbenadda added needs review docs website Tasks related to the documentation website. labels Nov 12, 2019
@mbenadda mbenadda requested a review from lunika November 12, 2019 10:02
@mbenadda mbenadda self-assigned this Nov 12, 2019
Copy link
Member

@lunika lunika left a comment

Choose a reason for hiding this comment

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

You should add tasks in the Makefile to lint the website too

@mbenadda
Copy link
Contributor Author

I don't think it's worth it as we don't have an image that operates on the website directory.

This can probably be done if/when someone enables docker for the other website related tasks like building it, running it etc.

We were not running prettier on the JS and JSON files in the
website directory, and had no CI job to do that. This can cause
ambiguity in formatting, which we resolved in the codebase by
just running prettier.

Add a CI job to lint the website dir with prettier.
We just added a prettier linting job for the website in our CI. To
pass it in the first place, it's necessary to just run prettier in
write mode over the directory.
@mbenadda
Copy link
Contributor Author

(I added a comment to this effect on #870)

@mbenadda mbenadda merged commit 411017f into master Nov 12, 2019
@mbenadda mbenadda deleted the run-prettier-on-website-dir branch November 12, 2019 16:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs website Tasks related to the documentation website. needs review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants