Skip to content

Commit 0ae7fa4

Browse files
momentary-lapseaboitsov
and
aboitsov
authored
Added documentation for code formatting tools (ref #370) (#371)
* Added documentation for code formatting tools (ref #370) * Formatting fix --------- Co-authored-by: aboitsov <[email protected]>
1 parent c7cc2bb commit 0ae7fa4

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

src/contributors/02-local-development.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,36 @@ psql -c 'create database lemmy with owner lemmy;' -U postgres
7575
export LEMMY_DATABASE_URL=postgres://lemmy:password@localhost:5432/lemmy
7676
```
7777

78+
### Code formatting tools
79+
80+
#### Taplo
81+
82+
See installation instructions [here](https://taplo.tamasfe.dev/), or run
83+
84+
```bash
85+
cargo install taplo-cli --locked
86+
```
87+
88+
#### pg_format
89+
90+
Debian-based distro:
91+
92+
```bash
93+
sudo apt install pgformatter
94+
```
95+
96+
Arch-based distro:
97+
98+
```bash
99+
sudo pacman -S pgformatter
100+
```
101+
102+
macOS:
103+
104+
```bash
105+
brew install pgformatter
106+
```
107+
78108
### Get the code
79109

80110
Clone frontend and backend code to local folders. Be sure to include `--recursive` to initialize git submodules.

0 commit comments

Comments
 (0)