Skip to content

Commit c45dedd

Browse files
committed
docs: auto-generate OPTIONS.md from emmylua comments
1 parent b949bc0 commit c45dedd

File tree

8 files changed

+3630
-1449
lines changed

8 files changed

+3630
-1449
lines changed

.github/workflows/vimdoc.yaml

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,21 @@ jobs:
1414
- uses: rhysd/action-setup-vim@v1
1515
with:
1616
neovim: true
17-
version: v0.10.4
17+
version: nightly
18+
- name: Install emmylua_doc_cli
19+
env:
20+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
21+
run: |
22+
set -e
23+
cd
24+
gh release download -R EmmyLuaLs/emmylua-analyzer-rust -p emmylua_doc_cli-linux-x64.tar.gz -D emmylua_doc_cli
25+
tar xzf emmylua_doc_cli/* -C emmylua_doc_cli
26+
echo "${PWD}/emmylua_doc_cli/" >> $GITHUB_PATH
27+
export PATH="${PWD}/emmylua_doc_cli/:${PATH}"
28+
emmylua_doc_cli --version
29+
- name: Generate OPTIONS.md
30+
run: |
31+
nvim --headless -l scripts/gen_options.lua
1832
- name: Setup treesitter
1933
run: |
2034
mkdir -p ~/.local/share/nvim/site/pack/vendor/start
@@ -24,11 +38,12 @@ jobs:
2438
run: |
2539
export PACKPATH=$HOME/.local/share/nvim/site
2640
nvim --headless -u ~/.local/share/nvim/site/pack/vendor/start/ts-vimdoc.nvim/scripts/init.lua -c "TSUpdateSync markdown" -c "TSUpdateSync markdown_inline" -c "qa"
27-
- name: Generating docs
41+
- name: Generating vimdoc
2842
run: |
2943
export PATH="${PWD}/build/:${PATH}"
3044
export PACKPATH=$HOME/.local/share/nvim/site
3145
nvim --headless -u ~/.local/share/nvim/site/pack/vendor/start/ts-vimdoc.nvim/scripts/init.lua -c "lua require('ts-vimdoc').docgen({input_file='README.md', output_file='doc/fzf-lua.txt', project_name='fzf-lua', version='For Neovim >= 0.9.0'})" -c "qa"
46+
nvim --headless -u ~/.local/share/nvim/site/pack/vendor/start/ts-vimdoc.nvim/scripts/init.lua -c "lua require('ts-vimdoc').docgen({input_file='OPTIONS.md', output_file='doc/fzf-lua-opts.txt', project_name='fzf-lua-opts', table_of_contents_lvl_min = 2, table_of_contents_lvl_max = 3, version='For Neovim >= 0.9.0'})" -c "qa"
3247
- name: Commit changes
3348
env:
3449
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -39,6 +54,6 @@ jobs:
3954
git config user.email "actions@github"
4055
git config user.name "Github Actions"
4156
git remote set-url origin https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
42-
git add doc/fzf-lua.txt
57+
git add doc OPTIONS.md
4358
# Only commit and push if we have changes
4459
git diff --quiet && git diff --staged --quiet || (git commit -m "${COMMIT_MSG}"; git push origin HEAD:${GITHUB_REF})

0 commit comments

Comments
 (0)