Merge pull request #264 from vim-denops/autocmd

👍 improve autocmd functoin arguments
vim-denops · Aug 27, 2024 · 016970e · 016970e
2 parents f0bcca1 + 0cce3fc
commit 016970e
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 26 deletions.
diff --git a/autocmd/_utils.ts b/autocmd/_utils.ts
@@ -1,8 +1,13 @@
-import type { AutocmdEvent, DefineOptions, RemoveOptions } from "./types.ts";
+import type {
+  AutocmdEvent,
+  AutocmdPattern,
+  DefineOptions,
+  RemoveOptions,
+} from "./types.ts";
 
 export function buildDefineExpr(
-  event: AutocmdEvent | AutocmdEvent[],
-  pat: string | string[],
+  event: AutocmdEvent | readonly AutocmdEvent[],
+  pat: AutocmdPattern | readonly AutocmdPattern[],
   cmd: string,
   options: DefineOptions = {},
 ): string {
@@ -13,12 +18,12 @@ export function buildDefineExpr(
   if (Array.isArray(event)) {
     terms.push(event.join(","));
   } else {
-    terms.push(event);
+    terms.push(event as AutocmdEvent);
   }
   if (Array.isArray(pat)) {
     terms.push(pat.join(","));
   } else {
-    terms.push(pat);
+    terms.push(pat as string);
   }
   if (options.once) {
     terms.push("++once");
@@ -31,8 +36,8 @@ export function buildDefineExpr(
 }
 
 export function buildRemoveExpr(
-  event?: "*" | AutocmdEvent | AutocmdEvent[],
-  pat?: string | string[],
+  event?: "*" | AutocmdEvent | readonly AutocmdEvent[],
+  pat?: AutocmdPattern | readonly AutocmdPattern[],
   options: RemoveOptions = {},
 ): string {
   const terms = ["au!"];
@@ -43,13 +48,13 @@ export function buildRemoveExpr(
     if (Array.isArray(event)) {
       terms.push(event.join(","));
     } else {
-      terms.push(event);
+      terms.push(event as AutocmdEvent);
     }
     if (pat) {
       if (Array.isArray(pat)) {
         terms.push(pat.join(","));
       } else {
-        terms.push(pat);
+        terms.push(pat as string);
       }
     }
   }

diff --git a/autocmd/common.ts b/autocmd/common.ts
@@ -1,6 +1,7 @@
 import type { Denops } from "@denops/core";
 import type {
   AutocmdEvent,
+  AutocmdPattern,
   DefineOptions,
   EmitOptions,
   ListOptions,
@@ -41,8 +42,8 @@ import { buildDefineExpr, buildRemoveExpr } from "./_utils.ts";
  */
 export async function define(
   denops: Denops,
-  event: AutocmdEvent | AutocmdEvent[],
-  pat: string | string[],
+  event: AutocmdEvent | readonly AutocmdEvent[],
+  pat: AutocmdPattern | readonly AutocmdPattern[],
   cmd: string,
   options: DefineOptions = {},
 ): Promise<void> {
@@ -76,8 +77,8 @@ export async function define(
  */
 export async function remove(
   denops: Denops,
-  event?: "*" | AutocmdEvent | AutocmdEvent[],
-  pat?: string | string[],
+  event?: "*" | AutocmdEvent | readonly AutocmdEvent[],
+  pat?: AutocmdPattern | readonly AutocmdPattern[],
   options: RemoveOptions = {},
 ): Promise<void> {
   const expr = buildRemoveExpr(event, pat, options);
@@ -108,8 +109,8 @@ export async function remove(
  */
 export async function list(
   denops: Denops,
-  event?: "*" | AutocmdEvent | AutocmdEvent[],
-  pat?: string | string[],
+  event?: "*" | AutocmdEvent | readonly AutocmdEvent[],
+  pat?: AutocmdPattern | readonly AutocmdPattern[],
   options: ListOptions = {},
 ): Promise<unknown> {
   const terms = ["au"];
@@ -120,13 +121,13 @@ export async function list(
     if (Array.isArray(event)) {
       terms.push(event.join(","));
     } else {
-      terms.push(event);
+      terms.push(event as AutocmdEvent);
     }
     if (pat) {
       if (Array.isArray(pat)) {
         terms.push(pat.join(","));
       } else {
-        terms.push(pat);
+        terms.push(pat as AutocmdPattern);
       }
     }
   }
@@ -155,7 +156,7 @@ export async function list(
  */
 export async function emit(
   denops: Denops,
-  event: AutocmdEvent | AutocmdEvent[],
+  event: AutocmdEvent | readonly AutocmdEvent[],
   fname?: string,
   options: EmitOptions = {},
 ): Promise<unknown> {
@@ -169,7 +170,7 @@ export async function emit(
   if (Array.isArray(event)) {
     terms.push(event.join(","));
   } else {
-    terms.push(event);
+    terms.push(event as AutocmdEvent);
   }
   if (fname) {
     terms.push(fname);
@@ -199,7 +200,7 @@ export async function emit(
  */
 export async function emitAll(
   denops: Denops,
-  event: AutocmdEvent | AutocmdEvent[],
+  event: AutocmdEvent | readonly AutocmdEvent[],
   fname?: string,
   options: EmitOptions = {},
 ): Promise<unknown> {
@@ -213,7 +214,7 @@ export async function emitAll(
   if (Array.isArray(event)) {
     terms.push(event.join(","));
   } else {
-    terms.push(event);
+    terms.push(event as AutocmdEvent);
   }
   if (fname) {
     terms.push(fname);

diff --git a/autocmd/group.ts b/autocmd/group.ts
@@ -1,6 +1,11 @@
 import type { Denops } from "@denops/core";
 import { execute } from "../helper/execute.ts";
-import type { AutocmdEvent, DefineOptions, RemoveOptions } from "./types.ts";
+import type {
+  AutocmdEvent,
+  AutocmdPattern,
+  DefineOptions,
+  RemoveOptions,
+} from "./types.ts";
 import { buildDefineExpr, buildRemoveExpr } from "./_utils.ts";
 
 export type GroupDefineOptions = Omit<DefineOptions, "group">;
@@ -72,8 +77,8 @@ class GroupHelper {
    * Define an autocmd
    */
   define(
-    event: AutocmdEvent | AutocmdEvent[],
-    pat: string | string[],
+    event: AutocmdEvent | readonly AutocmdEvent[],
+    pat: AutocmdPattern | readonly AutocmdPattern[],
     cmd: string,
     options: GroupDefineOptions = {},
   ): void {
@@ -84,8 +89,8 @@ class GroupHelper {
    * Remove an autocmd
    */
   remove(
-    event?: "*" | AutocmdEvent | AutocmdEvent[],
-    pat?: string | string[],
+    event?: "*" | AutocmdEvent | readonly AutocmdEvent[],
+    pat?: AutocmdPattern | readonly AutocmdPattern[],
     options: GroupRemoveOptions = {},
   ): void {
     this.#commands.push(buildRemoveExpr(event, pat, options));

diff --git a/autocmd/types.ts b/autocmd/types.ts
@@ -119,6 +119,12 @@ export type AutocmdEvent =
   | "WinNew"
   | "WinScrolled";
 
+export type AutocmdPattern =
+  | AnyString
+  | "<buffer>"
+  | "<buffer=abuf>"
+  | `<buffer=${number}>`;
+
 interface CommonOptions {
   group?: string;
 }