Merge pull request #222 from vim-denops/v6-pre

Support Denops v6

Author: lambdalisue

.github/workflows/test.yml

@@ -57,7 +57,7 @@ jobs:
           - macos-latest
           - ubuntu-latest
         version:
-          - "1.32.x"
+          - "1.38.x"
           - "1.x"
         host_version:
           - vim: "v9.0.1499"
@@ -105,10 +105,10 @@ jobs:
         env:
           DENOPS_TEST_NVIM: ${{ steps.nvim.outputs.executable }}
       - name: Cache
-        run: deno cache $(find . -name '*.ts')
+        run: deno cache ./**/*.ts
         working-directory: ./repo
       - name: Test
-        run: deno task test
+        run: deno task test:coverage
         env:
           DENOPS_TEST_DENOPS_PATH: "../denops.vim"
           DENOPS_TEST_VIM_EXECUTABLE: ${{ steps.vim.outputs.executable }}

.gitignore

@@ -1,4 +1,5 @@
 /.tools
 /.coverage
+/docs
 deno.lock
 

scripts/gen-function/format.ts renamed to .scripts/gen-function/format.ts

@@ -1,6 +1,6 @@
 import { Definition, Variant } from "./types.ts";
 
-const denops = "https://deno.land/x/denops_core@v5.0.0/mod.ts";
+const denops = "https://deno.land/x/denops_core@v6.0.5/mod.ts";
 
 const translate: Record<string, string> = {
   "*cmd": "cmd",
@@ -16,6 +16,8 @@ const translate: Record<string, string> = {
   "fname-two": "fname_two",
   "function": "function_",
   "lnum-end": "lnum_end",
+  "instanceof": "instanceof_",
+  "class": "class_",
 };
 
 export function formatDocs(docs: string): string[] {

scripts/gen-function/gen-function.ts renamed to .scripts/gen-function/gen-function.ts

@@ -2,23 +2,23 @@ import {
   difference,
   intersection,
 } from "https://deno.land/x/set_operations@v1.1.1/mod.ts";
-import * as path from "https://deno.land/std@0.205.0/path/mod.ts";
+import * as path from "https://deno.land/std@0.214.0/path/mod.ts";
 import { parse } from "./parse.ts";
 import { format } from "./format.ts";
 import { DOCS_OVERRIDES } from "./override.ts";
 import { transform } from "./transform.ts";
 import { downloadString } from "../utils.ts";
 
-const VIM_VERSION = "9.0.1499";
-const NVIM_VERSION = "0.8.0";
+const VIM_VERSION = "9.0.2189";
+const NVIM_VERSION = "0.9.4";
 
-const commonGenerateModule = "../../denops_std/function/_generated.ts";
-const vimGenerateModule = "../../denops_std/function/vim/_generated.ts";
-const nvimGenerateModule = "../../denops_std/function/nvim/_generated.ts";
+const commonGenerateModule = "../../function/_generated.ts";
+const vimGenerateModule = "../../function/vim/_generated.ts";
+const nvimGenerateModule = "../../function/nvim/_generated.ts";
 
-const commonManualModule = "../../denops_std/function/_manual.ts";
-const vimManualModule = "../../denops_std/function/vim/_manual.ts";
-const nvimManualModule = "../../denops_std/function/nvim/_manual.ts";
+const commonManualModule = "../../function/_manual.ts";
+const vimManualModule = "../../function/vim/_manual.ts";
+const nvimManualModule = "../../function/nvim/_manual.ts";
 
 const manualModules = [
   commonManualModule,

scripts/gen-function/override.ts renamed to .scripts/gen-function/override.ts

@@ -1,6 +1,6 @@
 import type { Option, OptionScope, OptionType } from "./types.ts";
 
-const denops = "https://deno.land/x/denops_core@v5.0.0/mod.ts";
+const denops = "https://deno.land/x/denops_core@v6.0.5/mod.ts";
 
 const translate: Record<string, string> = {
   "default": "defaultValue",

scripts/gen-function/parse.ts renamed to .scripts/gen-function/parse.ts

@@ -2,23 +2,23 @@ import {
   difference,
   intersection,
 } from "https://deno.land/x/set_operations@v1.1.1/mod.ts";
-import * as path from "https://deno.land/std@0.205.0/path/mod.ts";
+import * as path from "https://deno.land/std@0.214.0/path/mod.ts";
 import { parse } from "./parse.ts";
 import { format } from "./format.ts";
 import { DOCS_OVERRIDES } from "./override.ts";
 import { transform } from "./transform.ts";
 import { downloadString } from "../utils.ts";
 
-const VIM_VERSION = "9.0.1499";
-const NVIM_VERSION = "0.8.0";
+const VIM_VERSION = "9.0.2189";
+const NVIM_VERSION = "0.9.4";
 
-const commonGenerateModule = "../../denops_std/option/_generated.ts";
-const vimGenerateModule = "../../denops_std/option/vim/_generated.ts";
-const nvimGenerateModule = "../../denops_std/option/nvim/_generated.ts";
+const commonGenerateModule = "../../option/_generated.ts";
+const vimGenerateModule = "../../option/vim/_generated.ts";
+const nvimGenerateModule = "../../option/nvim/_generated.ts";
 
-const commonManualModule = "../../denops_std/option/_manual.ts";
-const vimManualModule = "../../denops_std/option/vim/_manual.ts";
-const nvimManualModule = "../../denops_std/option/nvim/_manual.ts";
+const commonManualModule = "../../option/_manual.ts";
+const vimManualModule = "../../option/vim/_manual.ts";
+const nvimManualModule = "../../option/nvim/_manual.ts";
 
 const manualModules = [
   commonManualModule,

scripts/gen-function/transform.ts renamed to .scripts/gen-function/transform.ts

@@ -1,4 +1,4 @@
-import { assertEquals } from "https://deno.land/std@0.205.0/assert/mod.ts";
+import { assertEquals } from "https://deno.land/std@0.214.0/assert/mod.ts";
 
 import { createMarkdownFromHelp } from "./markdown.ts";
 

scripts/gen-function/types.ts renamed to .scripts/gen-function/types.ts

@@ -1,7 +1,7 @@
 import {
   fromFileUrl,
   toFileUrl,
-} from "https://deno.land/std@0.205.0/path/mod.ts";
+} from "https://deno.land/std@0.214.0/path/mod.ts";
 import { intersection } from "https://deno.land/x/set_operations@v1.1.1/mod.ts";
 
 interface ModuleInformation {

scripts/gen-option/format.ts renamed to .scripts/gen-option/format.ts

@@ -1,17 +1,16 @@
-import * as streams from "https://deno.land/std@0.205.0/streams/mod.ts";
+import * as streams from "https://deno.land/std@0.214.0/streams/mod.ts";
 
 /**
  * Downloads a text file and returns the contents.
  * Throws error if fetch fails.
  */
 export async function downloadString(url: string): Promise<string> {
-  const textDecoder = new TextDecoder();
   const response = await fetch(url);
   if (!response.body) {
     throw new Error(`Failed to read ${url}`);
   }
-  const reader = streams.readerFromStreamReader(response.body.getReader());
-  return textDecoder.decode(await streams.readAll(reader));
+  //const reader = streams.readerFromStreamReader(response.body.getReader());
+  return await streams.toText(response.body);
 }
 
 /**

scripts/gen-option/gen-option.ts renamed to .scripts/gen-option/gen-option.ts

@@ -3,8 +3,8 @@ import {
   assertInstanceOf,
   assertRejects,
   assertThrows,
-} from "https://deno.land/std@0.205.0/assert/mod.ts";
-import { stub } from "https://deno.land/std@0.205.0/testing/mock.ts";
+} from "https://deno.land/std@0.214.0/assert/mod.ts";
+import { stub } from "https://deno.land/std@0.214.0/testing/mock.ts";
 
 import {
   Counter,

scripts/gen-option/override.ts renamed to .scripts/gen-option/override.ts

@@ -1,24 +1,68 @@
 # 🐜 denops_std
 
-[![Vim 9.0.1499 or above](https://img.shields.io/badge/Vim-Support%209.0.1499-yellowgreen.svg?logo=vim)](https://github.com/vim/vim/tree/v9.0.1499)
-[![Neovim 0.8.0 or above](https://img.shields.io/badge/Neovim-Support%200.8.0-yellowgreen.svg?logo=neovim&logoColor=white)](https://github.com/neovim/neovim/tree/v0.8.0)
+[![Vim 9.0.2189 or above](https://img.shields.io/badge/Vim-Support%209.0.2189-yellowgreen.svg?logo=vim)](https://github.com/vim/vim/tree/v9.0.2189)
+[![Neovim 0.9.4 or above](https://img.shields.io/badge/Neovim-Support%200.9.4-yellowgreen.svg?logo=neovim&logoColor=white)](https://github.com/neovim/neovim/tree/v0.9.4)
 [![Test](https://github.com/vim-denops/deno-denops-std/actions/workflows/test.yml/badge.svg)](https://github.com/vim-denops/deno-denops-std/actions/workflows/test.yml)
 [![codecov](https://codecov.io/github/vim-denops/deno-denops-std/branch/main/graph/badge.svg?token=RKAZMUQ3D9)](https://codecov.io/github/vim-denops/deno-denops-std)
 [![deno doc](https://doc.deno.land/badge.svg)](https://doc.deno.land/https/deno.land/x/denops_std/mod.ts)
 [![Documentation](https://img.shields.io/badge/denops-Documentation-yellow.svg)](https://vim-denops.github.io/denops-documentation/)
 [![deno land](http://img.shields.io/badge/available%20on-deno.land/x/denops__std-lightgrey.svg?logo=deno)](https://deno.land/x/denops_std)
 
-[Deno][deno] module for [denops.vim][denops.vim]. This module is assumed to be
-used in denops plugin and the code is assumed to be called in a worker thread
-for a plugin.
+Standard module for [denops.vim].
 
-See [deno doc](https://doc.deno.land/https/deno.land/x/denops_std/mod.ts) for
-quick usage and API documentations and see
-[Denops Documentation](https://vim-denops.github.io/denops-documentation/) for
-learning how to write Vim/Neovim plugins.
+This module is assumed to be used for developing denops plugins. The code is
+assumed to be called in a dedicated worker thread.
+
+By using this module, developers can write Vim/Neovim denops plugins like:
+
+```typescript
+import type { Denops } from "https://deno.land/x/denops_std@$MODULE_VERSION/mod.ts";
+import * as batch from "https://deno.land/x/denops_std@$MODULE_VERSION/batch/mod.ts";
+import * as fn from "https://deno.land/x/denops_std@$MODULE_VERSION/function/mod.ts";
+import * as vars from "https://deno.land/x/denops_std@$MODULE_VERSION/variable/mod.ts";
+import * as helper from "https://deno.land/x/denops_std@$MODULE_VERSION/helper/mod.ts";
+
+import { assert, is } from "https://deno.land/x/unknownutil@v3.14.1/mod.ts";
+
+export function main(denops: Denops): void {
+  denops.dispatcher = {
+    async init() {
+      // This is just an example. Developers usually should define commands directly in Vim script.
+      await batch.batch(denops, async (denops) => {
+        await denops.cmd(
+          `command! HelloWorld call denops#notify("${denops.name}", "say", ["World"])`,
+        );
+        await denops.cmd(
+          `command! HelloDenops call denops#notify("${denops.name}", "say", ["Denops"])`,
+        );
+      });
+    },
+    async say(where) {
+      assert(where, is.String);
+      const [name, progname] = await batch.collect(denops, (denops) => [
+        fn.input(denops, "Your name: "),
+        vars.v.get(denops, "progname"),
+      ]);
+      const messages = [
+        `Hello ${where}.`,
+        `Your name is ${name}.`,
+        `This is ${progname}.`,
+      ];
+      await helper.echo(denops, messages.join("\n"));
+    },
+  };
+}
+```
+
+**Note that developers should avoid calling initialization code within the
+`main` function**. If necessary, add an `init` API or a similar approach like
+above and call it from `plugin/<your_plugin>.vim`.
+
+See [Denops Documentation] or [denops-helloworld.vim] for more details.
 
-[deno]: https://deno.land/
 [denops.vim]: https://github.com/vim-denops/denops.vim
+[Denops Documentation]: https://vim-denops.github.io/denops-documentation
+[denops-helloworld.vim]: https://github.com/vim-denops/denops-helloworld.vim
 
 ## License
 

scripts/gen-option/parse.ts renamed to .scripts/gen-option/parse.ts

@@ -1,4 +1,4 @@
-import { parsePattern } from "./util.ts";
+import { parsePattern } from "./_util.ts";
 
 export type Flags = Record<string, string | string[] | undefined>;
 
@@ -9,8 +9,8 @@ const shortPattern = /^-([a-zA-Z0-9])(.*)/;
  * Parse string array to extract flags (-f/--flag).
  *
  * ```typescript
- * import { Denops } from "../mod.ts";
- * import { parseFlags } from "./mod.ts";
+ * import type { Denops } from "https://deno.land/x/denops_std@$MODULE_VERSION/mod.ts";
+ * import { parseFlags } from "https://deno.land/x/denops_std@$MODULE_VERSION/argument/mod.ts";
  *
  * export async function main(denops: Denops): Promise<void> {
  *   const args = [
@@ -66,8 +66,8 @@ export function parseFlags(args: string[]): [Flags, string[]] {
  * Validate if `flags` has unknown attributes.
  *
  * ```typescript
- * import { Denops } from "../mod.ts";
- * import { parse, validateFlags } from "./mod.ts";
+ * import type { Denops } from "https://deno.land/x/denops_std@$MODULE_VERSION/mod.ts";
+ * import { parse, validateFlags } from "https://deno.land/x/denops_std@$MODULE_VERSION/argument/mod.ts";
  *
  * export async function main(denops: Denops): Promise<void> {
  *   const args = [
@@ -102,8 +102,8 @@ export function validateFlags(flags: Flags, knownAttributes: string[]): void {
  * Format `key` and `value` to construct string array.
  *
  * ```typescript
- * import { Denops } from "../mod.ts";
- * import { formatFlag } from "./mod.ts";
+ * import type { Denops } from "https://deno.land/x/denops_std@$MODULE_VERSION/mod.ts";
+ * import { formatFlag } from "https://deno.land/x/denops_std@$MODULE_VERSION/argument/mod.ts";
  *
  * export async function main(denops: Denops): Promise<void> {
  *   console.log(formatFlag("f", ""));
@@ -133,8 +133,8 @@ export function formatFlag(
  * Format `flags` to construct string array.
  *
  * ```typescript
- * import { Denops } from "../mod.ts";
- * import { formatFlags, parse } from "./mod.ts";
+ * import type { Denops } from "https://deno.land/x/denops_std@$MODULE_VERSION/mod.ts";
+ * import { formatFlags, parse } from "https://deno.land/x/denops_std@$MODULE_VERSION/argument/mod.ts";
  *
  * export async function main(denops: Denops): Promise<void> {
  *   const args = [

scripts/gen-option/transform.ts renamed to .scripts/gen-option/transform.ts

@@ -1,4 +1,4 @@
-import { assertEquals } from "https://deno.land/std@0.205.0/assert/mod.ts";
+import { assertEquals } from "https://deno.land/std@0.214.0/assert/mod.ts";
 import { parseFlags } from "./flags.ts";
 
 Deno.test("parseFlags", () => {

scripts/gen-option/types.ts renamed to .scripts/gen-option/types.ts

@@ -17,15 +17,15 @@
  * Then, developers can use this module to parse, validate, or format the arguments.
  *
  * ```typescript
- * import type { Denops } from "../mod.ts";
+ * import type { Denops } from "https://deno.land/x/denops_std@$MODULE_VERSION/mod.ts";
  * import {
  *   builtinOpts,
  *   formatFlags,
  *   formatOpts,
  *   parse,
  *   validateFlags,
  *   validateOpts,
- * } from "./mod.ts";
+ * } from "https://deno.land/x/denops_std@$MODULE_VERSION/argument/mod.ts";
  *
  * export async function main(denops: Denops): Promise<void> {
  *   denops.dispatcher = {
@@ -69,8 +69,8 @@ import { Flags, parseFlags } from "./flags.ts";
  * Parse string array to extract opts, flags.
  *
  * ```typescript
- * import { Denops } from "../mod.ts";
- * import { parse } from "./mod.ts";
+ * import type { Denops } from "https://deno.land/x/denops_std@$MODULE_VERSION/mod.ts";
+ * import { parse } from "https://deno.land/x/denops_std@$MODULE_VERSION/argument/mod.ts";
  *
  * export async function main(denops: Denops): Promise<void> {
  *   const args = [

scripts/markdown.ts renamed to .scripts/markdown.ts

@@ -1,4 +1,4 @@
-import { assertEquals } from "https://deno.land/std@0.205.0/assert/mod.ts";
+import { assertEquals } from "https://deno.land/std@0.214.0/assert/mod.ts";
 import { parse } from "./mod.ts";
 
 Deno.test("parse", () => {

scripts/markdown_test.ts renamed to .scripts/markdown_test.ts

@@ -1,4 +1,4 @@
-import { parsePattern } from "./util.ts";
+import { parsePattern } from "./_util.ts";
 
 export type Opts = Record<string, string | undefined>;
 
@@ -24,8 +24,8 @@ const optPattern = /^\+\+([a-zA-Z0-9-]+)(?:=(.*))?/;
  * Parse string array to extract opts (++opt).
  *
  * ```typescript
- * import { Denops } from "../mod.ts";
- * import { parseOpts } from "./mod.ts";
+ * import type { Denops } from "https://deno.land/x/denops_std@$MODULE_VERSION/mod.ts";
+ * import { parseOpts } from "https://deno.land/x/denops_std@$MODULE_VERSION/argument/mod.ts";
  *
  * export async function main(denops: Denops): Promise<void> {
  *   const args = [
@@ -77,8 +77,8 @@ export function parseOpts(args: string[]): [Opts, string[]] {
  * Validate if `opts` has unknown attributes.
  *
  * ```typescript
- * import { Denops } from "../mod.ts";
- * import { builtinOpts, parse, validateOpts } from "./mod.ts";
+ * import type { Denops } from "https://deno.land/x/denops_std@$MODULE_VERSION/mod.ts";
+ * import { builtinOpts, parse, validateOpts } from "https://deno.land/x/denops_std@$MODULE_VERSION/argument/mod.ts";
  *
  * export async function main(denops: Denops): Promise<void> {
  *   const args = [
@@ -112,8 +112,8 @@ export function validateOpts(opts: Opts, knownAttributes: string[]): void {
  * Format `key` and `value` to construct string array.
  *
  * ```typescript
- * import { Denops } from "../mod.ts";
- * import { formatOpt } from "./mod.ts";
+ * import type { Denops } from "https://deno.land/x/denops_std@$MODULE_VERSION/mod.ts";
+ * import { formatOpt } from "https://deno.land/x/denops_std@$MODULE_VERSION/argument/mod.ts";
  *
  * export async function main(denops: Denops): Promise<void> {
  *   console.log(formatOpt("enc", "sjis"));
@@ -132,8 +132,8 @@ export function formatOpt(key: string, value: string | undefined): string[] {
  * Format `opts` to construct string array.
  *
  * ```typescript
- * import { Denops } from "../mod.ts";
- * import { formatOpts, parse } from "../argument/mod.ts";
+ * import type { Denops } from "https://deno.land/x/denops_std@$MODULE_VERSION/mod.ts";
+ * import { formatOpts, parse } from "https://deno.land/x/denops_std@$MODULE_VERSION/argument/mod.ts";
  *
  * export async function main(denops: Denops): Promise<void> {
  *   const args = [

scripts/transform.ts renamed to .scripts/transform.ts

@@ -1,4 +1,4 @@
-import { assertEquals } from "https://deno.land/std@0.205.0/assert/mod.ts";
+import { assertEquals } from "https://deno.land/std@0.214.0/assert/mod.ts";
 import { parseOpts } from "./opts.ts";
 
 Deno.test("parseOpts", () => {