Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
glepnir committed Feb 5, 2025
1 parent a72ab52 commit 938f75f
Show file tree
Hide file tree
Showing 12 changed files with 1,485 additions and 154 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,12 @@ jobs:
- name: panvimdoc
uses: kdheepak/panvimdoc@main
with:
vimdoc: nvim-plugin-template.nvim
vimdoc: fpkit.nvim
treesitter: true
- uses: stefanzweifel/git-auto-commit-action@v4
with:
commit_message: "chore(doc): auto generate docs"
commit_user_name: "github-actions[bot]"
commit_user_email: "github-actions[bot]@users.noreply.github.com"
commit_author: "github-actions[bot] <github-actions[bot]@users.noreply.github.com>"
y.github.com>"
33 changes: 3 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,6 @@
# nvim-plugin-template
# FPKit.nvim

Neovim plugin template; includes automatic documentation generation from README, integration tests with Busted, and linting with Stylua

## 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 `plugin-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 looking at this template for the first time I suggest you inspect the contents. After this step `rename.py` will also auto-remove.

Now you have a clean plugin environment. Enjoy!

## Format

The CI uses `stylua` to format the code; customize the formatting by editing `.stylua.toml`.

## Test

See [Running tests locally](https://github.com/nvim-neorocks/nvim-busted-action?tab=readme-ov-file#running-tests-locally)

## CI

- Auto generates doc from README.
- Runs the [nvim-busted-action](https://github.com/nvim-neorocks/nvim-busted-action) for test.
- Lints with `stylua`.

## More

To see this template in action, take a look at my other plugins.
include the nvimdev/dired.nvim and nvimdev/fnpairs.nvim and more others in
future

## License MIT
60 changes: 0 additions & 60 deletions doc/nvim-plugin-template.nvim.txt

This file was deleted.

Loading

0 comments on commit 938f75f

Please sign in to comment.