pair-mode 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Owen Carpenter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,209 @@
+# pair mode
+
+A coding agent proposes an edit. Pair mode opens a side-by-side diff in a terminal
+editor. Every line you type becomes a question the model must answer, and the edit
+does not apply until you close the editor.
+
+## Install
+
+```
+npm install -g pair-mode
+pair-mode setup
+```
+
+Install pair-mode globally before you run setup. Setup writes the install path into each
+CLI's config as an absolute path. `npx pair-mode setup` runs from a package cache that
+npm later prunes, which would leave every hook pointing at a deleted file. Setup detects
+that case and stops.
+
+The setup command detects the CLIs and multiplexers on your machine, registers the
+required hooks, and writes a config file. Restart Claude Code after setup, because
+Claude Code loads hooks only at startup.
+
+If you install from git instead of npm, run `pnpm build` first. The package does not
+ship a committed `dist/` directory; npm builds it fresh through the `prepublishOnly`
+script, but a git checkout does not run that script.
+
+## Supported CLIs
+
+| CLI         | Hook                                             | Status                                                                                        |
+| ----------- | ------------------------------------------------ | --------------------------------------------------------------------------------------------- |
+| Claude Code | `PreToolUse`, matcher `Write\|Edit\|MultiEdit`   | Shipped.                                                                                      |
+| Codex       | `PreToolUse`, matcher `apply_patch\|Edit\|Write` | Shipped.                                                                                      |
+| pi          | `tool_call` extension hook                       | Planned for 1.0.0. The adapter exists and passes its unit tests. Setup does not offer it yet. |
+| opencode    | `tool.execute.before` plugin hook                | Planned for 1.0.0. Nobody has run it against a live opencode. Setup does not offer it yet.    |
+
+Codex has no `MultiEdit` matcher alias. Its `apply_patch` parser reads single-file Add,
+Update, and Delete patches only. A multi-file or rename patch passes through untouched.
+
+## The /pair command
+
+`pair-mode setup` installs a `/pair` command for every CLI whose hook it registers. The
+command toggles pair mode for the current directory. It also tells the agent how a held
+edit comes back.
+
+| CLI         | Installed at                    | Invoked as              |
+| ----------- | ------------------------------- | ----------------------- |
+| Claude Code | `~/.claude/commands/pair.md`    | `/pair on`, `/pair off` |
+| Codex       | `~/.codex/skills/pair/SKILL.md` | `$pair on`, `$pair off` |
+
+Codex deprecated `~/.codex/prompts/` in favour of skills, so pair mode installs a skill
+there. Codex invokes a skill with `$`, not `/`.
+
+The command runs a bare `pair-mode`, unlike a hook, which each CLI invokes by absolute
+path. So `pair-mode` must resolve on your PATH. A global install puts it there.
+
+`pair-mode doctor` warns when the command is missing, and warns when `pair-mode` does not
+resolve on PATH. Neither warning raises the exit code.
+
+Setup backs up an existing file before it rewrites the file.
+
+## Editors
+
+| Editor         | Diff colour | Syntax colour on changed rows                                                                                                                                                                                                    |
+| -------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| pair (default) | Yes         | Yes. pair is the built-in review pane, so it paints syntax colour and change colour on the same row. It also reads mouse clicks and drags for selection, and it anchors a note to the exact span you select, not the whole line. |
+| micro          | Yes         | No. micro paints one highlight group per character, so a changed row trades syntax colour for the diff band.                                                                                                                     |
+| vim            | Yes         | Yes. `matchadd()` overlays the diff highlight on top of syntax, so a changed row keeps both.                                                                                                                                     |
+| nvim           | Yes         | Yes. Same `matchadd()` overlay as vim.                                                                                                                                                                                           |
+| nano           | Yes         | No. nano has no syntax engine here, so a changed row gets the diff band only.                                                                                                                                                    |
+
+Keys:
+
+- pair: see [Keymap](#keymap) below.
+- micro: Ctrl+W or F2 sends your annotations and closes the editor. F3 moves between
+  panes.
+- vim and nvim: `:wqa` sends your annotations and closes the editor.
+
+## Keymap
+
+These keys work inside the pair review pane. Some have a mouse equivalent; the rest are
+keyboard only.
+
+| Key                | Mouse equivalent | Action                                                                                                             |
+| ------------------ | ---------------- | ------------------------------------------------------------------------------------------------------------------ |
+| `j` `k` `↓` `↑`    | —                | Move the row cursor. A fold moves as one row.                                                                      |
+| `Ctrl+d` `Ctrl+u`  | —                | Page down and page up.                                                                                             |
+| `n` `N`            | —                | Jump to the next and the previous changed run.                                                                     |
+| `v`, then a motion | click and drag   | Select a span.                                                                                                     |
+| `a`                | —                | Open a note on the current selection, or on the current row if nothing is selected.                                |
+| `Enter`            | —                | Save the note.                                                                                                     |
+| `Esc`              | —                | Discard the note draft, or clear the current selection.                                                            |
+| `Tab`              | —                | Cycle the focused note.                                                                                            |
+| `d`                | —                | Delete the focused note.                                                                                           |
+| `Space`            | click a fold     | Expand or collapse a fold row.                                                                                     |
+| `u`                | —                | Swap between the split layout and the unified layout.                                                              |
+| `Ctrl+s`           | —                | Send the notes. The hook denies the edit.                                                                          |
+| `Ctrl+q` `Ctrl+c`  | —                | Quit. With no notes, the edit applies. With notes pending, asks: `s` sends, `d` discards and quits, `Esc` cancels. |
+| `?`                | —                | Toggle the keymap overlay.                                                                                         |
+
+zellij consumes the mouse scroll wheel, so pair mode never depends on it. `Ctrl+d` and
+`Ctrl+u` page instead.
+
+Holding `shift` during a click or drag passes the mouse event straight through to the
+terminal, which then selects text for copy — the same as any other terminal program.
+
+## Multiplexers
+
+Claude Code and Codex run their hooks with no controlling terminal. `/dev/tty` returns
+`ENXIO` there. Pane mode needs zellij or tmux to open an editor pane under those two
+CLIs.
+
+Session mode removes the requirement. See the next section.
+
+## Session modes
+
+Pane mode is the default. The hook opens an editor in a floating pane and blocks. That
+needs a multiplexer under Claude Code and Codex.
+
+Session mode moves the review out of the agent's process. The hook posts to a Unix
+socket and waits. A client you start renders the review and answers. There are two
+clients, and both remove the multiplexer requirement.
+
+Set `transport` to `"session"`, then pick a client.
+
+```
+pair-mode config transport session
+```
+
+`pair-mode config` with no argument prints every setting and its value. `pair-mode
+config <key>` prints one. `pair-mode config <key> <value>` changes one and validates it
+before it writes.
+
+**Watch mode** reviews in a terminal you own.
+
+```
+pair-mode watch          # in any terminal, at the repo root
+```
+
+The watcher paints an idle screen between reviews and opens the pair TUI for each one.
+`q` on the idle screen quits and releases the socket.
+
+**Web mode** reviews in a browser and needs no terminal at all.
+
+```
+pair-mode on --web       # prints a link
+```
+
+That spawns a detached watcher, binds an HTTP server on `127.0.0.1`, and prints a link
+carrying a random token. Drag across any text in the diff. A popup opens under the
+selection. Type the note and press Enter. `pair-mode off` stops the watcher.
+
+The watcher process binds the socket, so there is no separate daemon to manage. If the
+watcher dies, the socket goes away and every hook fails open at once.
+
+A hook that finds no watcher applies the edit rather than hanging. So does a hook whose
+watcher never answers within `session.timeout`.
+
+## Configuration
+
+Pair mode reads `$XDG_CONFIG_HOME/pair-mode/config.json`, or `~/.config/pair-mode/config.json`
+when `XDG_CONFIG_HOME` is not set.
+
+| Key               | Type                                                                                    | Default     | Meaning                                                          |
+| ----------------- | --------------------------------------------------------------------------------------- | ----------- | ---------------------------------------------------------------- |
+| `editor`          | `"auto" \| "pair" \| "micro" \| "nvim" \| "vim" \| "nano"`, or an array of editor names | `"auto"`    | Which editor opens the review pane.                              |
+| `multiplexer`     | `"auto" \| "zellij" \| "tmux" \| "none"`                                                | `"auto"`    | Which multiplexer hosts the pane.                                |
+| `transport`       | `"pane" \| "session"`                                                                   | `"pane"`    | Open a pane per edit, or post to a watcher you started.          |
+| `session.timeout` | integer, 1 or more                                                                      | `300`       | Seconds a hook waits for a verdict before it applies the edit.   |
+| `web.enabled`     | boolean                                                                                 | `false`     | Serve the review in a browser whenever a watcher starts.         |
+| `web.port`        | integer, 0 to 65535                                                                     | `0`         | `0` asks the operating system for a free port.                   |
+| `layout`          | `"split" \| "inline"`                                                                   | `"split"`   | Side-by-side columns, or one column.                             |
+| `notes`           | `"panel" \| "anchored"`                                                                 | `"panel"`   | A docked notes panel, or a note inline at its anchor.            |
+| `context`         | integer, 1 or more                                                                      | `5`         | Unchanged lines kept around a change before folding.             |
+| `minFold`         | integer, 1 or more                                                                      | `4`         | Minimum run of unchanged lines that folds.                       |
+| `pane.width`      | string                                                                                  | `"95%"`     |                                                                  |
+| `pane.height`     | string                                                                                  | `"95%"`     |                                                                  |
+| `theme.add`       | 6-digit hex colour                                                                      | `"#1e3a1e"` |                                                                  |
+| `theme.del`       | 6-digit hex colour                                                                      | `"#3a1e1e"` |                                                                  |
+| `theme.fold`      | 6-digit hex colour                                                                      | `"#2a2a2a"` |                                                                  |
+| `theme.rowBand`   | boolean                                                                                 | `true`      | Paint the whole changed row, not just the changed span, in pair. |
+| `syntax`          | boolean                                                                                 | `true`      | Load Shiki for syntax colour in pair.                            |
+| `trace`           | boolean                                                                                 | `false`     |                                                                  |
+| `autoApprove`     | boolean                                                                                 | `true`      |                                                                  |
+
+An `editor` array lists editor names in order of preference. Pair mode tries each in
+turn and uses the first one it finds on the machine. `auto` tries `pair` first, so an
+existing config with no `editor` key now opens pair mode's own pane by default.
+
+`notes` and `layout` both describe position, and they are easy to confuse. `layout`
+controls the diff itself — split into two columns, or one inline column. `notes`
+controls only where a note you write renders — in a docked panel, or anchored next to
+the span it annotates. Setting one does not affect the other.
+
+## Limits
+
+- Pair mode opens one pane per tool call. It cannot batch a changeset, because a hook
+  returns one verdict per call and an allow cannot be withdrawn.
+- The pane reviews. It does not edit the proposal.
+- Syntax colour in pair needs `shiki` installed. A missing package disables colour and
+  the pane still works.
+- A client answers one review at a time. It cannot skip ahead in the queue.
+- Web mode does not defend against another user on the same machine. The token sits in
+  the URL, and a local user can read the process list.
+- Watch mode needs the watcher running before the agent edits. A missing watcher fails
+  open, so an unattended agent applies its edits.
+
+## License
+
+MIT. See `LICENSE`.

package/assets/syntax/c.yaml

@@ -0,0 +1,59 @@
+filetype: c
+
+detect:
+  filename: "(\\.(c|C)$|\\.(h|H)$|\\.ii?$|\\.(def)$)"
+
+rules:
+  - identifier: "\\b[A-Z_][0-9A-Z_]+\\b"
+  - type: "\\b(_Atomic|_BitInt|float|double|_Decimal32|_Decimal64|_Decimal128|_Complex|complex|_Imaginary|imaginary|_Bool|bool|char|int|short|long|enum|void|struct|union|typedef|typeof|typeof_unqual|(un)?signed|inline|_Noreturn)\\b"
+  - type: "\\b((s?size)|((u_?)?int(8|16|32|64|ptr))|char(8|16|32)|wchar)_t\\b"
+    # GCC float/decimal/fixed types
+  - type: "\\b(_Float16|__fp16|_Float32|_Float32x|_Float64|_Float64x|__float80|_Float128|_Float128x|__float128|__ibm128|__int128|_Fract|_Sat|_Accum)\\b"
+  - type: "\\b[a-z_][0-9a-z_]+(_t|_T)\\b"
+  - statement: "\\b(auto|volatile|register|restrict|_Alignas|alignas|_Alignof|alignof|static|const|constexpr|extern|_Thread_local|thread_local)\\b"
+  - statement: "\\b(for|if|while|do|else|case|default|switch|_Generic|_Static_assert|static_assert)\\b"
+  - statement: "\\b(goto|continue|break|return)\\b"
+  - statement: "\\b(asm|fortran)\\b"
+  - preproc: "^[[:space:]]*#[[:space:]]*(define|embed|pragma|include|(un|ifn?)def|endif|el(if|ifdef|ifndef|se)|if|line|warning|error|__has_include|__has_embed|__has_c_attribute)"
+  - preproc: "^[[:space:]]*_Pragma\\b"
+    # GCC builtins
+  - statement: "__attribute__[[:space:]]*\\(\\([^)]*\\)\\)"
+  - statement: "__(aligned|asm|builtin|extension|hidden|inline|packed|restrict|section|typeof|weak)__"
+    # Operator Color
+  - symbol.operator: "[-+*/%=<>.:;,~&|^!?]|\\b(offsetof|sizeof)\\b"
+  - symbol.brackets: "[(){}]|\\[|\\]"
+    # Integer Constants
+  - constant.number: "(\\b([1-9][0-9]*|0[0-7]*|0[Xx][0-9A-Fa-f]+|0[Bb][01]+)([Uu][Ll]?[Ll]?|[Ll][Ll]?[Uu]?)?\\b)"
+    # Decimal Floating Constants
+  - constant.number: "(\\b(([0-9]*[.][0-9]+|[0-9]+[.][0-9]*)([Ee][+-]?[0-9]+)?|[0-9]+[Ee][+-]?[0-9]+)[FfLl]?\\b)"
+    # Hexadecimal Floating Constants
+  - constant.number: "(\\b0[Xx]([0-9A-Za-z]*[.][0-9A-Za-z]+|[0-9A-Za-z]+[.][0-9A-Za-z]*)[Pp][+-]?[0-9]+[FfLl]?\\b)"
+  - constant.bool: "(\\b(true|false|NULL|nullptr|TRUE|FALSE)\\b)"
+
+  - constant.string:
+      start: '"'
+      end: '"'
+      skip: "\\\\."
+      rules:
+        - constant.specialChar: "\\\\([\"'abfnrtv\\\\]|[0-3]?[0-7]{1,2}|x[0-9A-Fa-f]{1,2}|u[0-9A-Fa-f]{4}|U[0-9A-Fa-f]{8})"
+
+  - constant.string:
+      start: "'"
+      end: "'"
+      skip: "\\\\."
+      rules:
+        # TODO: Revert back to - error: "..+" once #3127 is merged
+        - error: "[[:graph:]]{2,}'"
+        - constant.specialChar: "\\\\([\"'abfnrtv\\\\]|[0-3]?[0-7]{1,2}|x[0-9A-Fa-f]{1,2}|u[0-9A-Fa-f]{4}|U[0-9A-Fa-f]{8})"
+
+  - comment:
+      start: "//"
+      end: "$"
+      rules:
+        - todo: "(TODO|XXX|FIXME):?"
+
+  - comment:
+      start: "/\\*"
+      end: "\\*/"
+      rules:
+        - todo: "(TODO|XXX|FIXME):?"

package/assets/syntax/css.yaml

@@ -0,0 +1,43 @@
+filetype: css
+
+detect:
+  filename: "\\.(css|scss)$"
+
+rules:
+  # Classes and IDs
+  - statement: "(?i)."
+  # - normal:
+  #     start: "\\{"
+  #     end: "\\}"
+  #     rules: []
+  # css commands
+  - type: "(align-content|align-items|alignment-baseline|align-self|all|animation|animation-delay|animation-direction|animation-duration|animation-fill-mode|animation-iteration-count|animation-name|animation-play-state|animation-timing-function|appearance|azimuth|backdrop-filter|backface-visibility|background|background-attachment|background-blend-mode|background-clip|background-color|background-image|background-origin|background-position|background-repeat|background-size|baseline-shift|bookmark-label|bookmark-level|bookmark-state|border|border-bottom|border-bottom-color|border-bottom-left-radius|border-bottom-right-radius|border-bottom-style|border-bottom-width|border-boundary|border-collapse|border-color|border-image|border-image-outset|border-image-repeat|border-image-slice|border-image-source|border-image-width|border-left|border-left-color|border-left-style|border-left-width|border-radius|border-right|border-right-color|border-right-style|border-right-width|border-spacing|border-style|border-top|border-top-color|border-top-left-radius|border-top-right-radius|border-top-style|border-top-width|border-width|bottom|box-decoration-break|box-shadow|box-sizing|box-snap|box-suppress|break-after|break-before|break-inside|caption-side|caret|caret-animation|caret-color|caret-shape|chains|clear|clip|clip-path|clip-rule|color|color-interpolation-filters|column-count|column-fill|column-gap|column-rule|column-rule-color|column-rule-style|column-rule-width|columns|column-span|column-width|content|continue|counter-increment|counter-reset|counter-set|cue|cue-after|cue-before|cursor|direction|display|dominant-baseline|elevation|empty-cells|filter|flex|flex-basis|flex-direction|flex-flow|flex-grow|flex-shrink|flex-wrap|float|float-defer|float-offset|float-reference|flood-color|flood-opacity|flow|flow-from|flow-into|font|font-family|font-feature-settings|font-kerning|font-language-override|font-size|font-size-adjust|font-stretch|font-style|font-synthesis|font-variant|font-variant-alternates|font-variant-caps|font-variant-east-asian|font-variant-ligatures|font-variant-numeric|font-variant-position|font-weight|footnote-display|footnote-policy|gap|glyph-orientation-vertical|grid|grid-area|grid-auto-columns|grid-auto-flow|grid-auto-rows|grid-column|grid-column-end|grid-column-gap|grid-column-start|grid-gap|grid-row|grid-row-end|grid-row-gap|grid-row-start|grid-template|grid-template-areas|grid-template-columns|grid-template-rows|hanging-punctuation|height|hyphenate-character|hyphenate-limit-chars|hyphenate-limit-last|hyphenate-limit-lines|hyphenate-limit-zone|hyphens|image-orientation|image-rendering|image-resolution|initial-letter|initial-letter-align|initial-letter-wrap|isolation|justify-content|justify-items|justify-self|left|letter-spacing|lighting-color|line-break|line-grid|line-height|line-snap|list-style|list-style-image|list-style-position|list-style-type|margin|margin-bottom|margin-left|margin-right|margin-top|marker|marker-end|marker-knockout-left|marker-knockout-right|marker-mid|marker-pattern|marker-segment|marker-side|marker-start|marquee-direction|marquee-loop|marquee-speed|marquee-style|mask|mask-border|mask-border-mode|mask-border-outset|mask-border-repeat|mask-border-slice|mask-border-source|mask-border-width|mask-clip|mask-composite|mask-image|mask-mode|mask-origin|mask-position|mask-repeat|mask-size|mask-type|max-height|max-lines|max-width|min-height|min-width|mix-blend-mode|motion|motion-offset|motion-path|motion-rotation|nav-down|nav-left|nav-right|nav-up|object-fit|object-position|offset-after|offset-before|offset-end|offset-start|opacity|order|orphans|outline|outline-color|outline-offset|outline-style|outline-width|overflow|overflow-style|overflow-wrap|overflow-x|overflow-y|padding|padding-bottom|padding-left|padding-right|padding-top|page|page-break-after|page-break-before|page-break-inside|pause|pause-after|pause-before|perspective|perspective-origin|pitch|pitch-range|play-during|pointer-events|polar-anchor|polar-angle|polar-distance|polar-origin|position|presentation-level|quotes|region-fragment|resize|rest|rest-after|rest-before|richness|right|rotation|rotation-point|ruby-align|ruby-merge|ruby-position|running|scrollbar-color|scroll-behavior|scroll-snap-align|scroll-snap-margin|scroll-snap-margin-block|scroll-snap-margin-block-end|scroll-snap-margin-block-start|scroll-snap-margin-bottom|scroll-snap-margin-inline|scroll-snap-margin-inline-end|scroll-snap-margin-inline-start|scroll-snap-margin-left|scroll-snap-margin-right|scroll-snap-margin-top|scroll-snap-padding|scroll-snap-padding-block|scroll-snap-padding-block-end|scroll-snap-padding-block-start|scroll-snap-padding-bottom|scroll-snap-padding-inline|scroll-snap-padding-inline-end|scroll-snap-padding-inline-start|scroll-snap-padding-left|scroll-snap-padding-right|scroll-snap-padding-top|scroll-snap-type|shape-image-threshold|shape-inside|shape-margin|shape-outside|size|speak|speak-as|speak-header|speak-numeral|speak-punctuation|speech-rate|stress|string-set|stroke|stroke-alignment|stroke-dashadjust|stroke-dasharray|stroke-dashcorner|stroke-dashoffset|stroke-linecap|stroke-linejoin|stroke-miterlimit|stroke-opacity|stroke-width|table-layout|tab-size|text-align|text-align-all|text-align-last|text-combine-upright|text-decoration|text-decoration-color|text-decoration-line|text-decoration-skip|text-decoration-style|text-emphasis|text-emphasis-color|text-emphasis-position|text-emphasis-style|text-indent|text-justify|text-orientation|text-overflow|text-shadow|text-space-collapse|text-space-trim|text-spacing|text-transform|text-underline-offset|text-underline-position|text-wrap|top|transform|transform-box|transform-origin|transform-style|transition|transition-delay|transition-duration|transition-property|transition-timing-function|unicode-bidi|user-select|vertical-align|visibility|voice-balance|voice-duration|voice-family|voice-pitch|voice-range|voice-rate|voice-stress|voice-volume|volume|white-space|widows|width|will-change|word-break|word-spacing|word-wrap|wrap-after|wrap-before|wrap-flow|wrap-inside|wrap-through|writing-mode|z-index):"
+  # - default:
+  #     start: ":"
+  #     end: "[;^\\{]"
+  #     rules: []
+  - special: "!important"
+  - identifier: ":active|:focus|:hover|:link|:visited|:link|:after|:before|$"
+  - special: "(\\{|\\}|\\(|\\)|\\;|:|\\]|~|<|>|,)"
+  # SCSS Varaibles
+  - statement: "@import|@mixin|@extend"
+  # Strings
+  - constant.string:
+      start: '"'
+      end: '"'
+      skip: "\\\\."
+      rules:
+        - constant.specialChar: "\\\\."
+  - constant.string:
+      start: "'"
+      end: "'"
+      skip: "\\\\."
+      rules:
+        - constant.specialChar: "\\\\."
+  - special: '"|'''
+  # Comments & TODOs
+  - comment:
+      start: "\\/\\*"
+      end: "\\*\\/"
+      rules:
+        - todo: "(TODO|XXX|FIXME):?"

package/assets/syntax/dockerfile.yaml

@@ -0,0 +1,35 @@
+filetype: dockerfile
+
+detect:
+  filename: "((Docker|Container)file[^/]*$|\\.(docker|container)file$)"
+
+rules:
+  ## Keywords
+  - type.keyword: "(?i)^(FROM|MAINTAINER|RUN|CMD|LABEL|EXPOSE|ENV|ADD|COPY|ENTRYPOINT|VOLUME|USER|WORKDIR|ONBUILD|ARG|HEALTHCHECK|STOPSIGNAL|SHELL)[[:space:]]"
+
+    ## Brackets & parenthesis
+  - statement: "(\\(|\\)|\\[|\\])"
+
+    ## Double ampersand
+  - special: "&&"
+
+    ## Comments
+  - comment:
+      start: "#"
+      end: "$"
+      rules:
+        - todo: "(TODO|XXX|FIXME):?"
+
+  - constant.string:
+      start: '"'
+      end: '"'
+      skip: "\\\\."
+      rules:
+        - constant.specialChar: "\\\\."
+
+  - constant.string:
+      start: "'"
+      end: "'"
+      skip: "\\\\."
+      rules:
+        - constant.specialChar: "\\\\."

package/assets/syntax/elixir.yaml

@@ -0,0 +1,30 @@
+filetype: elixir
+
+detect:
+  filename: "\\.ex$|\\.exs$"
+
+rules:
+  - statement: "\\b(abs|trunc|rem|div|round|max|min|and|or|not|throw|raise|reraise|hd|tl|in|length|elem|put_elem|destructure|to_(string|charlist)|is_(atom|binary|bitstring|boolean|float|function|integer|list|map|nil|number|pid|port|reference|tuple)|(bit|byte|map|tuple)_size|binary_part|def(delegate|exception|guard|guardp|impl|macro|macrop|module|overridable|p|protocol|struct)?|sigil_[crswCRSWDNT]|if|else|unless|cond|binding|node|self|spawn|spawn_link|spawn_monitor|send|exit|struct|get_and_update_in|get_in|put_in|pop_in|update_in|apply|inspect|make_ref|use|do|end)\\b"
+  - statement: "\\b(alias|import|require|case|fn|receive|after|try|catch|rescue|super|quote|unquote|unquote_splicing|for|with)\\b"
+
+  - constant: "\\b\\[A-Z]+\\b"
+  - constant.number: "\\b[0-9]+\\b"
+
+  - constant.string: "`[^`]*`|%x\\{[^}]*\\}"
+  - constant.string: "\"([^\"]|(\\\\\"))*\"|%[QW]?\\{[^}]*\\}|%[QW]?\\([^)]*\\)|%[QW]?<[^>]*>|%[QW]?\\[[^]]*\\]|%[QW]?\\$[^$]*\\$|%[QW]?\\^[^^]*\\^|%[QW]?![^!]*!"
+  - constant.string: "'([^']|(\\\\'))*'|%[qw]\\{[^}]*\\}|%[qw]\\([^)]*\\)|%[qw]<[^>]*>|%[qw]\\[[^]]*\\]|%[qw]\\$[^$]*\\$|%[qw]\\^[^^]*\\^|%[qw]![^!]*!"
+
+  - symbol.brackets: "\\{|\\}|\\[|\\]|\\(|\\)"
+
+  - comment: "#[^{].*$|#$"
+  - comment.bright: "##[^{].*$|##$"
+
+  - type.keyword: "\\:[a-zA-Z][a-zA-Z0-9_]*"
+  - type.keyword: "\\b(describe|test)"
+  - statement: "\\b(expected|assert|assert_raise|assert_in_delta|assert_received|catch_error|catch_throw|flunk|refute|refute_in_delta|refute_received)\\b"
+  - symbol.tag: "^\\s*\\@[a-zA-Z][a-zA-Z0-9_]*\\b"
+
+  - identifier.macro: "\\b(__CALLER__|__DIR__|__ENV__|__MODULE__|__aliases__|__block__|defmacro)\\b"
+
+  - todo: "(XXX|TODO|FIXME|\\?\\?\\?)"
+  - preproc.shebang: "\\W*#!.+?( |$)"

package/assets/syntax/fish.yaml

@@ -0,0 +1,47 @@
+filetype: fish
+
+detect:
+  filename: "\\.fish$"
+  header: "^#!.*/(env +)?fish( |$)"
+
+rules:
+  # Numbers
+  - constant: "\\b[0-9]+\\b"
+
+    # Conditionals and control flow
+  - statement: "\\b(and|begin|break|case|continue|else|end|for|function|if|in|not|or|return|select|shift|switch|while)\\b"
+  - special: "(\\{|\\}|\\(|\\)|\\;|\\]|\\[|`|\\\\|\\$|<|>|^|!|=|&|\\|)"
+
+    # Fish commands
+  - type: "\\b(bg|bind|block|breakpoint|builtin|cd|count|command|commandline|complete|dirh|dirs|echo|emit|eval|exec|exit|fg|fish|fish_config|fish_ident|fish_pager|fish_prompt|fish_right_prompt|fish_update_completions|fishd|funced|funcsave|functions|help|history|jobs|math|mimedb|nextd|open|popd|prevd|psub|pushd|pwd|random|read|set|set_color|source|status|string|trap|type|ulimit|umask|vared)\\b"
+
+    # Common linux commands
+  - type: "\\b((g|ig)?awk|bash|dash|find|\\w{0,4}grep|kill|killall|\\w{0,4}less|make|pkill|sed|sh|tar)\\b"
+
+    # Coreutils commands
+  - type: "\\b(base64|basename|cat|chcon|chgrp|chmod|chown|chroot|cksum|comm|cp|csplit|cut|date|dd|df|dir|dircolors|dirname|du|env|expand|expr|factor|false|fmt|fold|head|hostid|id|install|join|link|ln|logname|ls|md5sum|mkdir|mkfifo|mknod|mktemp|mv|nice|nl|nohup|nproc|numfmt|od|paste|pathchk|pinky|pr|printenv|printf|ptx|pwd|readlink|realpath|rm|rmdir|runcon|seq|(sha1|sha224|sha256|sha384|sha512)sum|shred|shuf|sleep|sort|split|stat|stdbuf|stty|sum|sync|tac|tail|tee|test|time|timeout|touch|tr|true|truncate|tsort|tty|uname|unexpand|uniq|unlink|users|vdir|wc|who|whoami|yes)\\b"
+
+    # Conditional flags
+  - statement: "--[a-z-]+"
+  - statement: "\\ -[a-z]+"
+
+  - identifier: "(?i)\\{?\\$[0-9A-Z_!@#$*?-]+\\}?"
+
+  - constant.string:
+      start: '"'
+      end: '"'
+      skip: "\\\\."
+      rules:
+        - constant.specialChar: "\\\\."
+
+  - constant.string:
+      start: "'"
+      end: "'"
+      skip: "\\\\."
+      rules: []
+
+  - comment:
+      start: "#"
+      end: "$"
+      rules:
+        - todo: "(TODO|XXX|FIXME):?"

package/assets/syntax/go.yaml

@@ -0,0 +1,62 @@
+filetype: go
+
+detect:
+  filename: "\\.go$"
+
+rules:
+  # Conditionals and control flow
+  - special: "\\b(break|case|continue|default|go|goto|range|return|println|fallthrough)\\b"
+  - statement: "\\b(else|for|if|switch|select)\\b"
+  - preproc: "\\b(package|import|const|var|type|struct|func|defer|iota|make|new|copy|len|cap|panic|append|close|delete|print|recover)\\b"
+  - symbol.operator: "[-+/*=<>!~%&|^]|:="
+
+    # Types
+  - symbol: "(,|\\.)"
+  - type: "\\b(u?int(8|16|32|64)?|float(32|64)|complex(64|128))\\b"
+  - type: "\\b(uintptr|byte|rune|string|interface|bool|map|chan|error)\\b"
+  - type.keyword: "\\b(struct)\\b"
+  - constant.bool: "\\b(true|false|nil)\\b"
+
+    # Brackets
+  - symbol.brackets: "(\\{|\\})"
+  - symbol.brackets: "(\\(|\\))"
+  - symbol.brackets: "(\\[|\\])"
+
+    # Numbers and strings
+  - constant.number: "\\b([0-9]+|0x[0-9a-fA-F]*)\\b|'.'"
+
+  - constant.string:
+      start: '"'
+      end: '"'
+      skip: "\\\\."
+      rules:
+        - constant.specialChar: "%."
+        - constant.specialChar: "\\\\[abfnrtv'\\\"\\\\]"
+        - constant.specialChar: "\\\\([0-7]{3}|x[A-Fa-f0-9]{2}|u[A-Fa-f0-9]{4}|U[A-Fa-f0-9]{8})"
+
+  - constant.string:
+      start: "'"
+      end: "'"
+      skip: "\\\\."
+      rules:
+        - error: "..+"
+        - constant.specialChar: "%."
+        - constant.specialChar: "\\\\[abfnrtv'\\\"\\\\]"
+        - constant.specialChar: "\\\\([0-7]{3}|x[A-Fa-f0-9]{2}|u[A-Fa-f0-9]{4}|U[A-Fa-f0-9]{8})"
+
+  - constant.string:
+      start: "`"
+      end: "`"
+      rules: []
+
+  - comment:
+      start: "//"
+      end: "$"
+      rules:
+        - todo: "(TODO|XXX|FIXME):?"
+
+  - comment:
+      start: "/\\*"
+      end: "\\*/"
+      rules:
+        - todo: "(TODO|XXX|FIXME):?"

package/assets/syntax/html.yaml

@@ -0,0 +1,70 @@
+filetype: html
+
+detect:
+  filename: "\\.htm[l]?$"
+
+rules:
+  # Doctype is case-insensitive
+  - preproc: "<!(?i)(DOCTYPE html.*)>"
+  # Opening tag
+  - symbol.tag:
+      start: "<(a|abbr|acronym|address|applet|area|article|aside|audio|b|base|bdi|bdo|big|blockquote|body|br|button|canvas|caption|center|cite|code|col|colgroup|command|datalist|dd|del|details|dfn|dialog|dir|div|dl|dt|em|embed|fieldset|figcaption|figure|font|footer|form|frame|frameset|h[1-6]|head|header|hgroup|hr|html|i|iframe|img|input|ins|kbd|keygen|label|legend|li|link|map|main|mark|menu|meta|meter|nav|noframes|noscript|object|ol|optgroup|option|output|p|param|pre|progress|q|rp|rt|ruby|s|samp|section|select|small|source|span|strike|strong|sub|summary|sup|table|tbody|td|textarea|tfoot|th|thead|time|title|tr|track|tt|u|ul|var|video|wbr)\\b"
+      end: ">"
+      rules:
+        - identifier: "\\b(placeholder|style|alt|bgcolor|height|href|id|(aria|data)\\-.+|label|longdesc|name|on(click|focus|load|mouseover)|size|span|src|target|type|value|width|class|charset|content|rel|integrity|crossorigin|for|onsubmit|lang|role)\\b"
+        - special: "\\b(required)\\b"
+        # Match double-quote strings
+        - constant.string:
+            start: '"'
+            end: '"'
+            skip: "\\\\."
+            rules:
+              - constant.specialChar: "\\\\."
+              - constant.string.url: "((ftp(s)?|http(s)?|git|chrome)://[^\\s]+)"
+        # Match single-quote strings
+        - constant.string:
+            start: "'"
+            end: "'"
+            skip: "\\\\."
+            rules:
+              - constant.specialChar: "\\\\."
+              - constant.string.url: "((ftp(s)?|http(s)?|git|chrome)://[^\\s]+)"
+        # Highlight the equals and any colon between words
+        - symbol: "\\b(=|:\\b)"
+
+  # Closing tag
+  - symbol.tag:
+      start: "</(a|abbr|acronym|address|applet|area|article|aside|audio|b|base|bdi|bdo|big|blockquote|body|br|button|canvas|caption|center|cite|code|col|colgroup|command|datalist|dd|del|details|dfn|dialog|dir|div|dl|dt|em|embed|fieldset|figcaption|figure|font|footer|form|frame|frameset|h[1-6]|head|header|hgroup|hr|html|i|iframe|img|input|ins|kbd|keygen|label|legend|li|link|map|main|mark|menu|meta|meter|nav|noframes|noscript|object|ol|optgroup|option|output|p|param|pre|progress|q|rp|rt|ruby|s|samp|section|select|small|source|span|strike|strong|sub|summary|sup|table|tbody|td|textarea|tfoot|th|thead|time|title|tr|track|tt|u|ul|var|video|wbr)\\b"
+      end: ">"
+      rules:
+        # Anything in the closing tag is an error
+        - error: "."
+
+  # Reserved entities like a&#12; &nbsp; and &#x12A;
+  - special: "(([a-zA-Z]&#[0-9]+|&[a-zA-Z]+|&#[a-zA-Z0-9]+);)"
+
+  # TODO: Add `limit-rules` to both the `default` rules below once it's implemented into Micro
+  - default:
+      start: "<script.*?>"
+      end: "</script.*?>"
+      limit-group: symbol.tag
+      rules:
+        - include: "javascript"
+
+  - default:
+      start: "<style.*?>"
+      end: "</style.*?>"
+      limit-group: symbol.tag
+      rules:
+        - include: "css"
+
+  # This weird empty comment thing is technically valid
+  - comment: "<!>"
+
+  - comment.block:
+      start: "<!\\-\\-"
+      end: "\\-\\->"
+      rules:
+        - todo: "(FIXME|NOTE|TODO):?"
+        # While technically not a "true" error, these are recommended to not be used inside a comment
+        - error: "(\\-\\-|>)"