chore: setup repo structure

Author: rcasia

.github/workflows/makefile.yml

@@ -0,0 +1,27 @@
+name: CI / Tests
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+
+    - name: Setup Maven Action
+      uses: s4u/setup-maven-action@v1.9.0
+
+    - uses: rhysd/action-setup-vim@v1
+      with:
+        neovim: true
+
+    - name: Install dependencies
+      run: make install
+
+    - name: Run tests
+      run: make test

.gitmodules

@@ -0,0 +1,9 @@
+[submodule "dependencies/neotest"]
+	path = dependencies/neotest
+	url = https://github.com/nvim-neotest/neotest
+[submodule "dependencies/nvim-treesitter"]
+	path = dependencies/nvim-treesitter
+	url = https://github.com/nvim-treesitter/nvim-treesitter.git
+[submodule "dependencies/plenary.nvim"]
+	path = dependencies/plenary.nvim
+	url = https://github.com/nvim-lua/plenary.nvim.git

Makefile

@@ -0,0 +1,18 @@
+
+all: install test
+
+test: 
+	./scripts/test
+
+test-fail-fast:
+	./scripts/test --fail-fast
+
+install:
+	git submodule update --init --recursive
+	nvim --headless -u tests/minimal_init.vim -c "TSInstallSync bash | quit"
+
+validate:
+	stylua --check .
+
+format:
+	stylua .

README.md

