more changes

Author: ellisonleao

.github/workflows/default.yml

@@ -10,7 +10,7 @@ jobs:
       - uses: JohnnyMorganz/stylua-action@1.0.0
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          args: --color always --check .
+          args: --color always --check lua
 
   test:
     runs-on: ubuntu-latest

README.md

@@ -10,7 +10,7 @@ A template repository for Neovim plugins.
 Via `gh`:
 
 ```
-$ gh repo create my-plugin -p ellisonleao/neovim-plugin-template
+$ gh repo create my-plugin -p ellisonleao/nvim-plugin-template
 ```
 
 Via github web page:
@@ -22,8 +22,8 @@ Click on `Use this template`
 ## Features and structure
 
 - 100% lua
-- Github actions to run tests and formatting (Stylua)
-- tests with busted and plenary.nvim
+- Github actions to run tests and check for formatting errors (Stylua)
+- tests [busted](https://olivinelabs.com/busted/) + [plenary.nvim](https://github.com/nvim-lua/plenary.nvim)
 
 ### Plugin structure
 

lua/module/init.lua

@@ -0,0 +1,22 @@
+-- main module file
+local module = require("plugin_name.module")
+
+local M = {}
+local config = {
+  -- default config
+  opt = "Hello!",
+}
+
+-- setup is the public method to setup your plugin
+M.setup = function(args)
+  -- you can define your setup function here. Usually configurations can be merged, accepting outside params and
+  -- you can also put some validation here for those.
+  config = vim.tbl_deep_extend("keep", args, config)
+end
+
+-- "hello" is a public method for the plugin
+M.hello = function()
+  module.my_first_function(config.opt)
+end
+
+return M

lua/plugin_name.lua

@@ -0,0 +1,8 @@
+-- module represents a lua module for the plugin
+local M = {}
+
+M.my_first_function = function(var)
+  return "my first function with param = " .. var
+end
+
+return M

lua/plugin_name/module.lua

@@ -0,0 +1 @@
+vim.cmd([[command! MyFirstFunction lua require('plugin_name.module').my_first_function() ]])

plugin/module.lua

@@ -0,0 +1,12 @@
+local plugin = require("plugin_name")
+
+describe("setup", function()
+  it("works with default", function()
+    assert("my first function with param = Hello!", plugin.hello())
+  end)
+
+  it("works with custom var", function()
+    plugin.setup({ opt = "custom" })
+    assert("my first function with param = custom", plugin.hello())
+  end)
+end)