seito: Add --vim-config

Author: sol

.github/workflows/build.yml

@@ -30,7 +30,8 @@ jobs:
           - os: macos-12
             ghc: system
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
+
       - uses: hspec/setup-haskell@v1
         with:
           ghc-version: ${{ matrix.ghc }}
@@ -47,7 +48,7 @@ jobs:
         # https://github.com/actions/runner-images/blob/macOS-12/20230416.1/images/macos/macos-12-Readme.md#tools
         #
         # (on Linux this is a noop)
-        run: ghcup install cabal 3.10 --set
+        run: ghcup install cabal latest --set
 
       - shell: bash
         run: git config --global init.defaultBranch main
@@ -66,6 +67,20 @@ jobs:
         env:
           HSPEC_OPTIONS: --color
 
+      - run: vim/run-tests.vim
+        if: runner.os == 'Linux'
+
+      - shell: bash
+        run: |
+          vim/test/assets/generate.sh
+          untracked=$(git ls-files --others --exclude-standard)
+          if [ -n "$untracked" ]; then
+            echo "Untracked files:"
+            echo "$untracked"
+            exit 1
+          fi
+          git diff --exit-code
+
   success:
     needs: build
     runs-on: ubuntu-latest
@@ -75,6 +90,6 @@ jobs:
       - run: false
         if: needs.build.result != 'success'
 
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Check for trailing whitespace
-        run: '! git grep -I "\s\+$"'
+        run: "! git grep -nI '[[:blank:]]$' -- . ':!vim/test/assets'"

README.md

@@ -51,13 +51,14 @@ instead:
 
 ### Vim integration
 
-You can use `sensei` to load the result of the last test run into your quickfix
+You can use `seito` to load the results of the last test run into your quickfix
 list by executing `:make` in Vim.
 
-For this to work, you can either create a `Makefile` or set `makeprg` to a
-custom value.
+For this to work, you can choose one out of three options:
 
-(In both cases, `sed` is used to strip ANSI color sequences.)
+1. Create a `Makefile`
+2. Set `makeprg` to a custom value
+3. Use [`sensei.vim`](vim/sensei.vim)
 
 #### Option 1: Create a `Makefile`
 
