mirror of
https://codeberg.org/comaps/comaps
synced 2025-12-19 13:03: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:
4
.gitignore
vendored
4
.gitignore
vendored
@@ -188,10 +188,6 @@ tools/python/maps_generator/var/etc/map_generator.ini
|
|||||||
tools/python/routing/etc/*.ini
|
tools/python/routing/etc/*.ini
|
||||||
tools/unix/maps/settings.sh
|
tools/unix/maps/settings.sh
|
||||||
|
|
||||||
# Helpers
|
|
||||||
/node_modules/
|
|
||||||
/package-lock.json
|
|
||||||
|
|
||||||
# Visual Studio
|
# Visual Studio
|
||||||
.vs
|
.vs
|
||||||
|
|
||||||
|
|||||||
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`
|
||||||
15
package.json
15
package.json
@@ -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"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Reference in New Issue
Block a user