docs: add readme

.github/workflows/linter.yml → .github/workflows/typecheck.yml

@@ -1,5 +1,5 @@
 ---
-name: Lint Code Base
+name: Type Check Code Base
 on:
   pull_request: ~
   push:
@@ -8,14 +8,14 @@ on:
 
 jobs:
   build:
-    name: Lint Code Base
+    name: Type Check Code Base
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout Code
         uses: actions/checkout@v3
 
-      - name: Lint Code Base
+      - name: Type Check Code Base
         uses: ./
         with:
           configpath: ".luarc.json"

README.md

@@ -0,0 +1,114 @@
+# Sumneko lua-language-server lint action
+
+A GitHub action that lets you leverage sumneko [`lua-language-server`](https://github.com/sumneko/lua-language-server)
+and [EmmyLua](https://emmylua.github.io/annotation.html) to statically type check lua code.
+
+## Introduction
+
+What I found the most frustrating about developing Neovim plugins in Lua is the lack
+of type safety.
+
+When I [added](https://github.com/mrcjkb/haskell-tools.nvim/pull/103/files) some EmmyLua
+docs to one of my plugins (to generate Vimdoc using [`lemmy-help`](https://github.com/numToStr/lemmy-help)),
+I noticed `lua-language-server` was giving me diagnostics based on my documentation.
+This was something I was not getting from linters like `luacheck`.
+So I asked myself, "Can I leverage `lua-language-server` and EmmyLua to statically type check my Lua code?"
+
+The result is this GitHub action, which type checks itself.
+
+## Usage
+
+Create `.github/workflows/typecheck.yml` in your repository with the following contents:
+
+```yaml
+---
+name: Type Check Code Base
+on:
+  pull_request: ~
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    name: Type Check Code Base
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+
+      - name: Type Check Code Base
+        uses: mrcjkb/sumneko-lint-action/v0.1.0
+```
+
+## Inputs
+
+The following optional inputs can be specified using `with:`
+
+### `checklevel`
+
+The diagnostics severity level to fail on. One of:
+
+* `Error`
+* `Warning` (default)
+* `Information`
+* `Hint`
+
+Example:
+
+```yaml
+- name: Type Check Code Base
+  uses: mrcjkb/sumneko-lint-action/v0.1.0
+  with:
+    checkLevel: Error
+```
+
+### `directories`
+
+Directories to lint (relative to the repostitory root).
+Defaults to the repository root if none are specified.
+
+Example:
+
+```yaml
+- name: Type Check Code Base
+  uses: mrcjkb/sumneko-lint-action/v0.1.0
+  with:
+    directories: |
+     lua
+     tests
+```
+
+### `configpath`
+
+Path to a [`.luarc.json`](https://github.com/sumneko/lua-language-server/wiki/Configuration-File#luarcjson) (relative to the repository root).
+
+Example:
+
+```yaml
+- name: Type Check Code Base
+  uses: mrcjkb/sumneko-lint-action/v0.1.0
+  with:
+    configpath: ".luarc.json"
+```
+
+### `copy_directories`
+
+Directories in the source directory to be copied to the rock installation prefix as-is. Useful for installing documentation and other files such as samples and tests.
+
+Example to specify additional directories:
+
+```yaml
+- name: Luarocks Upload
+  uses: mrcjkb/luarocks-tag-release@master
+  with:
+    copy_directories: |
+      doc
+      plugin
+```
+
+## Can I use this with a non-GPLv2 licensed project?
+
+Yes.
+Because it is not distributed with any binaries, you can use it in any project.