style-check and style-fix do not agree

[alex-courtis]

style-check finds most but not all formatting problems that style-fix does.

There are outstanding style issues that result in style-fix reformatting files outside of the scope of the change e.g. #3261

Replication at 516f95e

make style-check

OK

make style-fix

files changed

git diff --name-only
lua/nvim-tree/_meta/api/decorator.lua
lua/nvim-tree/_meta/api/decorator_example.lua
lua/nvim-tree/_meta/config/renderer.lua

Options:

1. Try to fix the issue with style-check luals call. May be difficult as style-fix uses a different tool CodeFormat
2. Add a test similar to help-check that runs style-fix and fails on diffs

[alex-courtis]

CodeFormat check --config .editorconfig --workspace lua --diagnosis-as-error picks up "real" errors such as indentation, which style-check does pick up.

Above does not pick up trailing spaces, which seems to be the only difference between CodeFormat format and CodeFormat check.

CodeFormat only operates with .editorconfig and lua-language-server only operates with .luarc.json

There does not appear to be an editorconfig option for trailing space for CodeFormat: https://github.com/CppCXY/EmmyLuaCodeStyle/blob/master/lua.template.editorconfig

With the combination of luacheck and luals check, whitespace at end of line is detected and flagged for code lines. The only apparent exception is whitespace at the end of comment lines. There may, however, be others.

[alex-courtis]

lua_language_server looks to soon be replaced by https://github.com/EmmyLuaLs/emmylua-analyzer-rust and some plugins have already done so. Informal testing shows it's not ready.

emmylua-analyzer-rust still uses CodeFormat (same author) thus will be an issue going forward.

Recommendation: option 2