diff --git a/README.md b/README.md index 9159079..98aff41 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,10 @@ click `use this template` button generate a repo on your github. then clone your terminal then cd plugin directory , run `python3 rename.py your-plugin-name` this will replace all `nvim-plugin-template` to your `pluing-name`. Then develope your plugin. Enjoy! +## 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. @@ -15,7 +19,7 @@ create test case in test folder file rule is `foo_spec.lua` with `_spec` more us [busted usage](https://lunarmodules.github.io/busted/) ## Ci -Ci support auto generate doc from README and integration test. +Ci support auto generate doc from README and integration test and lint check by `stylua`. ## More