Merge pull request #70 from kuuote/fn-2021-08-12

👍Correct type of `mode()`

Author: lambdalisue

denops_std/function/_generated.ts

@@ -4470,57 +4470,6 @@ export function mkdir(denops: Denops, ...args: unknown[]): Promise<unknown> {
   return denops.call("mkdir", ...args);
 }
 
-/**
- * Return a string that indicates the current mode.
- * If [expr] is supplied and it evaluates to a non-zero Number or
- * a non-empty String (|non-zero-arg|), then the full mode is
- * returned, otherwise only the first letter is returned.
- * Also see |state()|.
- *    n	    Normal, Terminal-Normal
- *    no	    Operator-pending
- *    nov	    Operator-pending (forced characterwise |o_v|)
- *    noV	    Operator-pending (forced linewise |o_V|)
- *    noCTRL-V Operator-pending (forced blockwise |o_CTRL-V|);
- * 		CTRL-V is one character
- *    niI	    Normal using |i_CTRL-O| in |Insert-mode|
- *    niR	    Normal using |i_CTRL-O| in |Replace-mode|
- *    niV	    Normal using |i_CTRL-O| in |Virtual-Replace-mode|
- *    v	    Visual by character
- *    V	    Visual by line
- *    CTRL-V   Visual blockwise
- *    s	    Select by character
- *    S	    Select by line
- *    CTRL-S   Select blockwise
- *    i	    Insert
- *    ic	    Insert mode completion |compl-generic|
- *    ix	    Insert mode |i_CTRL-X| completion
- *    R	    Replace |R|
- *    Rc	    Replace mode completion |compl-generic|
- *    Rv	    Virtual Replace |gR|
- *    Rx	    Replace mode |i_CTRL-X| completion
- *    c	    Command-line editing
- *    cv	    Vim Ex mode |gQ|
- *    ce	    Normal Ex mode |Q|
- *    r	    Hit-enter prompt
- *    rm	    The -- more -- prompt
- *    r?	    A |:confirm| query of some sort
- *    !	    Shell or external command is executing
- *    t	    Terminal-Job mode: keys go to the job
- * This is useful in the 'statusline' option or when used
- * with |remote_expr()| In most other places it always returns
- * "c" or "n".
- * Note that in the future more modes and more specific modes may
- * be added. It's better not to compare the whole string but only
- * the leading character(s).
- * Also see |visualmode()|.
- * Can also be used as a |method|:
- * 	DoFull()->mode()
- */
-export function mode(denops: Denops, expr?: unknown): Promise<unknown>;
-export function mode(denops: Denops, ...args: unknown[]): Promise<unknown> {
-  return denops.call("mode", ...args);
-}
-
 /**
  * Return the line number of the first line at or below {lnum}
  * that is not blank.  Example:

denops_std/function/_manual.ts

@@ -2,3 +2,4 @@ export * from "./buffer.ts";
 export * from "./common.ts";
 export * from "./cursor.ts";
 export * from "./types.ts";
+export * from "./various.ts";

denops_std/function/various.ts

@@ -0,0 +1,51 @@
+import { Denops } from "../deps.ts";
+
+/**
+ * Return a string that indicates the current mode.
+ * If [expr] is supplied and it evaluates to a non-zero Number or
+ * a non-empty String (|non-zero-arg|), then the full mode is
+ * returned, otherwise only the first letter is returned.
+ * Also see |state()|.
+ *    n	    Normal, Terminal-Normal
+ *    no	    Operator-pending
+ *    nov	    Operator-pending (forced characterwise |o_v|)
+ *    noV	    Operator-pending (forced linewise |o_V|)
+ *    noCTRL-V Operator-pending (forced blockwise |o_CTRL-V|);
+ * 		CTRL-V is one character
+ *    niI	    Normal using |i_CTRL-O| in |Insert-mode|
+ *    niR	    Normal using |i_CTRL-O| in |Replace-mode|
+ *    niV	    Normal using |i_CTRL-O| in |Virtual-Replace-mode|
+ *    v	    Visual by character
+ *    V	    Visual by line
+ *    CTRL-V   Visual blockwise
+ *    s	    Select by character
+ *    S	    Select by line
+ *    CTRL-S   Select blockwise
+ *    i	    Insert
+ *    ic	    Insert mode completion |compl-generic|
+ *    ix	    Insert mode |i_CTRL-X| completion
+ *    R	    Replace |R|
+ *    Rc	    Replace mode completion |compl-generic|
+ *    Rv	    Virtual Replace |gR|
+ *    Rx	    Replace mode |i_CTRL-X| completion
+ *    c	    Command-line editing
+ *    cv	    Vim Ex mode |gQ|
+ *    ce	    Normal Ex mode |Q|
+ *    r	    Hit-enter prompt
+ *    rm	    The -- more -- prompt
+ *    r?	    A |:confirm| query of some sort
+ *    !	    Shell or external command is executing
+ *    t	    Terminal-Job mode: keys go to the job
+ * This is useful in the 'statusline' option or when used
+ * with |remote_expr()| In most other places it always returns
+ * "c" or "n".
+ * Note that in the future more modes and more specific modes may
+ * be added. It's better not to compare the whole string but only
+ * the leading character(s).
+ * Also see |visualmode()|.
+ * Can also be used as a |method|:
+ * 	DoFull()->mode()
+ */
+export function mode(denops: Denops, expr?: number | string): Promise<string> {
+  return denops.call("mode", expr) as Promise<string>;
+}

denops_std/function/various_test.ts

@@ -0,0 +1,17 @@
+import { test } from "../deps_test.ts";
+import * as various from "./various.ts";
+import { assertEquals } from "../deps_test.ts";
+
+test({
+  mode: "all",
+  name: "mode()",
+  fn: async (denops) => {
+    const shortMode = denops.meta.host === "vim" ? "c" : "n";
+    const longMode = denops.meta.host === "vim" ? "ce" : "n";
+    assertEquals(await various.mode(denops), shortMode);
+    assertEquals(await various.mode(denops, 0), shortMode);
+    assertEquals(await various.mode(denops, 1), longMode);
+    assertEquals(await various.mode(denops, ""), shortMode);
+    assertEquals(await various.mode(denops, "v"), longMode);
+  },
+});