Skip to content

Commit

Permalink
feat(ci): Enabled llscheck.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
@ColinKennedy
ColinKennedy committed Oct 26, 2024
1 parent afa4871 commit 18273bf
Show file tree
Hide file tree
Showing 5 changed files with 61 additions and 14 deletions.
14 changes: 6 additions & 8 deletions .github/workflows/.luarc.json
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
{
"Lua.diagnostics.libraryFiles": "Disable",
"Lua.workspace.checkThirdParty": "Disable",
"Lua.workspace.library": [
"/home/runner/work/nvim-best-practices-plugin-template/nvim-best-practices-plugin-template/.dependencies/neovim/runtime/lua",
"/home/runner/work/nvim-best-practices-plugin-template/nvim-best-practices-plugin-template/.dependencies/neodev.nvim/types/stable",
"/home/runner/work/nvim-best-practices-plugin-template/nvim-best-practices-plugin-template/.dependencies/busted/library",
"/home/runner/work/nvim-best-practices-plugin-template/nvim-best-practices-plugin-template/.dependencies/luassert/library"
"diagnostics.globals": [
"vim"
],
"diagnostics.libraryFiles": "Disable",
"runtime.version": "LuaJIT",
"workspace.checkThirdParty": "Disable"
"workspace.checkThirdParty": "Disable",
"workspace.ignoreDir": [".lua", ".luarocks"],
"workspace.library": ["$PWD/.dependencies"]
}
48 changes: 48 additions & 0 deletions .github/workflows/llscheck.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: llscheck

on:
pull_request:
types: [opened, synchronize, reopened, ready_for_review]
branches:
- main
push:
branches:
- main

jobs:
llscheck:
runs-on: ubuntu-latest
name: llscheck

steps:
- uses: actions/checkout@master
with:
submodules: true # Ensure submodules are checked out

- name: Update Submodules
run: git submodule update --init --recursive

- uses: leafo/gh-actions-lua@v10
with:
# Neovim is compiled with LuaJIT so we might as well match. But it
# doesn't look like we can match it exactly.
#
# Reference:
# https://github.com/leafo/gh-actions-lua/issues/49#issuecomment-2295071198
#
luaVersion: "luajit-openresty"

- name: Install lua-language-server
uses: jdx/mise-action@v2
with:
tool_versions: |
lua-language-server latest
- uses: leafo/gh-actions-luarocks@v4
- name: Install llscheck
run: |
luarocks install llscheck
- name: test
run: |
llscheck --configpath .github/workflows/.luarc.json .
10 changes: 5 additions & 5 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# A Neovim Plugin Template

| <!-- --> | <!-- --> |
|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Build Status | [![Unittests](https://img.shields.io/github/actions/workflow/status/ColinKennedy/nvim-best-practices-plugin-template/test.yml?branch=main&style=for-the-badge&label=Unittests)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/actions/workflows/test.yml) [![Documentation](https://img.shields.io/github/actions/workflow/status/ColinKennedy/nvim-best-practices-plugin-template/documentation.yml?branch=main&style=for-the-badge&label=Documentation)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/actions/workflows/documentation.yml) [![Luacheck](https://img.shields.io/github/actions/workflow/status/ColinKennedy/nvim-best-practices-plugin-template/luacheck.yml?branch=main&style=for-the-badge&label=Luacheck)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/actions/workflows/luacheck.yml) [![Stylua](https://img.shields.io/github/actions/workflow/status/ColinKennedy/nvim-best-practices-plugin-template/stylua.yml?branch=main&style=for-the-badge&label=Stylua)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/actions/workflows/stylua.yml) |
| License | [![License-MIT](https://img.shields.io/badge/License-MIT-blue?style=for-the-badge)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/blob/main/LICENSE) |
| Social | [![RSS](https://img.shields.io/badge/rss-F88900?style=for-the-badge&logo=rss&logoColor=white)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commits/main/doc/news.txt.atom) |
| <!-- --> | <!-- --> |
|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Build Status | [![unittests](https://img.shields.io/github/actions/workflow/status/ColinKennedy/nvim-best-practices-plugin-template/test.yml?branch=main&style=for-the-badge&label=Unittests)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/actions/workflows/test.yml) [![documentation](https://img.shields.io/github/actions/workflow/status/ColinKennedy/nvim-best-practices-plugin-template/documentation.yml?branch=main&style=for-the-badge&label=Documentation)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/actions/workflows/documentation.yml) [![luacheck](https://img.shields.io/github/actions/workflow/status/ColinKennedy/nvim-best-practices-plugin-template/luacheck.yml?branch=main&style=for-the-badge&label=Luacheck)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/actions/workflows/luacheck.yml) [![llscheck](https://img.shields.io/github/actions/workflow/status/ColinKennedy/nvim-best-practices-plugin-template/llscheck.yml?branch=main&style=for-the-badge&label=llscheck)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/actions/workflows/llscheck.yml) [![stylua](https://img.shields.io/github/actions/workflow/status/ColinKennedy/nvim-best-practices-plugin-template/stylua.yml?branch=main&style=for-the-badge&label=Stylua)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/actions/workflows/stylua.yml) |
| License | [![License-MIT](https://img.shields.io/badge/License-MIT-blue?style=for-the-badge)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/blob/main/LICENSE) |
| Social | [![RSS](https://img.shields.io/badge/rss-F88900?style=for-the-badge&logo=rss&logoColor=white)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commits/main/doc/news.txt.atom) |

A template repository used to create Neovim plugins.

Expand Down
2 changes: 1 addition & 1 deletion doc/news.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Notable changes since PluginTemplate 1.0
===============================================================================
NEW FEATURES *plugin-template-new-features*

We're live!
Added llscheck.yml - A GitHub workflow that detects type annotation issues!


===============================================================================
Expand Down
1 change: 1 addition & 0 deletions lua/plugin_template/types.lua
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@
--- Should write to a file.
---@field output_path string?
--- The default path on-disk where log files will be written to.
--- Defaults to "/home/selecaoone/.local/share/nvim/plugin_name.log".

---@class plugin_template.ConfigurationGoodnightMoonRead
--- The default values when a user calls `:PluginTemplate goodnight-moon read`.
Expand Down

0 comments on commit 18273bf

Please sign in to comment.