mirror of
https://codeberg.org/comaps/comaps
synced 2025-12-19 04:53:36 +00:00
[tools] Remove prettier script and create doc formatter
Signed-off-by: Jean-Baptiste <jeanbaptiste.charron@outlook.fr>
This commit is contained in:
12
docs/FORMATTER.md
Normal file
12
docs/FORMATTER.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# C++/Java formatter
|
||||
|
||||
We use [Clang format](https://clang.llvm.org/docs/ClangFormat.html) to format C++ and Java files.
|
||||
To format code, run `./tools/unix/clang-format.sh`
|
||||
|
||||
# Markdown formatter
|
||||
|
||||
We use [Prettier](https://github.com/prettier/prettier) to format Markdown and yaml files.
|
||||
To format files:
|
||||
- `npm install prettier`
|
||||
- `prettier --write README.md docs/*.md tools/python/**/*.md`
|
||||
- `prettier --write .prettierrc.yaml .forgejo/**/*.yaml .forgejo/*.yml`
|
||||
Reference in New Issue
Block a user