Merge pull request #2 from magnusriga/test-suite

Test suite

Author: magnusriga

.github/workflows/changelog.yml

@@ -0,0 +1,33 @@
+# .github/workflows/changelog.yml
+name: Check Changelog
+
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+    branches:
+      - main
+
+jobs:
+  check-changelog:
+    name: Verify CHANGELOG.md update
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Fetch all history to compare changes
+
+      - name: Get changed files
+        id: changed-files
+        uses: tj-actions/changed-files@v44 # Use a dedicated action to get changed files
+        with:
+          files: CHANGELOG.md
+
+      - name: Check if CHANGELOG.md was modified
+        if: steps.changed-files.outputs.any_changed != 'true'
+        run: |
+          echo "Error: No changes detected in CHANGELOG.md."
+          echo "Please update the CHANGELOG.md file with details about your changes."
+          exit 1

.github/workflows/lint.yml

@@ -0,0 +1,21 @@
+# .github/workflows/lint.yml
+name: Lint
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  stylua:
+    name: Check Lua code style with stylua
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Run stylua check
+        uses: JohnnyMorganz/stylua-action@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          version: latest
+          args: --check . # Explicitly tell stylua to check the current directory

.github/workflows/test.yml

@@ -0,0 +1,24 @@
+# .github/workflows/test.yml
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    name: Run tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Neovim
+        uses: rhysd/action-setup-vim@v1
+        with:
+          neovim: true
+          version: stable # Or specify a version like 'v0.9.5'
+
+      - name: Run tests
+        run: make test # Use Makefile target

.gitignore

@@ -9,3 +9,6 @@
 .Trashes
 ehthumbs.db
 Thumbs.db
+
+# Test dependencies
+plenary.nvim/

CHANGELOG.md

@@ -9,18 +9,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Added comprehensive test suite using `plenary.nvim`.
+- Added `stylua` for code formatting and linting.
+
+### Changed
+
+- Updated `MarkdownCodeBlock` command to correctly handle visual selections, including multi-line selections and selections starting mid-line.
+
 ## [1.0.1] - 2025-05-05
 
 ### Added
 
 ### Changed
+
 - Allow `MarkdownNewTemplate` command to be used in any filetype.
 
 ### Deprecated
 
 ### Removed
 
 ### Fixed
+
 - Visual mode keymap for inserting headers now correctly exits visual mode before executing the command.
 
 ### Security
@@ -49,4 +60,3 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [Unreleased]: https://github.com/magnusriga/markdown-tools.nvim/compare/v1.0.1...HEAD
 [1.0.1]: https://github.com/magnusriga/markdown-tools.nvim/compare/v1.0.0...v1.0.1
 [1.0.0]: https://github.com/magnusriga/markdown-tools.nvim/compare/v0.1.0...v1.0.0
-[0.1.0]: https://github.com/magnusriga/markdown-tools.nvim/releases/tag/v0.1.0

Makefile

@@ -0,0 +1,22 @@
+# Makefile
+
+# Prevent targets from conflicting with files of the same name
+.PHONY: test lint clean
+
+# Default target (optional, runs if you just type 'make')
+default: test
+
+# Run the test suite
+test:
+	@echo "Running tests..."
+	@./scripts/test
+
+# Check Lua code style
+lint:
+	@echo "Checking code style with stylua..."
+	@stylua --check .
+
+# Remove temporary test dependencies
+clean:
+	@echo "Cleaning up test dependencies..."
+	@rm -rf plenary.nvim

README.md

@@ -1,7 +1,9 @@
-# markdown-tools.nvim  🪄
+# markdown-tools.nvim 🪄
 
 [![Lua](https://img.shields.io/badge/Lua-blue.svg?style=flat-square&logo=lua)](https://www.lua.org)
 [![License](https://img.shields.io/github/license/magnusriga/markdown-tools.nvim?style=flat-square)](LICENSE)
+[![Neovim >= 0.8.0](https://img.shields.io/badge/Neovim-%3E%3D%200.8.0-blueviolet.svg?style=flat-square)](https://neovim.io/)
+[![CI Status](https://img.shields.io/github/actions/workflow/status/magnusriga/markdown-tools.nvim/lint.yml?branch=main&style=flat-square)](https://github.com/magnusriga/markdown-tools.nvim/actions)
 
 > Enhancing your Markdown editing experience in Neovim with intuitive shortcuts and commands.
 
@@ -13,7 +15,7 @@ The markdown created, including the frontmatter, is compatible with [obsidian](h
 
 ## ✨ Features
 
-- **📝 Template Creation:** Create new Markdown files from predefined templates using your choice of picker (`snacks`, `fzf-lua`, `telescope`). Automatically adds frontmatter with placeholders (e.g., `alias`, `tags`).
+- **📝 Template Creation:** Create new Markdown files from predefined templates, using picker `snacks`, `fzf-lua`, or `telescope`. Automatically adds configurable frontmatter with placeholders (e.g., `alias`, `tags`).
 - **🧱 Insert Markdown Elements:** Quickly add links, checkboxes, tables, headers, bold/italic/highlight text, code blocks, ++.
 - **🎨 Visual Mode Integration:** Wrap selected text with bold, italic, links, or highlights.
 - **✅ Checkbox Management:** Insert new checkboxes and toggle their state.

lua/markdown-tools/autocmds.lua

@@ -4,24 +4,24 @@ local M = {}
 --- Setup autocommands for markdown files
 ---@param options table Plugin configuration options
 function M.setup_autocmds(options)
-	-- Create autocommand group
-	local augroup = vim.api.nvim_create_augroup("MarkdownShortcuts", { clear = true })
+  -- Create autocommand group
+  local augroup = vim.api.nvim_create_augroup("MarkdownShortcuts", { clear = true })
 
-	-- Set up autocommands for markdown files
-	vim.api.nvim_create_autocmd("FileType", {
-		group = augroup,
-		pattern = "markdown",
-		callback = function()
-			-- Set up local options for markdown files
-			if options.enable_local_options then
-				vim.opt_local.wrap = options.wrap
-				vim.opt_local.conceallevel = options.conceallevel
-				vim.opt_local.concealcursor = options.concealcursor
-				vim.opt_local.spell = options.spell
-				vim.opt_local.spelllang = options.spelllang
-			end
-		end,
-	})
+  -- Set up autocommands for markdown files
+  vim.api.nvim_create_autocmd("FileType", {
+    group = augroup,
+    pattern = "markdown",
+    callback = function()
+      -- Set up local options for markdown files
+      if options.enable_local_options then
+        vim.opt_local.wrap = options.wrap
+        vim.opt_local.conceallevel = options.conceallevel
+        vim.opt_local.concealcursor = options.concealcursor
+        vim.opt_local.spell = options.spell
+        vim.opt_local.spelllang = options.spelllang
+      end
+    end,
+  })
 end
 
 return M