3b930636e3
* docs: centralize documentation into helpdoc Problem: documentation was spread across four files (README.md, doc/oil.txt, doc/api.md, doc/recipes.md) with duplication and gaps. User events were undocumented, and adapter docs only lived in the README. Solution: expand doc/oil.txt with five new sections (introduction, requirements, adapters, recipes, events) from existing content. Trim README to a landing page pointing to :help oil. Delete doc/api.md and doc/recipes.md since their content now lives in the helpdoc. Closes: barrettruth/oil.nvim#6 * build: remove docgen pipeline Problem: the Python docgen pipeline (scripts/generate.py, scripts/main.py, nvim_doc_tools) was designed for upstream's doc layout and is incompatible with the centralized helpdoc structure. It overwrites doc/oil.txt entirely and expects sections in README.md that no longer exist. Solution: delete the pipeline scripts (generate.py, main.py, requirements.txt), remove the update_docs CI job, and clean up the Makefile and .gitignore references. Linting and typechecking remain unchanged.
48 lines
1.4 KiB
Makefile
48 lines
1.4 KiB
Makefile
## help: print this help message
|
|
.PHONY: help
|
|
help:
|
|
@echo 'Usage:'
|
|
@sed -n 's/^##//p' ${MAKEFILE_LIST} | column -t -s ':' | sed -e 's/^/ /'
|
|
|
|
## all: lint and run tests
|
|
.PHONY: all
|
|
all: lint test
|
|
|
|
## test: run tests
|
|
.PHONY: test
|
|
test:
|
|
./run_tests.sh
|
|
|
|
## lint: run linters and LuaLS typechecking
|
|
.PHONY: lint
|
|
lint: scripts/nvim-typecheck-action
|
|
./scripts/nvim-typecheck-action/typecheck.sh --workdir scripts/nvim-typecheck-action lua
|
|
luacheck lua tests --formatter plain
|
|
stylua --check lua tests
|
|
|
|
## profile: use LuaJIT profiler to profile the plugin
|
|
.PHONY: profile
|
|
profile: scripts/benchmark.nvim
|
|
nvim --clean -u perf/bootstrap.lua -c 'lua jit_profile()'
|
|
|
|
## flame_profile: create a trace in the chrome profiler format
|
|
.PHONY: flame_profile
|
|
flame_profile: scripts/benchmark.nvim
|
|
nvim --clean -u perf/bootstrap.lua -c 'lua flame_profile()'
|
|
|
|
## benchmark: benchmark performance opening directory with many files
|
|
.PHONY: benchmark
|
|
benchmark: scripts/benchmark.nvim
|
|
nvim --clean -u perf/bootstrap.lua -c 'lua benchmark()'
|
|
@cat perf/tmp/benchmark.txt
|
|
|
|
scripts/nvim-typecheck-action:
|
|
git clone https://github.com/stevearc/nvim-typecheck-action scripts/nvim-typecheck-action
|
|
|
|
scripts/benchmark.nvim:
|
|
git clone https://github.com/stevearc/benchmark.nvim scripts/benchmark.nvim
|
|
|
|
## clean: reset the repository to a clean state
|
|
.PHONY: clean
|
|
clean:
|
|
rm -rf scripts/nvim-typecheck-action venv .testenv perf/tmp profile.json
|