@@ -78,6 +79,16 @@ Add the following to your Vim configuration (e.g.
 :set makeprg=seito
 ```
 
+#### Option 3: Use `sensei.vim`:
+
+Add the following to your Vim configuration (e.g.
+`~/.vim/after/ftplugin/haskell.vim`):
+
+```vim
+let vim_config = system('seito --vim-config')
+execute 'source ' . vim_config
+```
+
 ### Emacs integration
 
 Similarly, you can use `sensei` to load the result of the last test run into an

driver/seito.hs

@@ -5,10 +5,12 @@ import           System.Environment
 import           Control.Monad
 import qualified Data.ByteString.Lazy as L
 
+import           Paths_sensei (getDataFileName)
+
 import           Client
 
 main :: IO ()
 main = do
-  (success, output) <- getArgs >>= client ""
+  (success, output) <- getArgs >>= client getDataFileName ""
   L.putStr output
   unless success exitFailure

package.yaml

@@ -17,8 +17,7 @@ default-extensions:
   - RecordWildCards
   - ViewPatterns
 
-other-extensions:
-  - NoFieldSelectors
+data-files: vim/sensei.vim
 
 dependencies:
   - base >= 4.11 && < 5
@@ -62,6 +61,7 @@ executables:
 
   seito:
     source-dirs: driver
+    generated-other-modules: Paths_sensei
     main: seito.hs
 
 tests:

sensei.cabal

@@ -11,11 +11,12 @@ import qualified Data.ByteString.Lazy as L
 
 import           HTTP (newSocket, socketName)
 
-client :: FilePath -> [String] -> IO (Bool, L.ByteString)
-client dir args = case args of
+client :: (FilePath -> IO FilePath) -> FilePath -> [String] -> IO (Bool, L.ByteString)
+client getDataFileName dir args = case args of
   [] -> hIsTerminalDevice stdout >>= run
   ["--no-color"] -> run False
   ["--color"] -> run True
+  ["--vim-config"] -> (,) True . fromString <$> getDataFileName "vim/sensei.vim"
   _ -> do
     hPutStrLn stderr $ "Usage: seito [ --color | --no-color ]"
     return (False, "")

src/Client.hs

@@ -24,17 +24,21 @@ spec = do
   describe "client" $ do
     it "accepts --color" $ do
       withSuccess $ \ dir -> do
-        client dir ["--color"] `shouldReturn` (True, fromString $ withColor Green "success")
+        client return dir ["--color"] `shouldReturn` (True, fromString $ withColor Green "success")
 
     it "accepts --no-color" $ do
       withSuccess $ \ dir -> do
-        client dir ["--no-color"] `shouldReturn` (True, "success")
+        client return dir ["--no-color"] `shouldReturn` (True, "success")
 
     it "indicates failure" $ do
       withFailure $ \ dir -> do
-        client dir [] `shouldReturn` (False, "failure")
+        client return dir [] `shouldReturn` (False, "failure")
 
     context "when server socket is missing" $ do
       it "reports error" $ do
         withTempDirectory $ \ dir -> do
-          client dir [] `shouldReturn` (False, "could not connect to " <> fromString (socketName dir) <> "\n")
+          client return dir [] `shouldReturn` (False, "could not connect to " <> fromString (socketName dir) <> "\n")
+
+    context "with --vim-config" $ do
+      it "returns a path to Vim support files" $ do
+        client return undefined ["--vim-config"] `shouldReturn` (True, "vim/sensei.vim")

test/ClientSpec.hs

@@ -0,0 +1,39 @@
+#!/bin/env -S vim -u NONE -S
+
+set t_ti=
+set t_te=
+
+highlight red ctermfg=red
+highlight green ctermfg=green
+
+command -nargs=* FAILURE echohl red | echo <args> | echohl none
+command -nargs=* SUCCESS echohl green | echo <args> | echohl none
+
+function CheckResults()
+  if !empty(v:errors)
+    FAILURE "FAILURES:\n"
+    for error in v:errors
+      echo "\n"
+      FAILURE substitute(substitute(substitute(error, "^command line..script ", "", ""), " Expected ", "\n\nexpected: ", ""), " but got", "\n but got:", "")
+    endfor
+    cquit
+  endif
+endfunction
+
+try
+  for name in glob("**/*.test.vim", v:true, v:true)
+    SUCCESS "running " . name
+    execute "source " . name
+  endfor
+catch
+  FAILURE substitute(v:throwpoint, "^command line..script ", "", "")
+  echo "\n"
+  FAILURE v:exception
+  cquit
+endtry
+
+echo "\n"
+
+call CheckResults()
+SUCCESS "SUCCESS"
+quit

vim/run-tests.vim

@@ -0,0 +1,126 @@
+source vim/sensei.vim
+
+function Require(actual, required)
+  for i in range(len(a:required))
+    if a:actual[i] > a:required[i]
+      return 1
+    elseif a:actual[i] < a:required[i]
+      return 0
+    endif
+  endfor
+  return 1
+endfunction
+
+function GhcVersion(name)
+  return matchlist(a:name, '\vghc-(\d+)\.(\d+)\.(\d+)\.errors')[1:3]
+endfunction
+
+function PopulateQuickFixList(name)
+  SUCCESS a:name
+  execute "cgetfile " . a:name
+  return filter(getqflist(), 'v:val.valid')
+endfunction
+
+for name in glob("vim/test/assets/lexical-error.hs.*.errors", v:true, v:true)
+  let errors = PopulateQuickFixList(name)
+  call assert_equal(1, len(errors))
+
+  let err = errors[0]
+  call assert_equal("vim/test/assets/lexical-error.hs", bufname(err.bufnr))
+  call assert_equal(1, err.lnum)
+  call assert_equal(11, err.col)
+  call assert_equal(0, err.end_lnum)
+  call assert_equal(0, err.end_col)
+  call assert_equal('e', err.type)
+  if Require(GhcVersion(name), [9,6])
+    call assert_equal(21231, err.nr)
+  else
+    call assert_equal(-1, err.nr)
+  endif
+  call assert_equal("\n    lexical error in string/character literal at character '\\n'", err.text)
+endfor
+
+for name in glob("vim/test/assets/parse-error.hs.*.errors", v:true, v:true)
+  let errors = PopulateQuickFixList(name)
+  call assert_equal(1, len(errors))
+
+  let err = errors[0]
+  call assert_equal("vim/test/assets/parse-error.hs", bufname(err.bufnr))
+  call assert_equal(1, err.lnum)
+  call assert_equal(1, err.col)
+  call assert_equal(0, err.end_lnum)
+  call assert_equal(0, err.end_col)
+  call assert_equal('e', err.type)
+  if Require(GhcVersion(name), [9,8])
+    call assert_equal(25277, err.nr)
+  else
+    call assert_equal(-1, err.nr)
+  endif
+  call assert_equal("\n    Parse error: module header, import declaration\n    or top-level declaration expected.", err.text)
+endfor
+
+for name in glob("vim/test/assets/type-error.hs.*.errors", v:true, v:true)
+  let errors = PopulateQuickFixList(name)
+  call assert_equal(1, len(errors))
+
+  let err = errors[0]
+  call assert_equal("vim/test/assets/type-error.hs", bufname(err.bufnr))
+  call assert_equal(2, err.lnum)
+  call assert_equal(7, err.col)
+  call assert_equal(0, err.end_lnum)
+  call assert_equal(0, err.end_col)
+  call assert_equal('e', err.type)
+  if Require(GhcVersion(name), [9,6])
+    call assert_equal(83865, err.nr)
+    call assert_equal("\n    Couldn't match type ‘Int’ with ‘[Char]’\n    Expected: String\n      Actual: Int", err.text)
+  else
+    call assert_equal(-1, err.nr)
+    call assert_equal("\n    • Couldn't match type ‘Int’ with ‘[Char]’\n      Expected: String\n        Actual: Int\n    • In the expression: 23 :: Int\n      In an equation for ‘foo’: foo = 23 :: Int", err.text)
+  endif
+endfor
+
+for name in glob("vim/test/assets/type-signature-lacks-binding.hs.*.errors", v:true, v:true)
+  let errors = PopulateQuickFixList(name)
+  call assert_equal(2, len(errors))
+
+  let err = errors[0]
+  call assert_equal("vim/test/assets/type-signature-lacks-binding.hs", bufname(err.bufnr))
+  call assert_equal(1, err.lnum)
+  call assert_equal(1, err.col)
+  call assert_equal(0, err.end_lnum)
+  call assert_equal(0, err.end_col)
+  call assert_equal('e', err.type)
+  if Require(GhcVersion(name), [9,6])
+    call assert_equal(44432, err.nr)
+  else
+    call assert_equal(-1, err.nr)
+  endif
+  call assert_equal("\n    The type signature for ‘foo’ lacks an accompanying binding", err.text)
+
+  let err = errors[1]
+  call assert_equal("vim/test/assets/type-signature-lacks-binding.hs", bufname(err.bufnr))
+  call assert_equal(4, err.lnum)
+  call assert_equal(1, err.col)
+  call assert_equal(0, err.end_lnum)
+  call assert_equal(0, err.end_col)
+  call assert_equal('e', err.type)
+  if Require(GhcVersion(name), [9,6])
+    call assert_equal(44432, err.nr)
+  else
+    call assert_equal(-1, err.nr)
+  endif
+  call assert_equal("\n    The type signature for ‘bar’ lacks an accompanying binding", err.text)
+endfor
+
+let errors = PopulateQuickFixList("vim/test/assets/hspec.hs.errors")
+call assert_equal(1, len(errors))
+
+let err = errors[0]
+call assert_equal("vim/test/assets/hspec.hs", bufname(err.bufnr))
+call assert_equal(6, err.lnum)
+call assert_equal(11, err.col)
+call assert_equal(0, err.end_lnum)
+call assert_equal(0, err.end_col)
+call assert_equal('', err.type)
+call assert_equal(-1, err.nr)
+call assert_equal("", err.text)