docs: release

Author: justinmk

README.md

@@ -1,40 +1,40 @@
 tree-sitter-vimdoc
 ==================
 
-This grammar intentionally support a subset of the vimdoc "spec"
+This grammar implements the vimdoc "spec"
 ([ref1](https://neovim.io/doc/user/helphelp.html#help-writing),
-[ref2](https://github.com/nanotee/vimdoc-notes));
-predictable results are the primary goal, so that _output_ formats (e.g. HTML)
+[ref2](https://github.com/nanotee/vimdoc-notes)).
+Predictable results are the primary goal, so that _output_ formats (e.g. HTML)
 are well-formed; the _input_ (vimdoc) is secondary. The first step should
 always be to try to fix the input rather than insist on a grammar that handles
 vimdoc's endless quirks.
 
 Overview
 --------
 
-- `block` is the main top-level node which contains `line` and `line_li` nodes.
-  - delimited by blank line(s) or any line starting with `<` (codeblock terminator).
+- `block` is the main top-level node, delimited by blank line(s) or any line
+  starting with `<` (codeblock terminator).
+  - contains `line` and `line_li` nodes.
 - `line`:
   - contains atoms (words, tags, taglinks, …)
-  - contains headings (`h1`, `h2`, `h3`) because `codeblock` terminated by
-    "implicit stop" (no terminating `<`) consumes blank lines, so `block` has
-    no way to end.
-  - contains `column_heading` because `<` (the `codeblock` terminating char)
-    can appear at the start of `column_heading`.
+  - contains headings (`h1`, `h2`, `h3`, `column_heading`) because `codeblock`
+    terminated by "implicit stop" (no terminating `<`) consumes blank lines, so
+    `block` has no way to end.
 - `line_li` ("list item")
   - consumes lines until blank line, codeblock, or next listitem.
   - nesting is ignored: indented listitems are parsed as siblings.
 - `codeblock`:
-  - contained by `line` or `line_li`. Because ">" can start
-    a codeblock at the end of any line.
-  - contains `line` nodes without `word` nodes, it's just the full
-    raw text line including whitespace. This is somewhat dictated by its
-    "preformatted" nature; parsing the contents would require loading a "child"
-    language (injection). See [#2](https://github.com/neovim/tree-sitter-vimdoc/issues/2).
+  - contained by `line` or `line_li`, because ">" can start a codeblock at the
+    end of any line.
+  - contains `line` nodes without `word` nodes: it's just the full raw text
+    line including whitespace. This is somewhat dictated by its "preformatted"
+    nature; parsing the contents would require loading a "child" language
+    (injection). See [#2](https://github.com/neovim/tree-sitter-vimdoc/issues/2).
   - the terminating `<` (and any following whitespace) is discarded (anonymous).
 - `h1` = "Heading 1": `======` followed by text and optional `*tags*`.
 - `h2` = "Heading 2": `------` followed by text and optional `*tags*`.
-- `h3` = "Heading 3": only UPPERCASE WORDS, followed by optional `*tags*`.
+- `h3` = "Heading 3": UPPERCASE WORDS, followed by optional `*tags*`, followed
+  by atoms.
 
 Known issues
 ------------
@@ -47,8 +47,7 @@ Known issues
 - `url` doesn't handle _surrounding_ parens. E.g. `(https://example.com/#yay)` yields `word`
 - `url` doesn't handle _nested_ parens. E.g. `(https://example.com/(foo)#yay)`
 - `column_heading` currently only recognizes tilde `~` preceded by space (i.e.
-  `foo ~` not `foo~`). This covers 99% of :help files, but the grammar should
-  probably support "foo~" also.
+  `foo ~` not `foo~`). This covers 99% of :help files.
 - `column_heading` children should be plaintext. Currently its children are parsed as `$._atom`.
 
 TODO
@@ -57,3 +56,22 @@ TODO
 - `line_modeline` ?
 - `tag_heading` : line(s) containing only tags, typically implies a "heading"
   before a block.
+
+Release
+-------
+
+Steps to perform a release:
+
+1. Bump and tag the version (choose `patch`/`minor`/`major` as appropriate).
+   ```
+   npm version patch -m "release %s"
+   ```
+2. Bump to prerelease, without creating a tag .
+   ```
+   npm version --no-git-tag-version prerelease --preid dev && git add package*.json && git commit -m bump
+   ```
+3. Push.
+   ```
+   git push --follow-tags
+   ```
+4. Release the tagged commit: https://github.com/neovim/tree-sitter-vimdoc/releases/new

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "tree-sitter-vimdoc",
-  "version": "1.2.4",
+  "version": "1.2.5",
   "description": "Tree-sitter parser for Vim help files",
   "main": "bindings/node",
   "scripts": {