refactor(thumbnail): add one more thumbnail file (#103)

Author: hyrious

src/bin.ts

@@ -101,8 +101,8 @@ program.command("thumbnail")
     .argument("[dir]", "The workdir directory", ".")
     .option("-s --search-dir <searchDir>", STORE_DIR_DESC)
     .action(async (dir, options) => {
-        const thumbnailPath = await thumbnail(path.resolve(dir), getStoreDir(options.searchDir));
-        if (thumbnailPath) {
+        const thumbnailPaths = await thumbnail(path.resolve(dir), getStoreDir(options.searchDir));
+        if (thumbnailPaths.length) {
             // eslint-disable-next-line no-console
             console.log("Thumbnail generated successfully.");
         }

src/cmd/install.ts

@@ -2,7 +2,7 @@ import type { Dep, DepRaw, Deps, IDepMap, InstallAllResult, InstallFileResult, I
 import path from "node:path";
 import { execa } from "execa";
 import pLimit from "p-limit";
-import { ooPackageName, ooThumbnailName } from "../const";
+import { ooPackageName, ooThumbnailNames } from "../const";
 import { copyDir, exists, mkdir, move, remove, tempDir, walk, xTar } from "../utils/fs";
 import { env, normalizePackageName } from "../utils/misc";
 import {
@@ -82,7 +82,9 @@ export async function installFile(options: InstallFileOptions): Promise<InstallF
         }
         await mkdir(path.dirname(targetDir));
         await move(tempDir, targetDir);
-        await remove(path.join(targetDir, ooThumbnailName));
+        for (const ooThumbnailName of ooThumbnailNames) {
+            await remove(path.join(targetDir, ooThumbnailName));
+        }
         return {
             target: targetDir,
             isOverwrite: isExists,
@@ -356,7 +358,9 @@ async function _install(options: _InstallOptions): Promise<InstallPackageResult[
 }
 
 function installFilter(src: string, _dest: string, source: string, _destination: string): boolean {
-    return path.join(src, ooThumbnailName) !== source;
+    return ooThumbnailNames.every((ooThumbnailName) => {
+        return path.join(src, ooThumbnailName) !== source;
+    });
 }
 
 async function integrityCheck(options: _InstallOptions, tempDistDir: string): Promise<SearchDep[]> {

src/cmd/pack.ts

@@ -1,6 +1,7 @@
 import path from "node:path";
 import { execa } from "execa";
 import { globby } from "globby";
+import { ooThumbnailNames } from "../const";
 import { copyDir, remove, tempDir, writeFile } from "../utils/fs";
 import { env } from "../utils/misc";
 import { generatePackageJson } from "../utils/npm";
@@ -26,7 +27,7 @@ export async function prePack(p: string, ignore: string[]) {
         absolute: true,
     });
 
-    const alwaysAllow = [path.join(p, ".oo-thumbnail.json")];
+    const alwaysAllow = ooThumbnailNames.map(name => path.join(p, name));
 
     await Promise.all([
         copyDir(p, path.join(workdir, "package"), (src, _dest, source, _destination) => {

src/cmd/thumbnail.ts

@@ -1,10 +1,25 @@
 import path from "node:path";
-import { ooThumbnailName } from "../const";
+import { ooLanguages, ooThumbnailNames } from "../const";
 import { writeFile } from "../utils/fs";
 import { Thumbnail } from "../utils/thumbnail";
 
-export async function thumbnail(workdir: string, searchDir: string): Promise<string | undefined> {
-    const thumbnail = await Thumbnail.create(workdir, searchDir);
+export async function thumbnail(workdir: string, searchDir: string): Promise<string[]> {
+    const result: string[] = [];
+    for (let i = 0; i < ooLanguages.length; i++) {
+        const lang = ooLanguages[i];
+        const ooThumbnailName = ooThumbnailNames[i];
+        const thumbnailPath = await thumbnailInternal(workdir, searchDir, lang, ooThumbnailName);
+        if (thumbnailPath) {
+            result.push(thumbnailPath);
+        }
+    }
+
+    Thumbnail.clearCache();
+    return result;
+}
+
+async function thumbnailInternal(workdir: string, searchDir: string, lang: string, ooThumbnailName: string): Promise<string | undefined> {
+    const thumbnail = await Thumbnail.create(workdir, searchDir, lang);
     if (!thumbnail) {
         return;
     }

src/const.ts

@@ -1,4 +1,8 @@
 export const ooPackageName = "package.oo.yaml";
 export const ooThumbnailName = ".oo-thumbnail.json";
+export const ooLanguages = ["en", "zh-CN"];
+export const ooThumbnailNames = /* #__PURE__ */ ooLanguages.map((lang) => {
+    return lang === "en" ? ooThumbnailName : ooThumbnailName.replace(".json", `.${lang}.json`);
+});
 
 export const ERR_OOPM_DEPEND_ITSELF = new Error("ERR_OOPM_DEPEND_ITSELF: Not allowed to depend on itself");

src/index.ts

@@ -25,6 +25,6 @@ export {
 export {
     thumbnail,
 } from "./cmd/thumbnail";
-export { ERR_OOPM_DEPEND_ITSELF, ooPackageName, ooThumbnailName } from "./const";
+export { ERR_OOPM_DEPEND_ITSELF, ooPackageName, ooThumbnailName, ooThumbnailNames } from "./const";
 export type { Dep, DepRaw, Deps, IDepMap, InstallAllResult, InstallFileResult, InstallPackageResult, OOPackageSchema, SearchDep } from "./types";
 export { transformNodeModules } from "./utils/npm";

src/utils/npm.test.ts

@@ -56,6 +56,7 @@ describe.concurrent("generatePackageJson", () => {
                 "package",
                 "package/.gitignore",
                 "package/.oo-thumbnail.json",
+                "package/.oo-thumbnail.zh-CN.json",
             ],
         });
     });

src/utils/npm.ts

@@ -46,6 +46,7 @@ export async function generatePackageJson(dir: string): Promise<string> {
         "package",
         "package/.gitignore",
         "package/.oo-thumbnail.json",
+        "package/.oo-thumbnail.zh-CN.json",
     ];
 
     return JSON.stringify(content, null, 2);

src/utils/thumbnail.ts

@@ -227,12 +227,19 @@ const readFile = async (path: string): Promise<string | undefined> => {
     catch { }
 };
 
+const manifestFileCache = new Map<string, Record<string, any> | null>();
+
 export class Thumbnail implements ThumbnailProvider {
-    public static async create(workspaceDir: string, registryStoreDir: string): Promise<Thumbnail | undefined> {
-        const depsQuery = new DepsQuery(registryStoreDir);
+    public static clearCache(): void {
+        manifestFileCache.clear();
+    }
+
+    public static async create(workspaceDir: string, registryStoreDir: string, lang: string): Promise<Thumbnail | undefined> {
+        const depsQuery = new DepsQuery(registryStoreDir, lang);
         const wsPkgData = await PkgData.createWS(
             depsQuery,
             workspaceDir,
+            lang,
         );
         if (wsPkgData) {
             return new Thumbnail(wsPkgData);
@@ -462,7 +469,7 @@ export class Thumbnail implements ThumbnailProvider {
 class DepsQuery {
     private cache: Map<string, PkgData | null | Promise<PkgData | undefined>> = new Map();
 
-    public constructor(public readonly searchPath: string) { }
+    public constructor(public readonly searchPath: string, public readonly lang: string) { }
 
     public async getPkgData(packageName: string, packageVersion: string): Promise<PkgData | undefined> {
         const packageId = `${packageName}-${packageVersion}`;
@@ -475,7 +482,7 @@ class DepsQuery {
                 return pkgData;
             }
         }
-        const p = PkgData.create(this, packageName, packageVersion, path.join(this.searchPath, packageId));
+        const p = PkgData.create(this, packageName, packageVersion, path.join(this.searchPath, packageId), this.lang);
         this.cache.set(packageId, p);
         const pkgData = await p;
         this.cache.set(packageId, pkgData || null);
@@ -484,24 +491,30 @@ class DepsQuery {
 }
 
 class PkgData {
-    public static async createWS(depsQuery: DepsQuery, workspaceDir: string): Promise<PkgData | undefined> {
+    public static async createWS(depsQuery: DepsQuery, workspaceDir: string, lang: string): Promise<PkgData | undefined> {
         const packagePath = await resolveManifest(workspaceDir, "package");
         if (packagePath) {
             const data = await readManifestFile(packagePath);
-            const localePath = await resolveLocaleFile(workspaceDir);
+            const localePath = await resolveLocaleFile(workspaceDir, lang);
             const userLocale = localePath ? await readJSONFile(localePath) : undefined;
+            if (!userLocale && lang && lang !== "en") {
+                return;
+            }
             if (data && data.name && data.version) {
                 return new PkgData(depsQuery, data.name, data.version, workspaceDir, packagePath, data, userLocale);
             }
         }
     }
 
-    public static async create(depsQuery: DepsQuery, packageName: string, packageVersion: string, packageDir: string): Promise<PkgData | undefined> {
+    public static async create(depsQuery: DepsQuery, packageName: string, packageVersion: string, packageDir: string, lang: string): Promise<PkgData | undefined> {
         const packagePath = await resolveManifest(packageDir, "package");
         if (packagePath) {
-            const data = readManifestFile(packagePath);
-            const localePath = await resolveLocaleFile(packageDir);
+            const data = await readManifestFile(packagePath);
+            const localePath = await resolveLocaleFile(packageDir, lang);
             const userLocale = localePath ? await readJSONFile(localePath) : undefined;
+            if (!userLocale && lang && lang !== "en") {
+                return;
+            }
             if (data) {
                 return new PkgData(depsQuery, packageName, packageVersion, packageDir, packagePath, data, userLocale);
             }
@@ -712,8 +725,8 @@ class SubflowBlockData implements SharedBlockData, FlowLikeData {
     }
 }
 
-async function resolveLocaleFile(dirPath: string): Promise<string | undefined> {
-    const filePath = path.join(dirPath, "oo-locales/en.json");
+async function resolveLocaleFile(dirPath: string, lang?: string): Promise<string | undefined> {
+    const filePath = path.join(dirPath, "oo-locales", `${lang || "en"}.json`);
     if (await isFile(filePath)) {
         return filePath;
     }
@@ -731,16 +744,22 @@ async function resolveManifest(dirPath: string, type: string): Promise<string |
 }
 
 async function readManifestFile(manifestPath: string): Promise<Record<string, any> | undefined> {
+    if (manifestFileCache.has(manifestPath)) {
+        return manifestFileCache.get(manifestPath) || undefined;
+    }
     try {
         const content = await readFile(manifestPath);
         if (content) {
             const data = YAML.parse(content);
             if (isPlainObject(data)) {
+                manifestFileCache.set(manifestPath, data);
                 return data;
             }
         }
+        manifestFileCache.set(manifestPath, null);
     }
     catch {
+        manifestFileCache.set(manifestPath, null);
         return undefined;
     }
 }

tests/fixtures/pack_ignore/_gitignore

@@ -1,5 +1,6 @@
 aaa
 
 .oo-thumbnail.json
+.oo-thumbnail.zh-CN.json
 
 foo.txt