chore(prettier): [RO-26549] Added Prettier #82
Conversation
| 'controllers/', | ||
| 'runtime/' | ||
| ]); | ||
| ioc.registerFolders(__dirname, ['controllers/', 'runtime/']); |
There was a problem hiding this comment.
Not so much for this one, but in harness, can we please not rewrite the examples in markdown? This is not code so it's optimized for reading in the doc
There was a problem hiding this comment.
This was formatted by Prettier. .md files could be ignored but then you lose some of the benefits like table formatting, and consistency across .md files in the repo.
I'm not convinced this is an issue. Depending the formatting setup of the target repo that you're copy/pasting into, it would get reformatted anyway right? i.e. If this was left unchanged and you pasted the example code into a repo using Prettier, it would be format like this.
There was a problem hiding this comment.
This is a public repo, it's for readability since we don't impose our formatting on anyone.
| @@ -152,7 +146,7 @@ To see the latest list of the default dependencies that are injected, check out | |||
| List of external dependencies used and exposed by spur-web. They can be found at npmjs.org using their original names. | |||
|
|
|||
| | Name | Original Module Name | | |||
| | :---- | :---- | | |||
| | :----------------- | :--------------------------------------------------------------- | | |||
There was a problem hiding this comment.
Did prettier add these? :---- is a markdown shortcut to make it dynamic and not have to keep track of the length as you write. Can you please revert?
There was a problem hiding this comment.
Prettier handles this, updates with every edit when you save, no need to update manually. Also, the spacing was previously being done manually, but using instead of -
| @@ -68,6 +68,7 @@ | |||
| "eslint": "8.42.0", | |||
| "eslint-plugin-node": "11.1.0", | |||
| "jest": "29.7.0", | |||
| "prettier": "3.2.5", | |||
There was a problem hiding this comment.
Just realized that this is another dependency we will need to maintain. I also often see warnings from them that require constant version updates.
Should we reconsider?
There was a problem hiding this comment.
It's just a dev dependency so I would think it's easy to maintain especially with renovate doing the heavy-lifting
There was a problem hiding this comment.
It's the publishing it, then publishing harness-web steps.
Not heavy lifting but adds a distraction to a set of packages going into maintenance.
Ticket
https://opentable.atlassian.net/browse/RO-26549
Change Summary
This PR will add Prettier and format all files (using
npx prettier --write *, which leverages.editorconfig). It also simplifies the lint configs by removing all rules that are either "controlled" by Prettier or don't need to be overwritten because no violations exist.NOTE: Lint config files where renamed to specifically include
.jsonbecause Prettier added trailing commas to them and neither.editorconfigor Prettier have settings to disable this for.*rcfiles, but Prettier doesn't add trailing commas to.jsonfiles because it's not supported for the language. A.prettierignorecould be added to ignore them, but then they wouldn't get formatted at all.