From df1d4bf67e1a9f152bcae5f2e6ecfb372bd24b51 Mon Sep 17 00:00:00 2001 From: Jean-Baptiste Date: Sat, 22 Nov 2025 21:12:01 +0100 Subject: [PATCH] [tools] Remove prettier script and create doc formatter Signed-off-by: Jean-Baptiste --- .gitignore | 4 ---- docs/FORMATTER.md | 12 ++++++++++++ package.json | 15 --------------- 3 files changed, 12 insertions(+), 19 deletions(-) create mode 100644 docs/FORMATTER.md delete mode 100644 package.json diff --git a/.gitignore b/.gitignore index 03f25e08e..0af099653 100644 --- a/.gitignore +++ b/.gitignore @@ -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 diff --git a/docs/FORMATTER.md b/docs/FORMATTER.md new file mode 100644 index 000000000..c34f403ca --- /dev/null +++ b/docs/FORMATTER.md @@ -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` diff --git a/package.json b/package.json deleted file mode 100644 index 8aabaa162..000000000 --- a/package.json +++ /dev/null @@ -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 ", - "license": "MIT", - "devDependencies": { - "prettier": "^2.3.0" - } -}