initial commit

ellisonleao · ellisonleao · commit cf3de5c2dda9 · 2022-02-14T20:12:57.000-03:00
diff --git a/.github/workflows/default.yml b/.github/workflows/default.yml
@@ -0,0 +1,31 @@
+---
+on: [push, pull_request]
+
+jobs:
+  stylua:
+    name: stylua
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: JohnnyMorganz/stylua-action@1.0.0
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          args: --color always --check .
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        nvim-versions: ['stable', 'nightly']
+    name: test
+    steps:
+      - name: checkout
+        uses: actions/checkout@v2
+
+      - uses: rhysd/action-setup-vim@v1
+        with:
+          neovim: true
+          version: ${{ matrix.nvim-versions }}
+
+      - name: run tests
+        run: make test
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "vendor/plenary.nvim"]
+	path = vendor/plenary.nvim
+	url = https://github.com/nvim-lua/plenary.nvim.git
diff --git a/.stylua.toml b/.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
diff --git a/Makefile b/Makefile
@@ -0,0 +1,11 @@
+.PHONY: test prepare
+
+prepare:
+	@git submodule update --depth 1 --init
+
+test: prepare
+	@nvim \
+			--headless \
+			--noplugin \
+			-u tests/minimal_vim.vim \
+			-c "PlenaryBustedDirectory tests/ { minimal_init = 'tests/minimal_vim.vim' }"
diff --git a/README.md b/README.md
@@ -0,0 +1,32 @@
+# A Neovim Plugin Template
+
+![GitHub Workflow Status](https://img.shields.io/github/workflow/status/ellisonleao/neovim-plugin-template/default?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/neovim-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 to run tests and formatting (Stylua)
+- tests with busted and plenary.nvim
+
+### Plugin structure
+
+```
+
+```
diff --git a/lua/module/init.lua b/lua/module/init.lua
@@ -0,0 +1,8 @@
+-- module represents a lua module for the plugin
+local M = {}
+
+M.my_first_function = function()
+  return "my first function"
+end
+
+return M
diff --git a/plugin/module.lua b/plugin/module.lua
@@ -0,0 +1 @@
+vim.cmd([[command! MyFirstFunction lua require('module').my_first_function() ]])
diff --git a/tests/minimal_vim.vim b/tests/minimal_vim.vim
@@ -0,0 +1,6 @@
+set rtp+=.
+set rtp+=vendor/plenary.nvim
+
+runtime plugin/plenary.vim
+
+lua require('plenary.busted')
diff --git a/tests/module/module_spec.lua b/tests/module/module_spec.lua
@@ -0,0 +1,7 @@
+local module = require("module")
+
+describe("my function", function()
+  it("works!", function()
+    assert.are.equal("my first function", module.my_first_function())
+  end)
+end)
diff --git a/vendor/plenary.nvim b/vendor/plenary.nvim
@@ -0,0 +1 @@
+Subproject commit 66472128c3191b786966798fc956a689705ab1be

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+[submodule "vendor/plenary.nvim"]`
	`2`	`+ path = vendor/plenary.nvim`
	`3`	`+ url = https://github.com/nvim-lua/plenary.nvim.git`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+vim.cmd([[command! MyFirstFunction lua require('module').my_first_function() ]])`