generated from nvimdev/nvim-plugin-template
-
-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge main into sweep/add-sweep-config
- Loading branch information
Showing
8 changed files
with
11 additions
and
79 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,14 @@ | ||
# nvim-plugin-template | ||
neovim plugin template integration test and doc publish | ||
<h1 align="center">Welcome to hurl.nvim 👋</h1> | ||
<p> | ||
TBD | ||
</p> | ||
|
||
## Usage | ||
|
||
1. click `use this template` button generate a repo on your github. | ||
2. clone your plugin repo.open terminal then cd plugin directory. | ||
3. run `python3 rename.py your-plugin-name` this will replace all `nvim-plugin-template` to your `pluing-name`. | ||
then it will prompt you input `y` or `n` to remove example codes in `init.lua` and | ||
`test/plugin_spec.lua`. if you are familiar this repo just input y. if you are first look at this | ||
template I suggest you look at them first. after these step the `rename.py` will also auto | ||
remove. | ||
```sh | ||
TBD | ||
``` | ||
|
||
now you have a clean plugin env . enjoy! | ||
## Show your support | ||
|
||
## Format | ||
|
||
format use `stylua` and provide `.stylua.toml`. | ||
|
||
## Test | ||
use vusted for test install by using `luarocks --lua-version=5.1 install vusted` then run `vusted test` | ||
for your test cases. | ||
|
||
create test case in test folder file rule is `foo_spec.lua` with `_spec` more usage please check | ||
[busted usage](https://lunarmodules.github.io/busted/) | ||
|
||
## Ci | ||
Ci support auto generate doc from README and integration test and lint check by `stylua`. | ||
|
||
|
||
## More | ||
Other usage you can look at my plugins | ||
|
||
## License MIT | ||
Give a ⭐️ if this project helped you! |
File renamed without changes.
File renamed without changes.
This file was deleted.
Oops, something went wrong.
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +0,0 @@ | ||
local example = require('nvim-plugin-template').example | ||
|
||
describe('neovim plugin', function() | ||
it('work as expect', function() | ||
local result = example() | ||
assert.is_true(result) | ||
end) | ||
end) | ||