Merge pull request #255 from vim-denops/check-supported-versions

☕ Check supported versions

Author: lambdalisue

.github/workflows/test.yml

@@ -11,11 +11,19 @@ on:
       - "deno.jsonc"
       - ".github/workflows/test.yml"
   workflow_dispatch:
+    inputs:
+      denops_branch:
+        description: 'Denops revision to test'
+        required: false
+        default: 'main'
 
 defaults:
   run:
     shell: bash --noprofile --norc -eo pipefail {0}
 
+env:
+  DENOPS_BRANCH: ${{ github.event.inputs.denops_branch || 'main' }}
+
 jobs:
   check:
     strategy:
@@ -44,6 +52,14 @@ jobs:
         run: deno fmt --check
       - name: Type check
         run: deno task check
+      - name: Gen check
+        run: |
+          deno task gen
+          git diff --exit-code
+      - name: Supported version inconsistency check
+        run: |
+          deno task apply:supported-versions
+          git diff --exit-code
 
   test:
     strategy:
@@ -53,7 +69,7 @@ jobs:
           - macos-latest
           - ubuntu-latest
         deno_version:
-          - "1.45.x"
+          - "1.45.0"
           - "1.x"
         host_version:
           - vim: "v9.1.0448"
@@ -77,7 +93,7 @@ jobs:
 
       - name: Try switching denops branch
         run: |
-          git -C /tmp/denops.vim switch ${{ github.head_ref || github.ref_name }} || true
+          git -C /tmp/denops.vim switch ${{ env.DENOPS_BRANCH }} || true
           git -C /tmp/denops.vim branch
 
       - uses: rhysd/action-setup-vim@v1

.scripts/apply-supported-versions.ts

@@ -0,0 +1,89 @@
+import {
+  loadSupportedVersions,
+  type SupportedVersions,
+} from "./supported_versions.ts";
+
+async function main(): Promise<void> {
+  const supportedVersions = await loadSupportedVersions("main");
+  await updateREADME(supportedVersions);
+  await updateGithubWorkflowsTest(supportedVersions);
+}
+
+async function updateREADME(
+  supportedVersions: SupportedVersions,
+): Promise<void> {
+  const url = new URL(import.meta.resolve("../README.md"));
+  let text = await Deno.readTextFile(url);
+  // Deno
+  text = text.replace(
+    /Deno\s+\d+\.\d+\.\d+/,
+    `Deno ${supportedVersions.deno}`,
+  );
+  text = text.replace(
+    /Deno-Support%20\d+\.\d+\.\d+/,
+    `Deno-Support%20${supportedVersions.deno}`,
+  );
+  text = text.replace(
+    /https:\/\/github\.com\/denoland\/deno\/tree\/v\d+\.\d+\.\d+/,
+    `https://github.com/denoland/deno/tree/v${supportedVersions.deno}`,
+  );
+  // Vim
+  text = text.replace(
+    /Vim\s+\d+\.\d+\.\d+/,
+    `Vim ${supportedVersions.vim}`,
+  );
+  text = text.replace(
+    /Vim-Support%20\d+\.\d+\.\d+/,
+    `Vim-Support%20${supportedVersions.vim}`,
+  );
+  text = text.replace(
+    /https:\/\/github\.com\/vim\/vim\/tree\/v\d+\.\d+\.\d+/,
+    `https://github.com/vim/vim/tree/v${supportedVersions.vim}`,
+  );
+  // Neovim
+  text = text.replace(
+    /Neovim\s+\d+\.\d+\.\d+/,
+    `Neovim ${supportedVersions.neovim}`,
+  );
+  text = text.replace(
+    /Neovim-Support%20\d+\.\d+\.\d+/,
+    `Neovim-Support%20${supportedVersions.neovim}`,
+  );
+  text = text.replace(
+    /https:\/\/github\.com\/neovim\/neovim\/tree\/v\d+\.\d+\.\d+/,
+    `https://github.com/neovim/neovim/tree/v${supportedVersions.neovim}`,
+  );
+  await Deno.writeTextFile(url, text);
+}
+
+async function updateGithubWorkflowsTest(
+  supportedVersions: SupportedVersions,
+): Promise<void> {
+  const url = new URL(import.meta.resolve("../.github/workflows/test.yml"));
+  let text = await Deno.readTextFile(url);
+  // Deno
+  text = text.replace(
+    /deno_version:(.*?)"\d+\.\d+\.\d+"/s,
+    `deno_version:$1"${supportedVersions.deno}"`,
+  );
+  // Vim
+  text = text.replace(
+    /vim:(.*?)"v\d+\.\d+\.\d+"/s,
+    `vim:$1"v${supportedVersions.vim}"`,
+  );
+  // Neovim
+  text = text.replace(
+    /nvim:(.*?)"v\d+\.\d+\.\d+"/s,
+    `nvim:$1"v${supportedVersions.neovim}"`,
+  );
+  await Deno.writeTextFile(url, text);
+}
+
+if (import.meta.main) {
+  try {
+    await main();
+  } catch (error) {
+    console.error(error);
+    Deno.exit(1);
+  }
+}

