Merge pull request #73 from vim-denops/option

👍  Add `option` module to manage options

Author: lambdalisue

Makefile

@@ -28,6 +28,7 @@ test: FORCE	## Test
 
 gen: FORCE	## Generate codes
 	@deno run --unstable -A ./scripts/gen-function/gen-function.ts
+	@deno run --unstable -A ./scripts/gen-option/gen-option.ts
 	@make fmt
 
 update: FORCE	## Update dependencies

denops_std/README.md

@@ -62,4 +62,5 @@ for more details.
 | [`function`](./function)   | A module to provide functions of Vim and Neovim native functions |
 | [`helper`](./helper)       | A module to provide helper functions                             |
 | [`mapping`](./mapping)     | A module to provide helper functions to manage mappings          |
+| [`option`](./option)       | A module to provide helper functions to manage options           |
 | [`variable`](./variable)   | A module to provide helper accessor functions to variables       |

denops_std/option/README.md

@@ -0,0 +1,60 @@
+# option
+
+`option`, `option/vim`, and `option/nvim` are modules to provide accessors of
+Vim and Neovim native options.
+
+- [API documentation](https://doc.deno.land/https/deno.land/x/denops_std/option/mod.ts)
+- [API documentation (Vim)](https://doc.deno.land/https/deno.land/x/denops_std/option/vim/mod.ts)
+- [API documentation (Neovim)](https://doc.deno.land/https/deno.land/x/denops_std/option/nvim/mod.ts)
+
+Most of codes are automatically generated by
+[`gen-option.ts`](../../scripts/gen-option/gen-option.ts) from `options.txt` in
+minimal supported Vim and Neovim versions.
+
+## Example
+
+```typescript
+import * as op from "https://deno.land/x/denops_std/option/mod.ts";
+import * as vimOp from "https://deno.land/x/denops_std/option/vim/mod.ts";
+import * as nvimOp from "https://deno.land/x/denops_std/option/nvim/mod.ts";
+
+export async function main(denops) {
+  // Get value of the option.
+  // `get` is available on any options
+  // `getGlobal` is available on only global options
+  // `getLocal` is available on only local options
+  console.log(await op.filetype.get(denops));
+  console.log(await op.filetype.getGlobal(denops));
+  console.log(await op.filetype.getLocal(denops));
+
+  // Set value of the option.
+  // `set` is available on any options
+  // `setGlobal` is available on only global options
+  // `setLocal` is available on only local options
+  await op.filetype.set(denops, "hello");
+  await op.filetype.setGlobal(denops, "hello");
+  await op.filetype.setLocal(denops, "hello");
+
+  // Reset the option.
+  // `reset` is available on any options
+  // `resetGlobal` is available on only global options
+  // `resetLocal` is available on only local options
+  await op.filetype.reset(denops);
+  await op.filetype.resetGlobal(denops);
+  await op.filetype.resetLocal(denops);
+
+  // vimOp has options only exist in Vim
+  console.log(await vimOp.compatible.get(denops));
+
+  // nvimOp has options only exist in Neovim
+  console.log(await nvimOp.shada.get(denops));
+}
+```
+
+## How to add options manually
+
+To add options manually, create or modify corresponding module under `option`,
+`option/vim`, or `option/nvim` module then make sure that module is listed in
+`_manual.ts` under corresponding module. After that, execute `make gen` on the
+repository top so that `gen-option.ts` automatically remove duplicated options
+from `_generated.ts`.