Generate DOC.md from annotations

.github/workflows/push.yaml

@@ -14,16 +14,8 @@ jobs:
         with:
           repository: ${{ github.event.pull_request.head.repo.full_name }}
           ref: ${{ github.head_ref }}
-      - name: panvimdoc
-        uses: kdheepak/panvimdoc@main
-        with:
-          vimdoc: luasnip
-          pandoc: DOC.md
-      - run: |
-          sudo add-apt-repository ppa:neovim-ppa/stable
-          sudo apt-get update
-          sudo apt-get install -y neovim
-          nvim +"helptags doc | exit"
+      - uses: nixbuild/nix-quick-install-action@v30
+      - run: nix develop -i -c bash -c 'make doc'
 
       - uses: stefanzweifel/git-auto-commit-action@v4
         with:

.github/workflows/spell.yaml

@@ -1,4 +1,3 @@
----
 name: Check spelling
 
 on:
@@ -9,4 +8,9 @@ jobs:
   spellcheck:
     runs-on: ubuntu-latest
     steps:
-      - uses: gevhaz/[email protected]
+      - uses: actions/checkout@v3
+        with:
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+          ref: ${{ github.head_ref }}
+      - uses: nixbuild/nix-quick-install-action@v30
+      - run: nix develop -i -c bash -c 'make spellcheck'

.gitignore

@@ -5,3 +5,4 @@
 /deps/luasnip-jsregexp.so
 /lua/luasnip-jsregexp.lua
 /.aspell.en.prepl
+/doc.json

Makefile

@@ -137,6 +137,24 @@ test_nix: nvim install_jsregexp
 	if ${TEST_MASTER}; then nix develop .#test_nvim_master -c make test; fi;
 
 spellcheck:
-	# grabbed from word-warden.
-	aspell --home-dir . --mode markdown --lang en --personal ./.github/data/project-dictionary.txt check DOC.md
-	aspell --home-dir . --mode markdown --lang en --personal ./.github/data/project-dictionary.txt check README.md
+# grabbed from word-warden.
+	# Misspelled words will appear inside the following tests:
+	if [ -n "$(shell aspell --home-dir . --encoding=utf-8 --mode markdown --lang en_US --personal ./data/project-dictionary.txt list < README.md)" ]; then exit 1; fi;
+	if [ -n "$(shell aspell --home-dir . --encoding=utf-8 --mode markdown --lang en_US --personal ./data/project-dictionary.txt list < DOC.md)" ]; then exit 1; fi;
+
+spellcheck_interactive:
+	aspell --home-dir . --encoding=utf-8 --mode markdown --lang en_US --personal ./data/project-dictionary.txt check DOC.md
+	aspell --home-dir . --encoding=utf-8 --mode markdown --lang en_US --personal ./data/project-dictionary.txt check README.md
+
+.PHONY: doc
+doc:
+# Have to generate this (temporarily) into DOC.md.
+# This is because all links in annotations refer to that
+# file, and luals-mdgen will produce links like [xxx](DOC.md#some-section),
+# which panvimdoc cannot deal with, it only knows [xxx](#some-section).
+	emmylua_doc_cli -f json -i lua/luasnip/ -o ./
+	luals-mdgen data/DOC-template.md DOC.md --width 100 --mode vimdoc
+	panvimdoc --project-name luasnip --input-file DOC.md --vim-version "NeoVim 0.7-0.11" --doc-mapping true
+	nvim --clean -es +"helptags doc | exit"
+# again, this time without vimdoc, overwrite previous DOC.md.
+	luals-mdgen data/DOC-template.md DOC.md --width 100

.github/data/project-dictionary.txt → data/project-dictionary.txt

@@ -1,4 +1,4 @@
-personal_ws-1.1 en 113 utf-8
+personal_ws-1.1 en 123 utf-8
 AbsoluteIndexer
 Autosnippets
 Cfigure
@@ -34,13 +34,16 @@ amongst
 anytext
 argnode
 argnodes
+args
 autocommand
 autocommands
+autosnippet
 autosnippets
 autotriggered
 backtick
 boolean
 choiceNode
+choiceNode's
 choiceNodes
 cmp
 compe
@@ -57,19 +60,23 @@ docstrings
 dynamicNode
 dynamicNode's
 dynamicNodes
+eg
 ejmastnak
+env
 evesdropper
 extmark
 extmarks
 filetype
 filetypes
 fmt
 fn
+fts
 functionNode
 functionNodes
 get's
 globals
 honza
+ie
 ing
 insertNode
 insertNodes
@@ -78,7 +85,9 @@ jumpable
 jumplist
 keymaps
 lsp
+lua
 luasnip
+luasnip's
 mistyped
 molleweide
 multiline
@@ -109,6 +118,7 @@ textNode
 textNodes
 th
 there'd
+treesitter
 truthy
 varargs
 vsnip