git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v2 2/2] contrib: vim: add sharness syntax file

From
Felipe Contreras <felipe.contreras@gmail.com>
Date
Dec 9, 2020, 06:55 UTC
Message-ID
<20201209065537.48802-3-felipe.contreras@gmail.com>
In-Reply-To
<20201209065537.48802-1-felipe.contreras@gmail.com>

It gets a bit tedious to see all the tests in the same color, so I wrote a vim syntax file to relax my eyes.

I've tried to make it work in as many situations as possible, yet there are still some issues with HEREDOC strings.

Much better than nothing though.
This can be enabled with the following pattern:
  au BufRead,BufNewFile */t/*.sh set filetype=sh.sharness
Whoever, that's already added to the project .vimrc.
Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
---
 .vimrc                          |  1 +
 contrib/vim/syntax/sharness.vim | 34 +++++++++++++++++++++++++++++++++
 2 files changed, 35 insertions(+)
 create mode 100644 contrib/vim/syntax/sharness.vim
diff --git a/.vimrc b/.vimrc
index 602c746477..31600aaeca 100644
--- a/.vimrc
+++ b/.vimrc
@@ -11,6 +11,7 @@
 "
 
 augroup git
+	au BufRead,BufNewFile */t/*.sh set filetype=sh.sharness
 	au BufRead,BufNewFile */Documentation/*.txt set filetype=asciidoc
 
 	au FileType c setl noexpandtab tabstop=8 shiftwidth=0 cino=(s,:0,l1,t0
diff --git a/contrib/vim/syntax/sharness.vim b/contrib/vim/syntax/sharness.vim
new file mode 100644
index 0000000000..6ffc64ff06
--- /dev/null
+++ b/contrib/vim/syntax/sharness.vim
@@ -0,0 +1,34 @@
+let b:is_bash=1
+runtime! syntax/sh.vim
+
+syn keyword shsStatement test_done
+syn keyword shsStatement test_set_editor test_set_index_version test_decode_color lf_to_nul nul_to_q q_to_nul q_to_cr q_to_tab qz_to_tab_space append_cr remove_cr generate_zero_bytes sane_unset test_tick test_pause debug test_commit test_merge test_commit_bulk test_chmod test_modebits test_unconfig test_config test_config_global write_script test_unset_prereq test_set_prereq test_have_prereq test_declared_prereq test_verify_prereq test_external test_external_without_stderr test_path_is_file test_path_is_dir test_path_exists test_dir_is_empty test_file_not_empty test_path_is_missing test_line_count test_file_size list_contains test_must_fail_acceptable test_must_fail test_might_fail test_expect_code test_i18ncmp test_i18ngrep verbose test_must_be_empty test_cmp_rev test_cmp_fspath test_seq test_when_finished test_atexit test_create_repo test_ln_s_add test_write_lines perl test_bool_env test_skip_or_die mingw_test_cmp test_env test_match_signal test_copy_bytes nongit depacketize hex2oct test_set_hash test_detect_hash test_oid_init test_oid_cache test_oid test_oid_to_path test_set_port test_bitmap_traversal test_path_is_hidden test_subcommand
+syn keyword shsStatement test_cmp test_cmp_config test_cmp_bin packetize
+
+syn region shsTest fold start="\<test_expect_\w\+\>" end="$" contains=shsTestTitle
+syn region shsTest fold start="\<test_expect_\w\+\>\s\+\<[A-Z_,]\+\>" end="$" contains=shsPrereq
+syn region shsTest fold start="\<test_lazy_prereq\>\s\+\<[A-Z_,]\+\>" end="$" contains=shsPrereqLazy
+
+syn keyword shsTestStatement contained containedin=shsTest test_expect_success test_expect_failure test_expect_unstable test_lazy_prereq
+
+syn region shsTestTitle contained start=' 'hs=s+1 end=' 'me=e-1 nextgroup=shsTestBody contains=shSingleQuote,shDoubleQuote
+
+" multiple line body
+syn region shsTestBody contained transparent excludenl matchgroup=shQuote start=+ '$+hs=s+1,rs=e end=+'$+ contains=@shSubShList
+syn region shsTestBody contained transparent excludenl matchgroup=shQuote start=+ "$+hs=s+1,rs=e end=+"$+ contains=@shSubShList
+
+" single line body
+syn region shsTestBody contained oneline transparent excludenl keepend matchgroup=shQuote start=+ '+hs=s+1 end=+'$+ contains=@shSubShList
+syn region shsTestBody contained oneline transparent excludenl keepend matchgroup=shQuote start=+ "+hs=s+1 end=+"$+ contains=@shSubShList
+
+syn match shsPrereq contained "\<[A-Z_,]\+\>" nextgroup=shsTestTitle
+syn match shsPrereqLazy contained "\<[A-Z_,]\+\>" nextgroup=shsTestBody
+
+syn cluster shCommandSubList add=shsTest,shsStatement
+
+hi def link shsStatement Statement
+hi def link shsTestStatement Function
+hi def link shsPrereq Identifier
+hi def link shsPrereqLazy shsPrereq
+
+let b:current_syntax='sharness'
-- 
2.29.2
Previous: Felipe ContrerasNext: Eric Sunshine
Message 18 of 22 in “vim: configuration and sharness syntax”
  1. 0/2 vim: configuration and sharness syntaxFelipe Contreras, Dec 9, 2020
  2. 1/2 Add project-wide .vimrc configurationFelipe Contreras, Dec 9, 2020
  3. Christian BrabandtDec 9, 2020
  4. Felipe ContrerasDec 9, 2020
  5. Christian BrabandtDec 9, 2020
  6. Jeff KingDec 9, 2020
  7. Felipe ContrerasDec 10, 2020
  8. Jeff KingDec 10, 2020
  9. Felipe ContrerasDec 11, 2020
  10. brian m. carlsonDec 10, 2020
  11. Felipe ContrerasDec 11, 2020
  12. brian m. carlsonDec 11, 2020
  13. Felipe ContrerasDec 11, 2020
  14. Jeff KingDec 15, 2020
  15. Felipe ContrerasDec 15, 2020
  16. Jeff KingDec 15, 2020
  17. Felipe ContrerasDec 15, 2020
  18. 2/2 contrib: vim: add sharness syntax fileFelipe Contreras, Dec 9, 2020
  19. Eric SunshineDec 9, 2020
  20. Felipe ContrerasDec 9, 2020
  21. Jeff KingDec 9, 2020
  22. Felipe ContrerasDec 10, 2020

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.