.scripts/gen-function/gen-function.ts

@@ -4,9 +4,11 @@ import { format } from "./format.ts";
 import { DOCS_OVERRIDES } from "./override.ts";
 import { transform } from "./transform.ts";
 import { downloadString } from "../utils.ts";
+import { loadSupportedVersions } from "../supported_versions.ts";
 
-const VIM_VERSION = "9.1.0448";
-const NVIM_VERSION = "0.10.0";
+const supportedVersions = await loadSupportedVersions();
+const VIM_VERSION = supportedVersions.vim;
+const NVIM_VERSION = supportedVersions.neovim;
 
 const commonGenerateModule = "../../function/_generated.ts";
 const vimGenerateModule = "../../function/vim/_generated.ts";

.scripts/gen-option/gen-option.ts

@@ -4,9 +4,11 @@ import { format } from "./format.ts";
 import { DOCS_OVERRIDES } from "./override.ts";
 import { transform } from "./transform.ts";
 import { downloadString } from "../utils.ts";
+import { loadSupportedVersions } from "../supported_versions.ts";
 
-const VIM_VERSION = "9.1.0448";
-const NVIM_VERSION = "0.10.0";
+const supportedVersions = await loadSupportedVersions();
+const VIM_VERSION = supportedVersions.vim;
+const NVIM_VERSION = supportedVersions.neovim;
 
 const commonGenerateModule = "../../option/_generated.ts";
 const vimGenerateModule = "../../option/vim/_generated.ts";

.scripts/supported_versions.ts

@@ -0,0 +1,30 @@
+import { ensure, is, type Predicate } from "@core/unknownutil";
+
+export type SupportedVersions = {
+  deno: string;
+  vim: string;
+  neovim: string;
+};
+
+const isSupportedVersions = is.ObjectOf({
+  deno: is.String,
+  vim: is.String,
+  neovim: is.String,
+}) satisfies Predicate<SupportedVersions>;
+
+function getSupportedVersionJsonUrl(branch: string): URL {
+  return new URL(
+    `https://raw.githubusercontent.com/vim-denops/denops.vim/${branch}/denops/supported_versions.json`,
+  );
+}
+
+export async function loadSupportedVersions(
+  branch?: string,
+): Promise<SupportedVersions> {
+  const url = getSupportedVersionJsonUrl(
+    branch ?? Deno.env.get("DENOPS_BRANCH") ?? "main",
+  );
+  const resp = await fetch(url);
+  const json = await resp.json();
+  return ensure(json, isSupportedVersions);
+}

README.md

@@ -4,6 +4,10 @@
 [![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 1.45.0 or above](https://img.shields.io/badge/Deno-Support%201.45.0-yellowgreen.svg?logo=deno)](https://github.com/denoland/deno/tree/v1.45.0)
+[![Vim 9.1.0448 or above](https://img.shields.io/badge/Vim-Support%209.1.0448-yellowgreen.svg?logo=vim)](https://github.com/vim/vim/tree/v9.1.0448)
+[![Neovim 0.10.0 or above](https://img.shields.io/badge/Neovim-Support%200.10.0-yellowgreen.svg?logo=neovim&logoColor=white)](https://github.com/neovim/neovim/tree/v0.10.0)
+
 Standard module for [denops.vim].
 
 This module is assumed to be used for developing denops plugins. The code is

deno.jsonc

@@ -89,6 +89,7 @@
     "update:commit": "deno task -q update --commit --prefix :package: --pre-commit=fmt,lint",
     "gen:function": "deno run -A ./.scripts/gen-function/gen-function.ts",
     "gen:option": "deno run -A ./.scripts/gen-option/gen-option.ts",
-    "gen": "deno task gen:function && deno task gen:option && deno fmt"
+    "gen": "deno task gen:function && deno task gen:option && deno fmt",
+    "apply:supported-versions": "deno run --allow-net --allow-read --allow-write .scripts/apply-supported-versions.ts"
   }
 }