☕ Add gen task to generate mod.ts and exports

Author: lambdalisue

.github/workflows/test.yml

@@ -52,6 +52,10 @@ jobs:
         run: deno fmt --check
       - name: Type check
         run: deno task check
+      - name: Gen check
+        run: |
+          deno task gen
+          git diff --exit-code
 
   test:
     strategy:

.script/gen-exports.ts

@@ -0,0 +1,69 @@
+import {
+  dirname,
+  fromFileUrl,
+  globToRegExp,
+  relative,
+} from "jsr:@std/path@^1.0.8";
+import { walk } from "jsr:@std/fs@^1.0.5";
+import { parse } from "jsr:@std/jsonc@^1.0.1";
+
+const excludes = [
+  "*_test.ts",
+  "*_bench.ts",
+  "_*.ts",
+];
+
+async function generateExports(
+  path: string,
+): Promise<Record<string, string>> {
+  const patterns = excludes.map((p) => globToRegExp(p));
+  const root = fromFileUrl(new URL("../", import.meta.url));
+  const it = walk(path, {
+    includeFiles: true,
+    includeDirs: false,
+  });
+  const exports: Record<string, string> = {};
+  for await (const entry of it) {
+    if (!entry.name.endsWith(".ts")) continue;
+    if (patterns.some((p) => p.test(entry.name))) continue;
+    const exportName = [".", relative(path, normalizeExportName(entry.path))]
+      .filter((v) => !!v)
+      .join("/");
+    const exportPath = [".", relative(root, entry.path)]
+      .filter((v) => !!v)
+      .join("/");
+    exports[exportName] = exportPath;
+  }
+  return Object.fromEntries(Object.entries(exports).toSorted());
+}
+
+function normalizeExportName(name: string): string {
+  if (name.endsWith("/mod.ts")) {
+    name = dirname(name);
+  }
+  name = name.replace(/\.ts$/, "");
+  name = name.replace(/_/g, "-");
+  return name;
+}
+
+if (import.meta.main) {
+  const exports = await generateExports(
+    fromFileUrl(new URL("../denops/@fall", import.meta.url)),
+  );
+  const denoJsoncPath = new URL("../deno.jsonc", import.meta.url);
+  const denoJsonc = parse(await Deno.readTextFile(denoJsoncPath)) as Record<
+    string,
+    unknown
+  >;
+  await Deno.writeTextFile(
+    denoJsoncPath,
+    JSON.stringify(
+      {
+        ...denoJsonc,
+        exports,
+      },
+      undefined,
+      2,
+    ),
+  );
+}

.script/gen-mod.ts

@@ -0,0 +1,66 @@
+import {
+  dirname,
+  fromFileUrl,
+  globToRegExp,
+  join,
+  relative,
+} from "jsr:@std/path@^1.0.8";
+import { exists, walk } from "jsr:@std/fs@^1.0.5";
+
+const excludes = [
+  "mod.ts",
+  "*_test.ts",
+  "*_bench.ts",
+  "_*.ts",
+];
+
+async function* iterModules(path: string): AsyncIterable<string> {
+  const patterns = excludes.map((p) => globToRegExp(p));
+  for await (const entry of Deno.readDir(path)) {
+    if (entry.isFile) {
+      if (!entry.name.endsWith(".ts")) continue;
+      if (patterns.some((p) => p.test(entry.name))) continue;
+      yield entry.name;
+    } else if (entry.isDirectory) {
+      const modPath = join(path, entry.name, "mod.ts");
+      if (await exists(modPath)) {
+        yield relative(path, modPath);
+      }
+    }
+  }
+}
+
+async function generateModTs(
+  path: string,
+): Promise<void> {
+  const it = walk(path, {
+    includeFiles: false,
+    includeDirs: true,
+    includeSymlinks: false,
+  });
+  for await (const entry of it) {
+    const filenames = await Array.fromAsync(iterModules(entry.path));
+    if (filenames.length === 0) continue;
+    filenames.sort();
+    const lines = [
+      "// This file is generated by gen-mod.ts",
+      ...filenames.map((name) => {
+        if (name.endsWith("/mod.ts")) {
+          return `export * as ${dirname(name)} from "./${name}";`;
+        } else {
+          return `export * from "./${name}";`;
+        }
+      }),
+    ];
+    await Deno.writeTextFile(
+      join(entry.path, "mod.ts"),
+      lines.join("\n"),
+    );
+  }
+}
+
+if (import.meta.main) {
+  generateModTs(
+    fromFileUrl(new URL("../denops/@fall/builtin", import.meta.url)),
+  );
+}

deno.jsonc

@@ -6,15 +6,25 @@
     "./action": "./denops/@fall/action.ts",
     "./builtin": "./denops/@fall/builtin/mod.ts",
     "./builtin/action": "./denops/@fall/builtin/action/mod.ts",
+    "./builtin/action/buffer": "./denops/@fall/builtin/action/buffer.ts",
+    "./builtin/action/cd": "./denops/@fall/builtin/action/cd.ts",
     "./builtin/action/cmd": "./denops/@fall/builtin/action/cmd.ts",
     "./builtin/action/echo": "./denops/@fall/builtin/action/echo.ts",
