add help file, and docs (#59)

* idk how good this idea is

* this could be working but i still cant figure out how to run it

* ignore tags that mini.doc gens, but why?

* chore(taskfile): force exiting after tests

because i got infinit ci

* chore(ci): add more nvim versions to run on

* chore: update taskfile

* feat: add docs generator

* docs: its only begining

* refactor: update docgen script

* docs: write some more

* docs(config): update

* docs: update readme

* language

* hope it would work

* what about that?

* maybe this would work?

* update md

* upd

* WHY DOESNT IT WORKING

* idk by but 0.9.3 just fails the ci, so i deleted it from suite

* again update, why does markdown not work in embeded html

* maybe it can help?

* upd

* again update

* kinda fix

* fix: formatting

* again some updating

* some readme updating

* fix, this shouldnt be in repo

* i finnaly undertood how to fix this fking skill issue

* fix(struct_tags): typo

* refactor(docs): change the order in generated file

* docs: install deps

* refactor(scripts): rename doc-gen script

* docs(impl): write docs

* docs(dap): add doc

* stylua .

* docs(struct_tags): add doc

* docs(gotests): add docs

* docs(iferr): add docs

* docs(comment): add doc

* update CONTRIBUTING.md

* docs(README): talk about `develop` branch

* docs: update README.md
This commit is contained in:
Smirnov Oleksandr 2024-04-04 17:15:55 +03:00 committed by GitHub
parent 28e1f5689f
commit 10cec9c6b0
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
16 changed files with 657 additions and 142 deletions

View file

@ -2,21 +2,29 @@ version: "3"
tasks:
format:
desc: formats all lua files in repo
cmds: [stylua .]
cmds:
- stylua .
lint:
desc: runs all linters
cmds:
- task: lint_selene
- task: lint_stylua
- task: selene
- task: stylua:check
lint_selene:
selene:
desc: runs lua linter(selene)
cmds: [selene .]
cmds:
- selene .
lint_stylua:
stylua:check:
desc: runs stylua in check mode
cmds: [stylua --check .]
cmds:
- stylua --check .
stylua:
desc: runs lua formatter
cmds:
- stylua .
test:
desc: runs all tests
@ -24,7 +32,18 @@ tasks:
cmds:
- |
nvim --headless \
-u ./spec/minimal_init.lua\
-u ./scripts/minimal_init.lua \
-c "PlenaryBustedDirectory spec \
{minimal_init='./spec/minimal_init.lua'\
,sequential=true}"
{minimal_init='./scripts/minimal_init.lua' \
,sequential=true}" \
-c ":qa!"
docgen:
desc: generate vimhelp
cmds:
- |
nvim --noplugin \
--headless \
-u "./scripts/minimal_init.lua" \
-c "luafile ./scripts/docgen.lua" \
-c ":qa!"