@examplary/cli 1.5.0 → 1.6.0

package/README.md

@@ -15,7 +15,7 @@ npx @examplary/cli preview
 ```
 
 To upload your custom question type, run the following command in a directory
-that contains a `question-type.json` file:
+that contains a `question-type.json` or `question-type.yml` file:
 
 ```bash
 npx @examplary/cli upload

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@examplary/cli",
-  "description": "A bundler for Examplary question types.",
+  "description": "Command-line tools for building and publishing Examplary question types.",
   "packageManager": "yarn@4.8.1",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "type": "module",
   "bin": {
     "exp": "./bin/index.js"
@@ -44,6 +44,7 @@
     "use-local-storage": "^3.0.0",
     "vite": "^8.0.0",
     "ws": "^8.18.3",
+    "yaml": "^2.8.2",
     "yargs": "^18.0.0"
   },
   "devDependencies": {

package/src/commands/preview.js

@@ -1,8 +1,8 @@
 #! /usr/bin/env node
 import { watch } from "fs";
-import { stat, readFile } from "fs/promises";
+import { readFile } from "fs/promises";
 import { createServer as createHttpServer } from "http";
-import path, { join, resolve } from "path";
+import path, { resolve } from "path";
 import { cwd, exit } from "process";
 
 import { serve } from "@hono/node-server";
@@ -16,19 +16,20 @@ import { WebSocketServer } from "ws";
 import { setApiHost, setApiKey } from "../lib/api.js";
 import { buildComponent } from "../lib/bundle.js";
 import { adaptExpressMiddleware } from "../lib/middleware.js";
+import { readMetaFile } from "../lib/read-meta.js";
 import { buildStyles } from "../lib/styles.js";
 
 export const previewCommand = async (argv) => {
   setApiHost(argv.host);
   setApiKey(argv.key);
 
-  // Let's check a question-type.json file exists
   const dir = cwd();
-  const metaFilePath = join(dir, "question-type.json");
+
+  // Verify a question-type file exists (json or yml)
   try {
-    await stat(metaFilePath);
+    await readMetaFile();
   } catch (e) {
-    console.error(`🚫 Error reading question-type.json: ${e.message}`);
+    console.error(`🚫 ${e.message}`);
     exit(1);
   }
 
@@ -121,7 +122,7 @@ export const previewCommand = async (argv) => {
   app.get("/", async (c) => {
     let questionType;
     try {
-      questionType = JSON.parse(await readFile(metaFilePath, "utf-8"));
+      ({ definition: questionType } = await readMetaFile());
       questionType.components = questionType.components
         ? Object.entries(questionType.components).reduce(
             (acc, [componentName, componentPath]) => ({
@@ -132,7 +133,10 @@ export const previewCommand = async (argv) => {
           )
         : questionType.components;
     } catch (e) {
-      return c.text(`Error reading question-type.json: ${e.message}`, 500);
+      return c.text(
+        `Error reading question type definition: ${e.message}`,
+        500,
+      );
     }
 
     let template = await readFile(resolve(root, "index.html"), "utf-8");

package/src/commands/upload.js

@@ -1,36 +1,24 @@
 #! /usr/bin/env node
 import { readFile } from "fs/promises";
-import { join, resolve } from "path";
+import { resolve } from "path";
 import { cwd, exit } from "process";
 
 import { setApiHost, setApiKey, uploadFile } from "../lib/api.js";
 import { buildComponent } from "../lib/bundle.js";
 import { deepCompileJsonata } from "../lib/jsonata.js";
+import { readMetaFile } from "../lib/read-meta.js";
 import { buildStyles } from "../lib/styles.js";
 
 export const uploadCommand = async (argv) => {
   setApiHost(argv.host);
   setApiKey(argv.key);
 
-  // Try to read the question-type.json files in the current directory
   const dir = cwd();
-  const metaFilePath = join(dir, "question-type.json");
-  let metaFileContents;
   let definition = {};
   try {
-    metaFileContents = await readFile(metaFilePath, "utf-8");
+    ({ definition } = await readMetaFile());
   } catch (e) {
-    console.error(`🚫 Error reading question-type.json: ${e.message}`);
-    exit(1);
-  }
-
-  // Read JSON
-  try {
-    const json = JSON.parse(metaFileContents);
-    definition = json;
-    if (definition.$schema) delete definition.$schema;
-  } catch (error) {
-    console.error(`🚫 Invalid JSON file: ${error.message}`);
+    console.error(`🚫 ${e.message}`);
     exit(1);
   }
   console.log(`Uploading question type: ${definition.id}...`);

package/src/lib/read-meta.js

@@ -0,0 +1,40 @@
+import { readFile } from "fs/promises";
+import { join } from "path";
+import { cwd } from "process";
+
+import yaml from "yaml";
+
+/**
+ * Reads and parses the question-type definition file.
+ * Prefers question-type.json over question-type.yml.
+ */
+export const readMetaFile = async () => {
+  const dir = cwd();
+  const jsonPath = join(dir, "question-type.json");
+  const ymlPath = join(dir, "question-type.yml");
+
+  // Try JSON first, then YAML
+  for (const { path, parse, format } of [
+    { path: jsonPath, parse: JSON.parse, format: "JSON" },
+    { path: ymlPath, parse: yaml.parse, format: "YAML" },
+  ]) {
+    let contents;
+    try {
+      contents = await readFile(path, "utf-8");
+    } catch {
+      continue;
+    }
+
+    try {
+      const definition = parse(contents);
+      if (definition.$schema) delete definition.$schema;
+      return { definition, path };
+    } catch (error) {
+      throw new Error(`Invalid ${format} in ${path}: ${error.message}`);
+    }
+  }
+
+  throw new Error(
+    "No question-type.json or question-type.yml found in the current directory",
+  );
+};