@@ -1 +1,22 @@
-# neotest-bash
+# neotest-bash
+
+[Neotest](https://github.com/rcarriga/neotest) adapter for Bash, using Bashunit.
+
+
+## 🔧 Installation
+
+It requires [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter)
+
+Using vim-plug:
+```vim
+Plug 'rcasia/neotest-bash', { 'do': ':TSInstall bash' }
+```
+
+## ⚙ Configuration
+```lua
+require("neotest").setup({
+  adapters = {
+    require("neotest-bash")
+  }
+})
+```

dependencies/neotest

@@ -0,0 +1,13 @@
+DirFilter = {}
+
+---Filter directories when searching for test files
+---@async
+---@param name string Name of directory
+---@param rel_path string Path to directory, relative to root
+---@param root string Root directory of project
+---@return boolean
+function DirFilter.filter_dir(name, rel_path, root)
+	return false
+end
+
+return DirFilter

dependencies/nvim-treesitter

@@ -0,0 +1,10 @@
+FileChecker = {}
+
+---@async
+---@param file_path string
+---@return boolean
+function FileChecker.isTestFile(file_path)
+	return false
+end
+
+return FileChecker

dependencies/plenary.nvim

@@ -0,0 +1,15 @@
+local lib = require("neotest.lib")
+
+PositionsDiscoverer = {}
+
+---Given a file path, parse all the tests within it.
+---@async
+---@param file_path string Absolute file path
+---@return neotest.Tree | nil
+function PositionsDiscoverer:discover_positions(file_path)
+	local query = [[]]
+
+	return lib.treesitter.parse_positions(file_path, query)
+end
+
+return PositionsDiscoverer

lua/neotest-bash/core/dir_filter.lua

@@ -0,0 +1,18 @@
+local xml = require("neotest.lib.xml")
+local scan = require("plenary.scandir")
+local context_manager = require("plenary.context_manager")
+local with = context_manager.with
+local open = context_manager.open
+
+ResultBuilder = {}
+
+---@async
+---@param spec neotest.RunSpec
+---@param result neotest.StrategyResult
+---@param tree neotest.Tree
+---@return table<string, neotest.Result>
+function ResultBuilder.build_results(spec, result, tree)
+	return nil
+end
+
+return ResultBuilder

lua/neotest-bash/core/file_checker.lua

@@ -0,0 +1,13 @@
+local lib = require("neotest.lib")
+
+SpecBuilder = {}
+---Find the project root directory given a current directory to work from.
+---Should no root be found, the adapter can still be used in a non-project context if a test file matches.
+---@async
+---@param dir string @Directory to treat as cwd
+---@return string | nil @Absolute root dir of test suite
+function SpecBuilder.findRoot(dir)
+	return lib.files.match_root_pattern("????")(dir)
+end
+
+return SpecBuilder

lua/neotest-bash/core/positions_discoverer.lua

@@ -0,0 +1,10 @@
+local RootFinder = require("neotest-bash.core.root_finder")
+
+SpecBuilder = {}
+---@param args neotest.RunArgs
+---@return nil | neotest.RunSpec | neotest.RunSpec[]
+function SpecBuilder.build_spec(args)
+	return nil
+end
+
+return SpecBuilder

lua/neotest-bash/core/result_builder.lua

@@ -0,0 +1,61 @@
+local FileChecker = require("neotest-bash.core.file_checker")
+local RootFinder = require("neotest-bash.core.root_finder")
+local DirFilter = require("neotest-bash.core.dir_filter")
+local PositionsDiscoverer = require("neotest-bash.core.positions_discoverer")
+local SpecBuilder = require("neotest-bash.core.spec_builder")
+local ResultBuilder = require("neotest-bash.core.result_builder")
+
+---@class neotest.Adapter
+---@field name string
+NeotestBashAdapter = { name = "neotest-bash" }
+
+---Find the project root directory given a current directory to work from.
+---Should no root be found, the adapter can still be used in a non-project context if a test file matches.
+---@async
+---@param dir string @Directory to treat as cwd
+---@return string | nil @Absolute root dir of test suite
+function NeotestBashAdapter.root(dir)
+	return RootFinder.findRoot(dir)
+end
+
+---Filter directories when searching for test files
+---@async
+---@param name string Name of directory
+---@param rel_path string Path to directory, relative to root
+---@param root string Root directory of project
+---@return boolean
+function NeotestBashAdapter.filter_dir(name, rel_path, root)
+	return DirFilter.filter_dir(name, rel_path, root)
+end
+
+---@async
+---@param file_path string
+---@return boolean
+function NeotestBashAdapter.is_test_file(file_path)
+	return FileChecker.isTestFile(file_path)
+end
+
+---Given a file path, parse all the tests within it.
+---@async
+---@param file_path string Absolute file path
+---@return neotest.Tree | nil
+function NeotestBashAdapter.discover_positions(file_path)
+	return PositionsDiscoverer:discover_positions(file_path)
+end
+
+---@param args neotest.RunArgs
+---@return nil | neotest.RunSpec | neotest.RunSpec[]
+function NeotestBashAdapter.build_spec(args)
+	return SpecBuilder.build_spec(args)
+end
+
+---@async
+---@param spec neotest.RunSpec
+---@param result neotest.StrategyResult
+---@param tree neotest.Tree
+---@return table<string, neotest.Result>
+function NeotestBashAdapter.results(spec, result, tree)
+	return ResultBuilder.build_results(spec, result, tree)
+end
+
+return NeotestBashAdapter

lua/neotest-bash/core/root_finder.lua

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+
+tempfile=$(mktemp)
+
+
+if [[ -n $1 ]] && [[ $1 == "--fail-fast" ]]; then
+  echo "Running tests with --fail-fast"
+  nvim --headless --noplugin -u tests/minimal_init.vim \
+    -c "PlenaryBustedDirectory tests/ {minimal_init = 'tests/minimal_init.vim', sequential = true, keep_going = false}" | tee "${tempfile}"
+elif [[ -n $1 ]]; then
+  nvim --headless --noplugin -u tests/minimal_init.vim -c "PlenaryBustedFile $1" | tee "${tempfile}"
+else
+  nvim --headless --noplugin -u tests/minimal_init.vim \
+    -c "PlenaryBustedDirectory tests/ {minimal_init = 'tests/minimal_init.vim'}" | tee "${tempfile}"
+fi
+
+# Plenary doesn't emit exit code 1 when tests have errors during setup
+errors=$(sed 's/\x1b\[[0-9;]*m//g' "${tempfile}" | awk '/(Errors|Failed) :/ {print $3}' | grep -v '0')
+
+rm "${tempfile}"
+
+if [[ -n $errors ]]; then
+  echo "Tests failed"
+  exit 1
+fi
+
+exit 0

lua/neotest-bash/core/spec_builder.lua

@@ -0,0 +1,5 @@
+set runtimepath+=.
+set runtimepath+=./dependencies/plenary.nvim
+set runtimepath+=./dependencies/neotest
+set runtimepath+=./dependencies/nvim-treesitter
+runtime! plugin/plenary.vim