test: configure CI

Author: cvigilv

.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: Run tests
+
+on: [push, pull_request]
+
+jobs:
+  unit_tests:
+    name: unit tests
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-22.04]
+        rev: [nightly]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: rhysd/action-setup-vim@v1
+        with:
+          neovim: true
+          version: ${{ matrix.rev }}
+
+      - name: Download requirements
+        run: |
+          git clone --depth 1 https://github.com/nvim-lua/plenary.nvim ../plenary.nvim
+
+      - name: Run tests
+        run: |
+          nvim --version
+          make test

.luarc.json

@@ -0,0 +1,6 @@
+{
+    "diagnostics.globals": [
+        "it",
+        "describe"
+    ]
+}

Makefile

@@ -0,0 +1,4 @@
+.PHONY: test
+
+test:
+	nvim --headless --noplugin -u scripts/minimal_init.vim -c "PlenaryBustedDirectory tests/ { minimal_init = './scripts/minimal_init.vim' }"

scripts/minimal_init.vim

@@ -0,0 +1,4 @@
+set rtp+=.
+set rtp+=../plenary.nvim/
+
+runtime! plugin/plenary.vim

scripts/skeletons/README/base

@@ -0,0 +1 @@
+# Hello World!

scripts/skeletons/lua/base

@@ -0,0 +1 @@
+print("Hello World!")

tests/autocmd_spec.lua

@@ -0,0 +1,59 @@
+---@diagnostic disable: undefined-global, lowercase-global, undefined-field
+
+local eq = assert.are.same
+
+describe("createautocmd", function()
+  -- Setup environment for tests
+  before_each(function()
+    local opts = {
+      autouse = true,
+      directories = { vim.fn.stdpath("config") .. "/skeletons" },
+      patterns = function(dir) return vim.fn.readdir(dir) end,
+      wildcards = {
+        expand = true,
+        lookup = {
+          -- File
+          ["filename"] = function() return vim.fn.expand("%:t:r") end,
+          ["fileabspath"] = function() return vim.fn.expand("%:p") end,
+          ["filerelpath"] = function() return vim.fn.expand("%:p:~") end,
+          ["fileext"] = function() return vim.fn.expand("%:e") end,
+          ["filetype"] = function() return vim.bo.filetype end,
+
+          -- Date and time
+          ["date"] = function() return os.date("%Y%m%d", os.time()) end,
+          ["year"] = function() return os.date("%Y", os.time()) end,
+          ["month"] = function() return os.date("%m", os.time()) end,
+          ["day"] = function() return os.date("%d", os.time()) end,
+          ["time"] = function() return os.date("%T", os.time()) end,
+
+          -- System
+          ["host"] = "gh",
+          ["user"] = "gh-ci",
+
+          -- Github
+          ["gh-email"] = "n/a",
+          ["gh-user"] = "n/a",
+        },
+      },
+      advanced = {
+        ignored = {},
+        ignore_os_files = true,
+      },
+    }
+
+    autocmds = require("esqueleto.autocmd").createautocmd(opts)
+  end)
+
+  it("should createa autocmds", function()
+    -- Expected behaviour
+    local group_name = "esqueleto"
+    local existing_autocmds = vim.api.nvim_get_autocmds({
+      group = group_name,
+    })
+    vim.print(existing_autocmds)
+
+    -- Observed behaviour
+
+    eq(true == true) -- Check if behaviours are equal
+  end)
+end)