how write vim search() function pattern to include ‘ and “

by

Summary

This incident revolves around a Vim regex pattern that fails when both ' and " must be included inside a search() function call. The failure manifests as E116: Invalid arguments for function search(...), caused by incorrect escaping inside single‑quoted Vimscript strings.

Root Cause

The underlying issue is improper escaping of quotes inside a single‑quoted Vimscript string. In Vimscript:

  • Single‑quoted strings do not interpret backslashes, except when escaping a single quote itself.
  • Patterns containing ' or " require different escaping rules depending on the quoting style.
  • The user attempted to escape characters as if Vimscript behaved like shell or typical regex engines.

Why This Happens in Real Systems

Real systems often fail in similar ways due to:

  • Incorrect assumptions about string‑escaping rules
  • Mixing regex escaping with language‑level escaping
  • Using the wrong quoting style for complex patterns
  • Underestimating how Vimscript treats backslashes inside single quotes

Real-World Impact

These mistakes can lead to:

  • Searches silently failing
  • Functions returning unexpected values
  • Debugging time wasted on “invisible” escaping issues
  • Broken automation in scripts or plugins

Example or Code (if necessary and relevant)

A correct version of the user’s search pattern must use double‑quoted strings, because only they allow proper escaping of backslashes:

echo search("\l[,;\"'\\-]* \u\l\+", "ceW")

How Senior Engineers Fix It

Experienced engineers typically:

  • Switch to double‑quoted strings when regex complexity increases
  • Escape only what Vimscript requires, not what other languages require
  • Test patterns incrementally before embedding them in functions
  • Use :help expr-quote and :help pattern-overview to verify escaping rules

Why Juniors Miss It

Common reasons include:

  • Assuming Vimscript behaves like JavaScript, Python, or shell
  • Not realizing that single‑quoted strings disable backslash escaping
  • Confusing regex escaping with string escaping
  • Lack of familiarity with Vim’s unique quoting rules

Leave a Comment