https://github.com/you-n-g/plugin-scaffold.nvim

A template/scaffold/boilerplate to create a new neovim plugin
https://github.com/you-n-g/plugin-scaffold.nvim

boilerplate lua neovim scaffold template template-project

Last synced: 15 days ago
JSON representation

A template/scaffold/boilerplate to create a new neovim plugin

• Host: GitHub
• URL: https://github.com/you-n-g/plugin-scaffold.nvim
• Owner: you-n-g
• Created: 2024-11-09T11:18:19.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-12-04T14:29:56.000Z (about 2 months ago)
• Last Synced: 2024-12-04T15:19:05.275Z (about 2 months ago)
• Topics: boilerplate, lua, neovim, scaffold, template, template-project
• Language: Jinja
• Homepage:
• Size: 20.5 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# A Neovim Lua Plugin Scaffold

This scaffold provides a base template for writing a Neovim plugin using Lua.

It uses [copier](https://github.com/copier-org/copier), allowing you to create your own plugin with the following commands:

```bash

pip install copier

copier copy gh:you-n-g/plugin-scaffold.nvim 

```

The template includes these features:

- Scaffold for Neovim Lua plugins to ease the organization of your code

- panvimdoc: automatically generates Vim docs from the README.md using [panvimdoc](https://github.com/kdheepak/panvimdoc)

- auto-release: automatically generates a changelog and adds version tags based on your commit messages

- test suite

## ⚙️Configuration

You can follow following steps to fully enable the CI process and smooth your release process.

### Configure PAT

- Generate PAT: Your avatar => Settings => Developer settings => Personal access tokens

  - Config PAT: Addd "Pull requests", "Contents"

- Usage PAT: Repository Settings => Repository secrets => New repository secret => MY_RELEASE_PLEASE_TOKEN

## 🔨Dev & Maintenance

### Update the target project

```bash

cd 

copier update  # to update from the latest template

```

### Test `plugin-scaffold.nvim`

```bash

make  # this would run test for plugin-scaffold.nvim

```

## 🔗Related Projects

Many features are from [nvim-lua-plugin-template](https://github.com/ellisonleao/nvim-lua-plugin-template).