Merge pull request #37 from vim-denops/gen-functions

👍  Automatically generate `function` module from help of Vim and Neovim

Author: lambdalisue

Makefile

@@ -26,6 +26,10 @@ type-check: FORCE	## Type check
 test: FORCE	## Test
 	@deno test --unstable -A
 
+gen: FORCE	## Generate codes
+	@deno run -A ./scripts/gen-function/gen-function.ts
+	@make fmt
+
 dlink: FORCE	## Update dlink
 	(cd denops_std; ${TOOLS}/bin/dlink)
 	@make fmt

denops_std/function/README.md

@@ -0,0 +1,33 @@
+# `function`
+
+This module provides entry points of raw Vim and Neovim functions. Most of codes
+are automatically generated by
+[`gen-function.ts`](../../scripts/gen-function/gen-function.ts) from `eval.txt`
+in minimal supported Vim and Neovim versions.
+
+## Example
+
+```typescript
+import * as fn from "https://deno.land/x/denops_std/function/mod.ts";
+import * as vimFn from "https://deno.land/x/denops_std/function/vim/mod.ts";
+import * as nvimFn from "https://deno.land/x/denops_std/function/nvim/mod.ts";
+
+export async function main(denops) {
+  // fn holds functions exists in both Vim and Neovim
+  console.log(fn.or(denops, 0, 1));
+
+  // vimFn holds functions exists only in Vim
+  console.log(vimFn.balloon_gettext(denops));
+
+  // nvimFn holds functions exists only in Neovim
+  console.log(nvimFn.api_info(denops));
+}
+```
+
+## How to add functions manually
+
+To add functions manually, create or modify corresponding module under
+`function`, `function/vim`, or `function/nvim` module then make sure that module
+is listed in `_manual.ts` uneder corresponding module. After that, execute
+`make gen` on the repository top so that `gen-function.ts` automatically remove
+duplicated functions from `_generated.ts`.