chore: add comments on pr suggesting formatting (#181)

* chore: add comments on pr suggesting formatting

This commit adds a step to the lua-format-check-pr job that will leave a
comment with "suggested changes" when formatting needs to be applied.
This can then be applied with one click (per file).

Alternatively, I could change it to automattically add a commit that
formats the code. Several PRs have gotten through without proper
formatting, which makes all future PRs fail the checks.

* fix: add styluaignore to protect third_party submodule

* fix: permissions in workflow

* fix: fail_on_error

* chore: apply formatting

.github/workflows/lua-format-check-pr.yml

@@ -3,6 +3,11 @@ on:
   pull_request:
     paths:
       - "**.lua"
+permissions:
+  contents: read
+  checks: write
+  issues: write
+  pull-requests: write
 jobs:
   format_code:
     runs-on: ubuntu-latest
@@ -12,4 +17,9 @@ jobs:
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           version: latest
-          args: --check .
+          args: .
+      - name: suggester
+        uses: reviewdog/action-suggester@v1
+        with:
+          tool_name: stylua
+          fail_on_error: true

.styluaignore

@@ -0,0 +1 @@
+lua/tabnine/third_party/

lua/tabnine/binary.lua

@@ -72,7 +72,7 @@ function TabnineBinary:start()
 			"ide-restart-counter=" .. self.restart_counter,
 			"pluginVersion=" .. consts.plugin_version,
 			"--tls_config",
-			"insecure=" .. tostring(config.ignore_certificate_errors)
+			"insecure=" .. tostring(config.ignore_certificate_errors),
 		}, optional_args()),
 		stdio = { self.stdin, self.stdout, self.stderr },
 	}, function()