☕ To specify which docs to apply to common functions

Author: Milly

scripts/gen-function/gen-function.ts

@@ -5,6 +5,7 @@ import {
 import * as path from "https://deno.land/std@0.183.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";
 
@@ -62,12 +63,20 @@ const nvimFnSet = difference(
   manualFnSet,
 );
 
+const nvimDefMap = new Map(nvimDefs.map((def) => [def.fn, def]));
+const commonDefs = vimDefs
+  .map((vimDef) =>
+    DOCS_OVERRIDES[vimDef.fn] === "nvim"
+      ? { ...vimDef, docs: nvimDefMap.get(vimDef.fn)!.docs }
+      : vimDef
+  );
+
 const commonFnSet = intersection(vimFnSet, nvimFnSet);
 const vimOnlyFnSet = difference(vimFnSet, nvimFnSet);
 const nvimOnlyFnSet = difference(nvimFnSet, vimFnSet);
 
 const commonCode = format(
-  vimDefs.filter((def) => commonFnSet.has(def.fn)),
+  commonDefs.filter((def) => commonFnSet.has(def.fn)),
 );
 const vimOnlyCode = format(
   vimDefs.filter((def) => vimOnlyFnSet.has(def.fn)),
@@ -89,7 +98,7 @@ await Deno.writeTextFile(
   nvimOnlyCode.join("\n"),
 );
 
-await transform(resolvePath(commonManualModule), vimDefs);
+await transform(resolvePath(commonManualModule), commonDefs);
 await transform(resolvePath(vimManualModule), vimDefs);
 await transform(resolvePath(nvimManualModule), nvimDefs);
 

scripts/gen-function/override.ts

@@ -0,0 +1,8 @@
+import { DocsType } from "./types.ts";
+
+/**
+ * Mapping between function name to `DocsType`.
+ */
+export const DOCS_OVERRIDES: Readonly<Record<string, DocsType>> = {
+  has: "nvim",
+};

scripts/gen-function/types.ts

@@ -11,3 +11,5 @@ export type Definition = {
   docs: string;
   vars: Variant[];
 };
+
+export type DocsType = "vim" | "nvim";

scripts/gen-option/gen-option.ts

@@ -5,6 +5,7 @@ import {
 import * as path from "https://deno.land/std@0.183.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";
 
@@ -58,12 +59,20 @@ const nvimOptionSet = difference(
   manualOptionSet,
 );
 
+const nvimDefMap = new Map(nvimDefs.map((def) => [def.name, def]));
+const commonDefs = vimDefs
+  .map((vimDef) =>
+    DOCS_OVERRIDES[vimDef.name] === "nvim"
+      ? { ...vimDef, docs: nvimDefMap.get(vimDef.name)!.docs }
+      : vimDef
+  );
+
 const commonOptionSet = intersection(vimOptionSet, nvimOptionSet);
 const vimOnlyOptionSet = difference(vimOptionSet, nvimOptionSet);
 const nvimOnlyOptionSet = difference(nvimOptionSet, vimOptionSet);
 
 const commonCode = format(
-  vimDefs.filter((def) => commonOptionSet.has(def.name)),
+  commonDefs.filter((def) => commonOptionSet.has(def.name)),
   ".",
 );
 const vimOnlyCode = format(
@@ -88,7 +97,7 @@ await Deno.writeTextFile(
   nvimOnlyCode.join("\n"),
 );
 
-await transform(resolvePath(commonManualModule), vimDefs);
+await transform(resolvePath(commonManualModule), commonDefs);
 await transform(resolvePath(vimManualModule), vimDefs);
 await transform(resolvePath(nvimManualModule), nvimDefs);
 

scripts/gen-option/override.ts

@@ -0,0 +1,6 @@
+import { DocsType } from "./types.ts";
+
+/**
+ * Mapping between function name to `DocsType`.
+ */
+export const DOCS_OVERRIDES: Readonly<Record<string, DocsType>> = {};

scripts/gen-option/types.ts

@@ -20,3 +20,5 @@ export type OptionScope = typeof OPTION_SCOPES[number];
 export function isOptionScope(x: unknown): x is OptionScope {
   return OPTION_SCOPES.includes(x as OptionScope);
 }
+
+export type DocsType = "vim" | "nvim";