{"id":13895682,"url":"https://github.com/shortcuts/neovim-plugin-boilerplate","last_synced_at":"2025-04-15T08:36:41.832Z","repository":{"id":65244024,"uuid":"583446148","full_name":"shortcuts/neovim-plugin-boilerplate","owner":"shortcuts","description":"🔌 Plug and play Neovim plugin boilerplate with pre-configured CI, CD, linter, docs and tests.","archived":false,"fork":false,"pushed_at":"2024-09-25T21:02:31.000Z","size":55,"stargazers_count":202,"open_issues_count":0,"forks_count":9,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-06T06:06:48.427Z","etag":null,"topics":["boilerplate","lua","neovim","neovim-plugin","nvim","plugin","template"],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shortcuts.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":"FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"shortcuts"}},"created_at":"2022-12-29T20:04:16.000Z","updated_at":"2025-03-09T22:04:09.000Z","dependencies_parsed_at":"2024-02-01T05:55:01.057Z","dependency_job_id":"a96222df-a797-4c77-a121-5f69d930c579","html_url":"https://github.com/shortcuts/neovim-plugin-boilerplate","commit_stats":null,"previous_names":[],"tags_count":7,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shortcuts%2Fneovim-plugin-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shortcuts%2Fneovim-plugin-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shortcuts%2Fneovim-plugin-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shortcuts%2Fneovim-plugin-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shortcuts","download_url":"https://codeload.github.com/shortcuts/neovim-plugin-boilerplate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249038368,"owners_count":21202682,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["boilerplate","lua","neovim","neovim-plugin","nvim","plugin","template"],"created_at":"2024-08-06T18:02:23.270Z","updated_at":"2025-04-15T08:36:41.806Z","avatar_url":"https://github.com/shortcuts.png","language":"Lua","funding_links":["https://github.com/sponsors/shortcuts"],"categories":["boilerplate","Lua"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ch1 align=\"center\"\u003e🔌  Neovim plugin boilerplate\u003c/h2\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    Plug and play Neovim plugin boilerplate with pre-configured CI, CD, linter, docs and tests.\n\u003c/p\u003e\n\n## ⚡️ Features\n\n- Interactive `setup` script for an easy setup\n- Perfect for open-source:\n  - CODEOWNERS file for PR auto-assign\n  - Issue forms and PR templates\n  - README.md template\n- Generated Neovim documentation with [mini.nvim `doc` plugin](https://github.com/echasnovski/mini.nvim/blob/main/lua/mini/doc.lua)\n- Test runner with [mini.nvim `test` plugin](https://github.com/echasnovski/mini.nvim/blob/main/lua/mini/test.lua)\n    - Versioned testing with available with [`bob`](https://github.com/MordechaiHadad/bob)\n- Automatic releases (CD) with [release-please-action](https://github.com/google-github-actions/release-please-action)\n- Linting with [Stylua](https://github.com/JohnnyMorganz/StyLua)\n- Static analysis with LuaLS (inspired by [lukas-reineke/ci-template.nvim](https://github.com/lukas-reineke/ci-template.nvim))\n- GitHub Actions Pipeline:\n  - Lint with [Stylua](https://github.com/JohnnyMorganz/StyLua)\n  - Static analysis with LuaLS\n  - Versioned testing (0.9.x, 0.10.x and Nightly by default)\n  - Generated documentation analysis\n  - Minimal run time with caching capabilities, ideal for free-plans\n\n## 📋 Installation\n\n\u003e **Note**:\n\u003e This section is only required if you wish to use the tooling proposed by this template, you can skip this step if you want.\n\n- [Install Stylua for the linting solution](https://github.com/JohnnyMorganz/StyLua#installation)\n- [Install `bob` neovim version manager for the versioned testing solution](https://github.com/MordechaiHadad/bob)\n\n## ☄ Getting started\n\nThe following checklist is all your need to do to start writing your first plugin.\n\n### 1 - Clone the template repository\n\n#### via HTTPs\n\n```sh\ngit clone https://github.com/shortcuts/neovim-plugin-boilerplate.git ~/my-awesome-plugin.nvim\n```\n\n#### via SSH\n\n```sh\ngit clone git@github.com:shortcuts/neovim-plugin-boilerplate.git ~/my-awesome-plugin.nvim\n```\n\n#### via GH\n```sh\ngh repo create my-awesome-plugin --template shortcuts/neovim-plugin-boilerplate --public --clone\n```\n\n### 2 - Replace placeholder names with your plugin name\n\n#### ✨ Automatically\n\nThe [setup script](https://github.com/shortcuts/neovim-plugin-boilerplate/blob/main/scripts/setup.sh) will rename files and placeholder names for you. Once done, you can remove anything `setup` related if you want to.\n\n```sh\n# interactive\nmake setup\n\n# automated\nUSERNAME=my-github-username PLUGIN_NAME=my-awesome-plugin REPOSITORY_NAME=my-awesome-plugin.nvim make setup\n```\n\n#### ✍️ Manually\n\n\u003e **Note**:\n\u003e The placeholder names are purposely written with different casing. Make sure to keep it.\n\n##### File names\n\n```sh\nrm -rf doc\nmv plugin/your-plugin-name.lua plugin/my-awesome-plugin.lua\nmv lua/your-plugin-name lua/my-awesome-plugin\nmv README_TEMPLATE.md README.md \nmv .github/ISSUE_TEMPLATE/Bug_report_template.yml .github/ISSUE_TEMPLATE/Bug_report.yml\n\n```\n\n##### Search and replace placeholder occurrences:\n\n```vim\n:vimgrep /YourPluginName/ **/*\n:cfdo %s/YourPluginName/MyAwesomePlugin/g | update\n\n:vimgrep /your-plugin-name/ **/* .github/**\n:cfdo %s/your-plugin-name/my-awesome-plugin/g | update\n\n:vimgrep /YOUR_GITHUB_USERNAME/ .github/** **/*.md\n:cfdo %s/YOUR_GITHUB_USERNAME/shortcuts/g | update\n\n:vimgrep /YOUR_REPOSITORY_NAME/ **/*.md\n:cfdo %s/YOUR_REPOSITORY_NAME/my-awesome-plugin.nvim/g | update\n```\n\n### 3 - Code\n\nYou can now start writing your plugin, make sure the following commands work:\n1. `make deps` to install docs/tests dependencies\n2. `make lint` to format the code\n3. `make documentation` to generate the documentation\n4. `make test` to run the tests\n\nEnjoy!\n\n## ☄ Who uses this template?\n\n- [no-neck-pain.nvim](https://github.com/shortcuts/no-neck-pain.nvim): ☕ Dead simple yet super extensible plugin to center the currently focused buffer to the middle of the screen.\n- [wf.nvim](https://github.com/Cassin01/wf.nvim): A modern which-key for neovim\n- [better-ts-errors.nvim](https://github.com/OlegGulevskyy/better-ts-errors.nvim)\n\n## ⌨ Contributing\n\nPRs and issues are always welcome. Make sure to provide as much context as possible when opening one.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshortcuts%2Fneovim-plugin-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshortcuts%2Fneovim-plugin-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshortcuts%2Fneovim-plugin-boilerplate/lists"}