+    "./builtin/action/help": "./denops/@fall/builtin/action/help.ts",
+    "./builtin/action/noop": "./denops/@fall/builtin/action/noop.ts",
     "./builtin/action/open": "./denops/@fall/builtin/action/open.ts",
     "./builtin/action/quickfix": "./denops/@fall/builtin/action/quickfix.ts",
     "./builtin/action/submatch": "./denops/@fall/builtin/action/submatch.ts",
     "./builtin/action/systemopen": "./denops/@fall/builtin/action/systemopen.ts",
     "./builtin/action/yank": "./denops/@fall/builtin/action/yank.ts",
     "./builtin/curator": "./denops/@fall/builtin/curator/mod.ts",
+    "./builtin/curator/noop": "./denops/@fall/builtin/curator/noop.ts",
     "./builtin/curator/rg": "./denops/@fall/builtin/curator/rg.ts",
+    "./builtin/filter": "./denops/@fall/builtin/filter/mod.ts",
+    "./builtin/filter/cwd": "./denops/@fall/builtin/filter/cwd.ts",
+    "./builtin/filter/exists": "./denops/@fall/builtin/filter/exists.ts",
+    "./builtin/filter/noop": "./denops/@fall/builtin/filter/noop.ts",
+    "./builtin/filter/regexp": "./denops/@fall/builtin/filter/regexp.ts",
     "./builtin/layout": "./denops/@fall/builtin/layout/mod.ts",
     "./builtin/layout/compact": "./denops/@fall/builtin/layout/compact.ts",
     "./builtin/layout/modern": "./denops/@fall/builtin/layout/modern.ts",
@@ -24,13 +34,16 @@
     "./builtin/matcher/noop": "./denops/@fall/builtin/matcher/noop.ts",
     "./builtin/matcher/regexp": "./denops/@fall/builtin/matcher/regexp.ts",
     "./builtin/matcher/substring": "./denops/@fall/builtin/matcher/substring.ts",
+    "./builtin/modifier": "./denops/@fall/builtin/modifier/mod.ts",
+    "./builtin/modifier/noop": "./denops/@fall/builtin/modifier/noop.ts",
+    "./builtin/modifier/relative-path": "./denops/@fall/builtin/modifier/relative_path.ts",
     "./builtin/previewer": "./denops/@fall/builtin/previewer/mod.ts",
     "./builtin/previewer/buffer": "./denops/@fall/builtin/previewer/buffer.ts",
     "./builtin/previewer/file": "./denops/@fall/builtin/previewer/file.ts",
     "./builtin/previewer/helptag": "./denops/@fall/builtin/previewer/helptag.ts",
     "./builtin/previewer/noop": "./denops/@fall/builtin/previewer/noop.ts",
     "./builtin/renderer": "./denops/@fall/builtin/renderer/mod.ts",
-    "./builtin/renderer/helptg": "./denops/@fall/builtin/renderer/helptag.ts",
+    "./builtin/renderer/helptag": "./denops/@fall/builtin/renderer/helptag.ts",
     "./builtin/renderer/noop": "./denops/@fall/builtin/renderer/noop.ts",
     "./builtin/renderer/smart-path": "./denops/@fall/builtin/renderer/smart_path.ts",
     "./builtin/sorter": "./denops/@fall/builtin/sorter/mod.ts",
@@ -61,6 +74,7 @@
     "./sorter": "./denops/@fall/sorter.ts",
     "./source": "./denops/@fall/source.ts",
     "./theme": "./denops/@fall/theme.ts",
+    "./util/derivable": "./denops/@fall/util/derivable.ts",
     "./util/testutil": "./denops/@fall/util/testutil.ts"
   },
   "publish": {
@@ -78,6 +92,9 @@
     ".coverage/**"
   ],
   "tasks": {
+    "gen:mod": "deno run -A ./.script/gen-mod.ts && deno fmt",
+    "gen:exports": "deno run -A ./.script/gen-exports.ts && deno fmt",
+    "gen": "deno task gen:mod && deno task gen:exports",
     "check": "deno check ./**/*.ts",
     "test": "deno test -A --parallel --shuffle --doc",
     "test:coverage": "deno task test --coverage=.coverage",

denops/@fall/builtin/action/mod.ts

@@ -1,3 +1,4 @@
+// This file is generated by gen-mod.ts
 export * from "./buffer.ts";
 export * from "./cd.ts";
 export * from "./cmd.ts";

denops/@fall/builtin/curator/mod.ts

@@ -1,2 +1,3 @@
+// This file is generated by gen-mod.ts
 export * from "./noop.ts";
 export * from "./rg.ts";

denops/@fall/builtin/filter/mod.ts

@@ -1,3 +1,4 @@
+// This file is generated by gen-mod.ts
 export * from "./cwd.ts";
 export * from "./exists.ts";
 export * from "./noop.ts";

denops/@fall/builtin/layout/mod.ts

@@ -1,3 +1,4 @@
+// This file is generated by gen-mod.ts
 export * from "./compact.ts";
 export * from "./modern.ts";
 export * from "./separate.ts";

denops/@fall/builtin/matcher/mod.ts

@@ -1,3 +1,4 @@
+// This file is generated by gen-mod.ts
 export * from "./fzf.ts";
 export * from "./noop.ts";
 export * from "./regexp.ts";

denops/@fall/builtin/mod.ts

@@ -1,3 +1,4 @@
+// This file is generated by gen-mod.ts
 export * as action from "./action/mod.ts";
 export * as curator from "./curator/mod.ts";
 export * as filter from "./filter/mod.ts";