chore(#3271): add new format-check, rename style-fix to format-fix

Author: alex-courtis

.github/workflows/ci.yml

@@ -77,6 +77,8 @@ jobs:
 
       - run: make style-doc
 
+      - run: make format-check
+
       - name: build Nvim from source
         run: |
           mkdir -p "${DIR_NVIM_SRC}"

CONTRIBUTING.md

@@ -15,7 +15,9 @@ markdown-toc --maxdepth=2 -i CONTRIBUTING.md
 - [Quality](#quality)
   * [lint](#lint)
   * [style](#style)
+  * [format-fix](#format-fix)
   * [check](#check)
+  * [format-check](#format-check)
 - [Diagnostics](#diagnostics)
 - [Backwards Compatibility](#backwards-compatibility)
 - [:help Documentation](#help-documentation)
@@ -36,10 +38,10 @@ Language server: [luals](https://luals.github.io)
 
 Lint: [luacheck](https://github.com/lunarmodules/luacheck/)
 
-Style Fixing: [EmmyLuaCodeStyle](https://github.com/CppCXY/EmmyLuaCodeStyle): `CodeCheck`
-
 nvim-tree.lua migrated from stylua to EmmyLuaCodeStyle ~2024/10. `vim.lsp.buf.format()` may be used as it is the default formatter for luals, using an embedded [EmmyLuaCodeStyle](https://github.com/CppCXY/EmmyLuaCodeStyle)
 
+Formatting: [EmmyLuaCodeStyle](https://github.com/CppCXY/EmmyLuaCodeStyle): `CodeFormat` executable
+
 You can install them via you OS package manager e.g. `pacman`, `brew` or other via other package managers such as `cargo` or `luarocks`
 
 # Quality
@@ -67,10 +69,12 @@ make lint
 make style
 ```
 
-You can automatically fix style issues using `CodeCheck`:
+## format-fix
+
+You can automatically fix most style issues using `CodeFormat`:
 
 ```sh
-make style-fix
+make format-fix
 ```
 
 ## check
@@ -96,6 +100,17 @@ curl -L "https://github.com/LuaLS/lua-language-server/releases/download/3.15.0/l
 PATH="luals/bin:${PATH}" make check
 ```
 
+## format-check
+
+This is run in CI. Commit or stage your changes and run:
+
+```sh
+make format-check
+```
+
+- Re-runs `make format-fix`
+- Checks that `git diff` is empty, to ensure that all content has been generated. This is why a stage or commit is necessary.
+
 # Diagnostics
 
 Diagnostics issues may not be suppressed. See [luals](https://luals.github.io) documentation for details on how to structure the code and comments.

Makefile

@@ -25,11 +25,15 @@ luals:
 	scripts/luals-check.sh
 
 #
-# fixes
+# format
 #
-style-fix:
+format-fix:
 	CodeFormat format --config .editorconfig --workspace lua
 
+format-check:
+	CodeFormat format --config .editorconfig --workspace lua
+	git diff --exit-code lua
+
 #
 # utility
 #
@@ -46,5 +50,5 @@ help-check: help-update
 	git diff --ignore-blank-lines --exit-code doc/nvim-tree-lua.txt
 
 
-.PHONY: all lint style check luacheck style-check style-doc luals style-fix help-update help-check
+.PHONY: all lint style check luacheck style-check style-doc luals format-fix format-check help-update help-check