feat: init project

jellydn · Oct 21, 2023 · 0207117 · 0207117
1 parent a868912
commit 0207117
Show file tree

Hide file tree

Showing 8 changed files with 11 additions and 79 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -24,7 +24,7 @@ jobs:
       - name: panvimdoc
         uses: kdheepak/panvimdoc@main
         with:
-          vimdoc: nvim-plugin-template
+          vimdoc: hurl.nvim
           treesitter: true
       - uses: stefanzweifel/git-auto-commit-action@v4
         with:
@@ -61,3 +61,4 @@ jobs:
           luarocks install luacheck
           luarocks install vusted
           vusted ./test
+ted ./test
diff --git a/README.md b/README.md
@@ -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!
diff --git a/doc/nvim-plugin-template.txt → doc/hurl.nvim.txt b/doc/nvim-plugin-template.txt → doc/hurl.nvim.txt
diff --git a/plugin/nvim-plugin-template.lua → lua/hurl.nvim/init.lua b/plugin/nvim-plugin-template.lua → lua/hurl.nvim/init.lua
diff --git a/lua/nvim-plugin-template/init.lua b/lua/nvim-plugin-template/init.lua
diff --git a/plugin/hurl.nvim.lua b/plugin/hurl.nvim.lua
diff --git a/rename.py b/rename.py
diff --git a/test/plugin_spec.lua b/test/plugin_spec.lua
@@ -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)