[tools] Remove prettier script and create doc formatter

Signed-off-by: Jean-Baptiste <jeanbaptiste.charron@outlook.fr>
This commit is contained in:
Jean-Baptiste
2025-11-22 21:12:01 +01:00
committed by x7z4w
parent 6d89a4346d
commit df1d4bf67e
3 changed files with 12 additions and 19 deletions

4
.gitignore vendored
View File

@@ -188,10 +188,6 @@ tools/python/maps_generator/var/etc/map_generator.ini
tools/python/routing/etc/*.ini
tools/unix/maps/settings.sh
# Helpers
/node_modules/
/package-lock.json
# Visual Studio
.vs

12
docs/FORMATTER.md Normal file
View 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`

View File

@@ -1,15 +0,0 @@
{
"private": true,
"name": "Comaps",
"version": "1.0.0",
"description": "Tools and helpers",
"scripts": {
"format:docs": "prettier --write README.md 'docs/**/*.md' 'tools/python/**/*.md'",
"format:forgejo": "prettier --write '.prettierrc.yaml' '.forgejo/**/*.yaml' '.forgejo/*.yml'"
},
"author": "Alexander Borsuk <me@alex.bio>",
"license": "MIT",
"devDependencies": {
"prettier": "^2.3.0"
}
}