Skip to content

Commit

Permalink
feat(dependencies): moved cmdparse + logging out
Browse files Browse the repository at this point in the history 
mega.cmdparse and mega.logging have their own repositories now. All
unittests and boilerplate code has been moved too
  • Loading branch information
@ColinKennedy
ColinKennedy committed Dec 13, 2024
1 parent 9e64a5a commit 73076f8
Show file tree
Hide file tree
Showing 42 changed files with 91 additions and 8,927 deletions.
1 change: 1 addition & 0 deletions .github/workflows/.luarc.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"$PWD/.dependencies/busted/library",
"$PWD/.dependencies/luassert/library",
"$PWD/.dependencies/luvit-meta/library",
"$PWD/.dependencies/mega.cmdparse/lua",
"$VIMRUNTIME/lua"
]
}
18 changes: 17 additions & 1 deletion .github/workflows/llscheck.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,22 @@ jobs:
repository: "Bilal2453/luvit-meta"
path: ".dependencies/luvit-meta"

- name: test
- name: Clone dependencies - mega.cmdparse
uses: actions/checkout@v4
with:
repository: "ColinKennedy/mega.cmdparse"
path: ".dependencies/mega.cmdparse"

- name: Clone dependencies - mega.logging
uses: actions/checkout@v4
with:
repository: "ColinKennedy/mega.logging"
path: ".dependencies/mega.logging"

- name: Print Version
run: |
lua-language-server --version
- name: Test
run: |
VIMRUNTIME=`nlua -e 'io.write(os.getenv("VIMRUNTIME"))'` llscheck --configpath .github/workflows/.luarc.json .
1 change: 1 addition & 0 deletions .luarc.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
"$PWD/.dependencies/busted/library",
"$PWD/.dependencies/luassert/library",
"$PWD/.dependencies/luvit-meta/library",
"$PWD/.dependencies/mega.cmdparse/lua",
"$VIMRUNTIME/lua"
]
}
1 change: 1 addition & 0 deletions Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ else
endif

clone_git_dependencies:
git clone git@github.com:ColinKennedy/mega.cmdparse.git .dependencies/mega.cmdparse $(IGNORE_EXISTING)
git clone git@github.com:LuaCATS/busted.git .dependencies/busted $(IGNORE_EXISTING)
git clone git@github.com:LuaCATS/luassert.git .dependencies/luassert $(IGNORE_EXISTING)
git clone git@github.com:Bilal2453/luvit-meta.git .dependencies/luvit-meta $(IGNORE_EXISTING)
Expand Down
10 changes: 5 additions & 5 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# A Neovim Plugin Template

A template repository used to create Neovim plugins.

| <!-- --> | <!-- --> |
|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 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) [![urlchecker](https://img.shields.io/github/actions/workflow/status/ColinKennedy/nvim-best-practices-plugin-template/urlchecker.yml?branch=main&style=for-the-badge&label=URLChecker)](https://github.com/ColinKennedy/nvim-best-practices-plugin-template/actions/workflows/urlchecker.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.


# Features
- Follows [nvim-best-practices](https://github.com/nvim-neorocks/nvim-best-practices)
Expand Down Expand Up @@ -56,6 +56,7 @@ A template repository used to create Neovim plugins.
```lua
{
"ColinKennedy/nvim-best-practices-plugin-template",
dependencies = { "ColinKennedy/mega.cmdparse", "ColinKennedy/mega.logging" },
-- TODO: (you) - Make sure your first release matches v1.0.0 so it auto-releases!
version = "v1.*",
}
Expand All @@ -73,9 +74,6 @@ A template repository used to create Neovim plugins.
"ColinKennedy/nvim-best-practices-plugin-template",
config = function()
vim.g.plugin_template_configuration = {
cmdparse = {
auto_complete = { display = { help_flag = true } },
},
commands = {
goodnight_moon = { read = { phrase = "A good book" } },
hello_world = {
Expand Down Expand Up @@ -232,6 +230,7 @@ Run test based on tags
busted --helper spec/minimal_init.lua . --tags=simple
```


# Tracking Updates
See [doc/news.txt](doc/news.txt) for updates.

Expand All @@ -240,6 +239,7 @@ You can watch this plugin for changes by adding this URL to your RSS feed:
https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commits/main/doc/news.txt.atom
```


# Other Plugins
This template is full of various features. But if your plugin is only meant to
be a simple plugin and you don't want the bells and whistles that this template
Expand Down
3 changes: 0 additions & 3 deletions doc/plugin-template.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,6 @@ A template repository used to create Neovim plugins.
"ColinKennedy/nvim-best-practices-plugin-template",
config = function()
vim.g.plugin_template_configuration = {
cmdparse = {
auto_complete = { display = { help_flag = true } },
},
commands = {
goodnight_moon = { read = { phrase = "A good book" } },
hello_world = {
Expand Down
18 changes: 0 additions & 18 deletions doc/plugin_template_types.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,31 +10,13 @@ operation of this Lua plugin.
The user's customizations for this plugin.

Fields ~
{cmdparse} plugin_template.ConfigurationCmdparse?
All settings that control the command mode tools (parsing, auto-complete, etc).
{commands} plugin_template.ConfigurationCommands?
Customize the fallback behavior of all `:PluginTemplate` commands.
{logging} plugin_template.LoggingConfiguration?
Control how and which logs print to file / Neovim.
{tools} plugin_template.ConfigurationTools?
Optional third-party tool integrations.

------------------------------------------------------------------------------
*plugin_template.ConfigurationCmdparse*
All settings that control the command mode tools (parsing, auto-complete, etc).

Fields ~
{auto_complete} plugin_template.ConfigurationCmdparseAutoComplete
The settings that control what happens during auto-completion.

------------------------------------------------------------------------------
*plugin_template.ConfigurationCmdparseAutoComplete*
The settings that control what happens during auto-completion.

Fields ~
{display} {help_flag: `(boolean})`
help_flag = Show / Hide the --help flag during auto-completion.

------------------------------------------------------------------------------
*plugin_template.ConfigurationCommands*
Customize the fallback behavior of all `:PluginTemplate` commands.
Expand Down
2 changes: 0 additions & 2 deletions doc/tags
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ plugin-template-tracking-updates plugin-template.txt /*plugin-template-tracking-
plugin-template-using-this-template plugin-template.txt /*plugin-template-using-this-template*
plugin-template.txt plugin-template.txt /*plugin-template.txt*
plugin_template.Configuration plugin_template_types.txt /*plugin_template.Configuration*
plugin_template.ConfigurationCmdparse plugin_template_types.txt /*plugin_template.ConfigurationCmdparse*
plugin_template.ConfigurationCmdparseAutoComplete plugin_template_types.txt /*plugin_template.ConfigurationCmdparseAutoComplete*
plugin_template.ConfigurationCommands plugin_template_types.txt /*plugin_template.ConfigurationCommands*
plugin_template.ConfigurationGoodnightMoon plugin_template_types.txt /*plugin_template.ConfigurationGoodnightMoon*
plugin_template.ConfigurationGoodnightMoonRead plugin_template_types.txt /*plugin_template.ConfigurationGoodnightMoonRead*
Expand Down
Loading

0 comments on commit 73076f8

Please sign in to comment.