superrob1500
/
mirror-ghostty
mirror of https://github.com/ghostty-org/ghostty
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update linting doc

pull/577/head
Patrick Fong 2023-09-28 11:20:48 -07:00
parent 6bceea898b
commit 4f6401e815
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -395,11 +395,11 @@ $ sudo log stream --level debug --predicate 'subsystem=="com.mitchellh.ghostty"'
### Linting
Ghostty's docs and resources (not including Zig code) are linted using [Prettier](https://prettier.io) with out-of-the-box settings. A Prettier CI check will fail builds with improper formatting. Therefore, if you are modifying anything Prettier will lint, you may want to install it locally and run this from the repo root
Ghostty's docs and resources (not including Zig code) are linted using [Prettier](https://prettier.io) with out-of-the-box settings. A Prettier CI check will fail builds with improper formatting. Therefore, if you are modifying anything Prettier will lint, you may want to install it locally and run this from the repo root before you commit:
```
npm install -g prettier
prettier --write .
```
before you commit. Or simply install one of the many Prettier extensions out there for your editor of choice.
Or simply install one of the many Prettier extensions out there for your editor of choice.