Skip to content

Commit

Permalink
dev docs: Create HACKING.md.
Browse files Browse the repository at this point in the history
Review-by: Matthew Martin
  • Loading branch information
danielshahaf committed May 5, 2016
1 parent e8af14f commit cef4975
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions HACKING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
Hacking on zsh-syntax-highlighting itself
=========================================

This document includes information for people working on z-sy-h itself: on the
core driver (`zsh-syntax-highlighting.zsh`), on the highlighters in the
distribution, and on the test suite. It does not target third-party
highlighter authors (although they may find it an interesting read).

The 'main' highlighter
----------------------

The following function `pz` is useful when working on the `main` highlighting:

pq() {
(( $#argv )) || return 0
print -r -l -- ${(qqqq)argv}
}
pz() {
local arg
for arg; do
pq ${(z)arg}
done
}

It prints, for each argument, its token breakdown, similar to how the main
loop of the `main` highlighter sees it.

IRC channel
-----------

We're on #zsh-syntax-highlighting on freenode.

0 comments on commit cef4975

Please sign in to comment.