ivuorinen/nvim-shellspec
1
0
Fork 0
mirror of https://github.com/ivuorinen/nvim-shellspec.git synced 2026-01-26 03:24:00 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ce620cd035dc9548c385259dc143281a9e54316b
nvim-shellspec/.serena/memories/project_overview.md
Ismo Vuorinen ce620cd035 feat: add first-class Neovim support with enhanced formatting 
- Add modern Lua implementation with modular architecture
- Implement HEREDOC preservation and smart comment indentation
- Create dual implementation (Neovim Lua + VimScript fallback)
- Add comprehensive health check and configuration system
- Enhance formatting engine with state machine for context awareness
- Update documentation with Lua configuration examples
- Add memory files for development workflow and conventions
2025-09-09 21:13:38 +03:00

1.8 KiB
Raw Blame History

nvim-shellspec Project Overview

Purpose

This is a Neovim/Vim plugin that provides advanced language support and formatting for the ShellSpec DSL testing framework. ShellSpec is a BDD (Behavior-Driven Development) testing framework for shell scripts.

Key Features

  • 🚀 First-class Neovim support with modern Lua implementation
  • 🎨 Syntax highlighting for all ShellSpec DSL keywords
  • 📐 Smart indentation for block structures
  • 📄 Enhanced filetype detection for *_spec.sh, *.spec.sh, spec/*.sh, test/*.sh, and nested spec directories
  • ✨ Advanced formatting with HEREDOC and comment support
  • ⚡ Async formatting to prevent blocking (Neovim 0.7+)
  • 🔄 Backward compatibility with Vim and older Neovim versions

Advanced Formatting Features

  • HEREDOC Preservation: Maintains original formatting within <<EOF, <<'EOF', <<"EOF", and <<-EOF blocks
  • Smart Comment Indentation: Comments are indented to match surrounding code level
  • Context-Aware Formatting: State machine tracks formatting context for accurate indentation

Tech Stack

  • Primary language: Vim script (VimL) + Lua (Neovim)
  • Target environment: Neovim 0.7+ (with Vim fallback)
  • Architecture: Modular Lua implementation with VimScript compatibility layer
  • Shell scripting: Bash (for standalone formatter in bin/shellspec-format)
  • Configuration formats: YAML, JSON, EditorConfig

Dual Implementation

  • Neovim 0.7+: Modern Lua implementation with native APIs
  • Vim/Older Neovim: Enhanced VimScript with same formatting features

Target Files

Plugin activates for files matching:

  • *_spec.sh
  • *.spec.sh
  • spec/*.sh
  • test/*.sh
  • Files in nested spec/ directories

Related Project

  • ShellSpec - BDD testing framework for shell scripts