@examplary/cli 1.14.0 → 1.15.0

package/README.md

@@ -25,6 +25,10 @@ You'll be required to pass a `--key` argument with your API key, which you can
 obtain from your Examplary account settings. You can also set the `EXAMPLARY_API_KEY`
 environment variable to avoid passing the key every time.
 
+A `README.md` and `preview.png` in the same directory are uploaded as the question type's
+documentation and preview image, along with any translations named by language code, like
+`README.nl.md` or `preview.nl.png`.
+
 ## Validating
 
 To run all of the pre-upload checks without uploading anything, use:

package/dist/commands/upload.js

@@ -1,10 +1,29 @@
 #! /usr/bin/env node
-import { readFile } from "fs/promises";
+import { readdir, readFile } from "fs/promises";
 import { join } from "path";
 import { cwd, exit } from "process";
 import { setApiHost, setApiKey, uploadFile } from "../lib/api.js";
 import { readJsonOrYamlFile, readMetaFile } from "../lib/read-meta.js";
 import { isValid, printValidationResult, validateDefinition, } from "../lib/validate.js";
+/**
+ * Uploads e.g. `README.md` (English) and its translations like `README.nl.md`,
+ * returning their URLs keyed by language code.
+ */
+const uploadLocalizedFiles = async (dir, baseName, extension, contentType) => {
+    const pattern = new RegExp(`^${baseName}(?:\\.([a-z]{2}))?\\.${extension}$`);
+    const urls = {};
+    for (const file of await readdir(dir)) {
+        const match = file.match(pattern);
+        if (!match)
+            continue;
+        const contents = await readFile(join(dir, file));
+        if (!contents.length)
+            continue;
+        urls[match[1] || "en"] = await uploadFile(file, contents, contentType);
+        console.log(`• Uploaded ${file}`);
+    }
+    return Object.keys(urls).length ? urls : undefined;
+};
 export const uploadCommand = async (argv) => {
     setApiHost(argv.host);
     setApiKey(argv.key);
@@ -62,18 +81,10 @@ export const uploadCommand = async (argv) => {
         definition.icon = await uploadFile("icon.svg", result.iconContents, "image/svg+xml");
         console.log(`• Uploaded icon`);
     }
-    // Upload the README if present
-    const readme = await readFile(join(dir, "README.md"), "utf-8").catch(() => null);
-    if (readme) {
-        definition.readme = await uploadFile("README.md", readme, "text/markdown");
-        console.log(`• Uploaded README`);
-    }
-    // Upload the preview image if present
-    const previewImage = await readFile(join(dir, "preview.png")).catch(() => null);
-    if (previewImage) {
-        definition.previewImage = await uploadFile("preview.png", previewImage, "image/png");
-        console.log(`• Uploaded preview image`);
-    }
+    definition.readmeUrls = await uploadLocalizedFiles(dir, "README", "md", "text/markdown");
+    definition.readme = definition.readmeUrls?.en;
+    definition.previewImageUrls = await uploadLocalizedFiles(dir, "preview", "png", "image/png");
+    definition.previewImage = definition.previewImageUrls?.en;
     // Upload the preview data if present, always converted to JSON
     try {
         const preview = await readJsonOrYamlFile(dir, "preview");