👍 Add interface for option methods

Author: Milly

denops_std/option/types.ts

@@ -0,0 +1,112 @@
+import type { Denops } from "https://deno.land/x/denops_core@v4.0.0/mod.ts";
+
+/**
+ * An option that can be retrieved and modified.
+ * @template T The type of the option value.
+ */
+export interface Option<T> {
+  /**
+   * Gets the value of the option.
+   * @returns A Promise that resolves to the value of the option.
+   */
+  get(denops: Denops): Promise<T>;
+
+  /**
+   * Sets the value of the option.
+   * @param value The new value of the option.
+   * @returns A Promise that resolves when the option has been successfully set.
+   */
+  set(denops: Denops, value: T): Promise<void>;
+
+  /**
+   * Resets the value of the option to its default value.
+   * @returns A Promise that resolves when the option has been successfully reset.
+   */
+  reset(denops: Denops): Promise<void>;
+}
+
+/**
+ * A global option that can be retrieved and modified.
+ * @template T The type of the option value.
+ */
+export interface GlobalOption<T> extends Option<T> {
+  /**
+   * Gets the global value of the option.
+   * @returns A Promise that resolves to the value of the option.
+   */
+  getGlobal(denops: Denops): Promise<T>;
+
+  /**
+   * Sets the global value of the option.
+   * @param value The new value of the option.
+   * @returns A Promise that resolves when the option has been successfully set.
+   */
+  setGlobal(denops: Denops, value: T): Promise<void>;
+
+  /**
+   * Resets the global value of the option to its default value.
+   * @returns A Promise that resolves when the option has been successfully reset.
+   */
+  resetGlobal(denops: Denops): Promise<void>;
+}
+
+/**
+ * A local option that can be retrieved and modified.
+ * @template T The type of the option value.
+ */
+export interface LocalOption<T> extends Option<T> {
+  /**
+   * Gets the local value of the option.
+   * @returns A Promise that resolves to the value of the option.
+   */
+  getLocal(denops: Denops): Promise<T>;
+
+  /**
+   * Sets the local value of the option.
+   * @param value The new value of the option.
+   * @returns A Promise that resolves when the option has been successfully set.
+   */
+  setLocal(denops: Denops, value: T): Promise<void>;
+
+  /**
+   * Resets the local value of the option to its default value.
+   * @returns A Promise that resolves when the option has been successfully reset.
+   */
+  resetLocal(denops: Denops): Promise<void>;
+
+  /**
+   * Gets the value of the option for the specified buffer.
+   * @param bufnr The buffer number.
+   * @returns A Promise that resolves to the value of the option.
+   */
+  getBuffer(denops: Denops, bufnr: number): Promise<T>;
+
+  /**
+   * Sets the value of the option for the specified buffer.
+   * @param bufnr The buffer number.
+   * @param value The new value of the option.
+   * @returns A Promise that resolves when the option has been successfully set.
+   */
+  setBuffer(denops: Denops, bufnr: number, value: T): Promise<void>;
+
+  /**
+   * Gets the value of the option for the specified window.
+   * @param winnr The window number or `window-ID`.
+   * @returns A Promise that resolves to the value of the option.
+   */
+  getWindow(denops: Denops, winnr: number): Promise<T>;
+
+  /**
+   * Sets the value of the option for the specified window.
+   * @param winnr The window number or `window-ID`.
+   * @param value The new value of the option.
+   * @returns A Promise that resolves when the option has been successfully set.
+   */
+  setWindow(denops: Denops, winnr: number, value: T): Promise<void>;
+}
+
+/**
+ * A global or local option that can be retrieved and modified.
+ * @template T The type of the option value.
+ */
+export type GlobalOrLocalOption<T> = GlobalOption<T> & LocalOption<T>;

scripts/gen-option/format.ts

@@ -1,4 +1,4 @@
-import type { Option, OptionType } from "./types.ts";
+import type { Option, OptionScope, OptionType } from "./types.ts";
 
 const denops = "https://deno.land/x/denops_core@v4.0.0/mod.ts";
 
@@ -30,11 +30,12 @@ export function formatDocs(docs: string): string[] {
   return ["/**", ...normalizedLines, " */"];
 }
 
-function formatOption({ name, type, scope, docs }: Option): string[] {
-  name = translate[name] ?? name;
+function formatOption(option: Option): string[] {
+  const { type, scope, docs } = option;
+  const name = translate[option.name] ?? option.name;
   const lines = [
     ...formatDocs(docs),
-    `export const ${name} = {`,
+    `export const ${name}: ${getOptionTypeName(scope, type)} = {`,
     ...formatOptionBody(name, type),
     ...(scope.includes("global") ? formatGlobalOptionBody(name, type) : []),
     ...(scope.includes("local") ? formatLocalOptionBody(name, type) : []),
@@ -46,6 +47,16 @@ function formatOption({ name, type, scope, docs }: Option): string[] {
   return lines;
 }
 
+function getOptionTypeName(scope: OptionScope[], type: OptionType): string {
+  if (scope.includes("global") && scope.includes("local")) {
+    return `GlobalOrLocalOption<${type}>`;
+  } else if (scope.includes("global")) {
+    return `GlobalOption<${type}>`;
+  } else {
+    return `LocalOption<${type}>`;
+  }
+}
+
 function formatOptionBody(name: string, type: OptionType): string[] {
   const lines = [
     `  async get(denops: Denops): Promise<${type}> {`,
@@ -124,11 +135,13 @@ function formatWindowOptionBody(name: string, type: OptionType): string[] {
 export function format(options: Option[], root: string): string[] {
   const fn = `${root}/../function/mod.ts`;
   const variable = `${root}/../variable/mod.ts`;
+  const types = `${root}/types.ts`;
   const lines = [
     "// NOTE: This file is generated. Do NOT modify it manually.",
     `import type { Denops } from "${denops}";`,
     `import { getbufvar, setbufvar, getwinvar, setwinvar } from "${fn}";`,
     `import { globalOptions, localOptions, options } from "${variable}";`,
+    `import type { GlobalOption, GlobalOrLocalOption, LocalOption } from "${types}";`,
     "",
     ...options.map(formatOption),
   ];