Initial commit

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,54 @@
+name: Bug Report
+description: File a bug/issue
+title: "bug: "
+labels: [bug]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        **Before** reporting an issue, make sure to read the documentation and search existing issues. Usage questions such as ***"How do I...?"*** belong in Discussions and will be closed.
+  - type: checkboxes
+    attributes:
+      label: Did you check docs and existing issues?
+      description: Make sure you checked all of the below before submitting an issue
+      options:
+        - label: I have read all the plugin docs
+          required: true
+        - label: I have searched the existing issues
+          required: true
+        - label: I have searched the existing issues of plugins related to this issue
+          required: true
+  - type: input
+    attributes:
+      label: "Neovim version (nvim -v)"
+      placeholder: "0.8.0 commit db1b0ee3b30f"
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: "Operating system/version"
+      placeholder: "MacOS 11.5"
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Describe the bug
+      description: A clear and concise description of what the bug is. Please include any related errors you see in Neovim.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Steps To Reproduce
+      description: Steps to reproduce the behavior.
+      placeholder: |
+        1.
+        2. 
+        3.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: A concise description of what you expected to happen.
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,36 @@
+name: Feature Request
+description: Suggest a new feature
+title: "feature: "
+labels: [enhancement]
+body:
+  - type: checkboxes
+    attributes:
+      label: Did you check the docs?
+      description: Make sure you read all the docs before submitting a feature request
+      options:
+        - label: I have read all the docs
+          required: true
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Is your feature request related to a problem? Please describe.
+      description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Describe the solution you'd like
+      description: A clear and concise description of what you want to happen.
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Describe alternatives you've considered
+      description: A clear and concise description of any alternative solutions or features you've considered.
+  - type: textarea
+    validations:
+      required: false
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request here.

.github/workflows/lint-test.yml

@@ -0,0 +1,33 @@
+---
+on: [push, pull_request]
+name: lint-test
+
+jobs:
+  stylua:
+    name: stylua
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: JohnnyMorganz/stylua-action@v3
+        with:
+          version: latest
+          token: ${{ secrets.GITHUB_TOKEN }}
+          args: --color always --check lua
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        nvim-versions: ['stable', 'nightly']
+    name: test
+    steps:
+      - name: checkout
+        uses: actions/checkout@v3
+
+      - uses: rhysd/action-setup-vim@v1
+        with:
+          neovim: true
+          version: ${{ matrix.nvim-versions }}
+
+      - name: run tests
+        run: make test

.gitignore

@@ -0,0 +1 @@
+vendor/plenary.nvim

.stylua.toml

@@ -0,0 +1,6 @@
+column_width = 120
+line_endings = "Unix"
+indent_type = "Spaces"
+indent_width = 2
+quote_style = "AutoPreferDouble"
+no_call_parentheses = false

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 getty104
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,47 @@
+# A Neovim Plugin Template
+
+![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/ellisonleao/nvim-plugin-template/lint-test.yml?branch=main&style=for-the-badge)
+![Lua](https://img.shields.io/badge/Made%20with%20Lua-blueviolet.svg?style=for-the-badge&logo=lua)
+
+A template repository for Neovim plugins.
+
+## Using it
+
+Via `gh`:
+
+```
+$ gh repo create my-plugin -p ellisonleao/nvim-plugin-template
+```
+
+Via github web page:
+
+Click on `Use this template`
+
+![](https://docs.github.com/assets/cb-36544/images/help/repository/use-this-template-button.png)
+
+## Features and structure
+
+- 100% Lua
+- Github actions for:
+  - running tests using [plenary.nvim](https://github.com/nvim-lua/plenary.nvim) and [busted](https://olivinelabs.com/busted/)
+  - check for formatting errors (Stylua)
+  - vimdocs autogeneration from README.md file
+  - luarocks release (LUAROCKS_API_KEY secret configuration required)
+
+### Plugin structure
+
+```
+.
+├── lua
+│   ├── plugin_name
+│   │   └── module.lua
+│   └── plugin_name.lua
+├── Makefile
+├── plugin
+│   └── plugin_name.lua
+├── README.md
+├── tests
+│   ├── minimal_init.lua
+│   └── plugin_name
+│       └── plugin_name_spec.lua
+```

lua/air-duster/api.lua

@@ -0,0 +1,13 @@
+local Api = {}
+
+Api.remove_trailing_spaces = function(config)
+  if config.rules[vim.bo.filetype] == nil or config.rules[vim.bo.filetype].white_space then
+    vim.api.nvim_exec("%s/\\s\\+$//ge", false)
+  end
+
+  if config.rules[vim.bo.filetype] == nil or config.rules[vim.bo.filetype].tab then
+    vim.api.nvim_exec("%s/\\t/  /ge", false)
+  end
+end
+
+return Api

lua/air-duster/config.lua

@@ -0,0 +1,10 @@
+local config = {
+  rules = {
+    markdown = {
+      white_space = false,
+      tab = true,
+    },
+  },
+}
+
+return config

lua/air-duster/init.lua

@@ -0,0 +1,19 @@
+local api = require("air-duster.api")
+local config = require("air-duster.config")
+
+local M = {}
+
+M.config = config
+
+M.setup = function(args)
+  M.config = vim.tbl_deep_extend("force", M.config, args or {})
+
+  vim.api.nvim_create_user_command("AirDuster", function()
+    api.remove_trailing_spaces(M.config)
+    print("Removed trailing spaces")
+  end, {
+    desc = "Remove trailing spaces",
+  })
+end
+
+return M