@sdeverywhere/create 0.2.25 → 0.2.27

package/dist/index.js

@@ -1,7 +1,7 @@
 // src/index.ts
 import { existsSync as existsSync5 } from "fs";
-import { relative as relative3, resolve as resolvePath5 } from "path";
-import { bgCyan, black, bold as bold7, cyan as cyan6, dim as dim9, green as green9 } from "kleur/colors";
+import { posix as posix2, relative as relative3, resolve as resolvePath5 } from "path";
+import { bgCyan, black, bold as bold8, cyan as cyan5, dim as dim9, green as green9 } from "kleur/colors";
 import ora9 from "ora";
 import prompts9 from "prompts";
 import detectPackageManager from "which-pm-runs";
@@ -64,7 +64,6 @@ import { dirname, join as joinPath, parse as parsePath, relative, resolve as res
 import { bold as bold2, cyan, dim as dim2, green as green2, reset, yellow } from "kleur/colors";
 import ora2 from "ora";
 import prompts2 from "prompts";
-import yaml from "yaml";
 import { parseAndGenerate } from "@sdeverywhere/compile";
 var sampleChecksContent = `# yaml-language-server: $schema=SCHEMA_PATH
 
@@ -111,7 +110,7 @@ async function updateSdeConfig(projDir, mdlPath, genFormat) {
   const configPath = joinPath(projDir, "sde.config.js");
   let configText = await readFile(configPath, "utf8");
   configText = configText.replace(`const genFormat = 'js'`, `const genFormat = '${genFormat}'`);
-  configText = configText.replaceAll("MODEL_NAME.mdl", mdlPath);
+  configText = configText.replaceAll("model/MODEL_NAME.mdl", mdlPath);
   await writeFile(configPath, configText);
 }
 async function generateYaml(projDir, kind, template) {
@@ -249,16 +248,21 @@ async function chooseGenGraphConfig(projDir, mdlVars) {
       }
     }
   );
+  const graphsCsvFile = joinPath(projDir, "config", "graphs.csv");
+  const origGraphsCsvContent = await readFile(graphsCsvFile, "utf8");
+  const graphsCsvHeader = origGraphsCsvContent.split("\n")[0];
+  let newGraphsCsvContent = `${graphsCsvHeader}
+`;
+  if (varsResponse.vars.length > 0) {
+    const csvLine = graphsCsvLine(varsResponse.vars);
+    newGraphsCsvContent += `${csvLine}
+`;
+  }
+  await writeFile(graphsCsvFile, newGraphsCsvContent);
   if (varsResponse.vars.length === 0) {
     ora2().info(dim2(`No variables selected. You can edit the "${cyan("config/graphs.csv")}" file later.`));
     return;
   }
-  const graphsCsvFile = joinPath(projDir, "config", "graphs.csv");
-  const csvLine = graphsCsvLine(varsResponse.vars);
-  let graphsCsvContent = await readFile(graphsCsvFile, "utf8");
-  graphsCsvContent += `${csvLine}
-`;
-  await writeFile(graphsCsvFile, graphsCsvContent);
   ora2(
     green2(`Added graph to "${bold2("config/graphs.csv")}". ${dim2("You can configure graphs in that file later.")}`)
   ).succeed();
@@ -332,24 +336,29 @@ async function chooseGenSliderConfig(projDir, mdlVars) {
       }
     }
   );
-  if (varsResponse.vars.length === 0) {
-    ora2().info(dim2(`No variables selected. You can edit the "${cyan("config/inputs.csv")}" file later.`));
-    return;
-  }
   const inputsCsvFile = joinPath(projDir, "config", "inputs.csv");
-  let inputsCsvContent = await readFile(inputsCsvFile, "utf8");
-  let idNumber = 1;
-  for (const inputVarName of varsResponse.vars) {
-    const inputVar = mdlVars.find((v) => v.name === inputVarName);
-    if (inputVar && inputVar.kind === "const") {
-      const defaultValue = inputVar.value;
-      const csvLine = inputsCsvLine(inputVarName, defaultValue, idNumber.toString());
-      inputsCsvContent += `${csvLine}
+  const origInputsCsvContent = await readFile(inputsCsvFile, "utf8");
+  const inputsCsvHeader = origInputsCsvContent.split("\n")[0];
+  let newInputsCsvContent = `${inputsCsvHeader}
 `;
-      idNumber++;
+  if (varsResponse.vars.length > 0) {
+    let idNumber = 1;
+    for (const inputVarName of varsResponse.vars) {
+      const inputVar = mdlVars.find((v) => v.name === inputVarName);
+      if (inputVar && inputVar.kind === "const") {
+        const defaultValue = inputVar.value;
+        const csvLine = inputsCsvLine(inputVarName, defaultValue, idNumber.toString());
+        newInputsCsvContent += `${csvLine}
+`;
+        idNumber++;
+      }
     }
   }
-  await writeFile(inputsCsvFile, inputsCsvContent);
+  await writeFile(inputsCsvFile, newInputsCsvContent);
+  if (varsResponse.vars.length === 0) {
+    ora2().info(dim2(`No variables selected. You can edit the "${cyan("config/inputs.csv")}" file later.`));
+    return;
+  }
   const slidersText = varsResponse.vars.length > 1 ? "sliders" : "sliders";
   ora2(
     green2(
@@ -388,9 +397,10 @@ async function readModelVars(projDir, mdlPath) {
   const mdlDir = dirname(mdlFile);
   const mdlName = parsePath(mdlFile).name;
   await parseAndGenerate(mdlContent, spec, ["printVarList"], mdlDir, mdlName, buildDir);
-  const varsYamlFile = joinPath(buildDir, `${mdlName}_vars.yaml`);
-  const varsYamlContent = await readFile(varsYamlFile, "utf8");
-  const varObjs = yaml.parse(varsYamlContent);
+  const jsonListFile = joinPath(buildDir, `${mdlName}.json`);
+  const jsonListContent = await readFile(jsonListFile, "utf8");
+  const jsonList = JSON.parse(jsonListContent);
+  const varObjs = jsonList.variables;
   const mdlVars = [];
   for (const varObj of varObjs) {
     switch (varObj.varType) {
@@ -686,29 +696,11 @@ async function chooseGitInit(projDir, args) {
 }
 
 // src/step-mdl.ts
-import { readdir, writeFile as writeFile2 } from "fs/promises";
-import { join as joinPath3, relative as relative2, resolve as resolvePath4, sep, posix } from "path";
-import { bold as bold6, cyan as cyan5, dim as dim7, green as green7, yellow as yellow4 } from "kleur/colors";
+import { readdir } from "fs/promises";
+import { relative as relative2, resolve as resolvePath4, sep, posix } from "path";
+import { bold as bold6, dim as dim7, green as green7, yellow as yellow4 } from "kleur/colors";
 import ora7 from "ora";
 import prompts7 from "prompts";
-var sampleMdlContent = `{UTF-8}
-
-X = TIME
-  ~~|
-
-Y = 0
-  ~ [-10,10,0.1]
-  ~
-  |
-
-Z = X + Y
-  ~~|
-
-INITIAL TIME = 2000 ~~|
-FINAL TIME = 2100 ~~|
-TIME STEP = 1 ~~|
-SAVEPER = TIME STEP ~~|
-`;
 async function chooseMdlFile(projDir) {
   async function getFiles(dir) {
     const dirents = await readdir(dir, { withFileTypes: true });
@@ -730,19 +722,11 @@ async function chooseMdlFile(projDir) {
   });
   let mdlFile;
   if (mdlFiles.length === 0) {
-    const sampleMdlFile = joinPath3(projDir, "sample.mdl");
-    await writeFile2(sampleMdlFile, sampleMdlContent);
-    ora7(
-      yellow4(
-        `No mdl files were found in "${projDir}". A "${cyan5(
-          "sample.mdl"
-        )}" file has been added to the project to get you started.`
-      )
-    ).warn();
-    mdlFile = "sample.mdl";
+    ora7(yellow4(`No mdl files were found in "${projDir}". The mdl file from the template will be used instead.`)).warn();
+    mdlFile = void 0;
   } else if (mdlFiles.length === 1) {
-    ora7().succeed(`Found "${mdlFiles[0]}", will configure the project to use that mdl file.`);
     mdlFile = mdlFiles[0];
+    ora7().succeed(`Found "${mdlFile}", will configure the project to use that mdl file.`);
   } else {
     const options = await prompts7(
       [
@@ -761,88 +745,105 @@ async function chooseMdlFile(projDir) {
       }
     );
     mdlFile = options.mdlFile;
+    ora7(green7(`Using "${bold6(mdlFile)}" as the model for the project.`)).succeed();
   }
-  ora7(green7(`Using "${bold6(mdlFile)}" as the model for the project.`)).succeed();
   return mdlFile;
 }
 
 // src/step-template.ts
-import { existsSync as existsSync4, mkdtempSync, readdirSync, rmSync as rmSync2 } from "fs";
-import { writeFile as writeFile3 } from "fs/promises";
+import { existsSync as existsSync4, mkdtempSync, readdirSync, renameSync, rmSync as rmSync2 } from "fs";
+import { writeFile as writeFile2 } from "fs/promises";
 import { copy } from "fs-extra";
 import { tmpdir } from "os";
-import { join as joinPath4 } from "path";
+import { join as joinPath3 } from "path";
 import { downloadTemplate } from "giget";
-import { dim as dim8, green as green8, red as red3, yellow as yellow5 } from "kleur/colors";
+import { bold as bold7, dim as dim8, green as green8, red as red3, yellow as yellow5 } from "kleur/colors";
 import ora8 from "ora";
 import prompts8 from "prompts";
 var TEMPLATES = [
   {
-    title: "Default project",
-    description: "Includes recommended structure with config files, app, core library, model-check, etc",
-    value: "template-default"
+    title: "Default (jQuery) project",
+    description: "Includes recommended structure with config files, jQuery-based app, core library, model-check, etc",
+    value: "default"
+  },
+  {
+    title: "Svelte project",
+    description: "Includes recommended structure with config files, Svelte-based app, core library, model-check, etc",
+    value: "svelte"
   },
   {
     title: "Minimal project",
     description: "Includes simple config for model-check",
-    value: "template-minimal"
+    value: "minimal"
   }
 ];
-async function chooseTemplate(projDir, args, pkgManager) {
-  const options = await prompts8(
-    [
+async function chooseTemplate(args) {
+  let templateName;
+  if (args.template) {
+    templateName = args.template;
+  } else {
+    const options = await prompts8(
+      [
+        {
+          type: "select",
+          name: "template",
+          message: "Which template would you like to use?",
+          choices: TEMPLATES
+        }
+      ],
       {
-        type: "select",
-        name: "template",
-        message: "Which template would you like to use?",
-        choices: TEMPLATES
-      }
-    ],
-    {
-      onCancel: () => {
-        ora8().info(dim8("Operation cancelled."));
-        process.exit(0);
+        onCancel: () => {
+          ora8().info(dim8("Operation cancelled."));
+          process.exit(0);
+        }
       }
-    }
-  );
-  if (args.dryRun) {
-    ora8().info(dim8(`--dry-run enabled, skipping.`));
-    return;
+    );
+    templateName = options.template;
   }
   const defaultRev = "main";
   const commit = args.commit || defaultRev;
-  const templateTarget = `climateinteractive/SDEverywhere/examples/${options.template}#${commit}`;
-  const templateSpinner = ora8("Copying project files...").start();
-  await copyTemplate(templateTarget, projDir, templateSpinner);
-  templateSpinner.text = green8("Template copied!");
-  templateSpinner.succeed();
-  if (options.template === "template-default" && pkgManager === "pnpm") {
-    const workspaceFile = joinPath4(projDir, "pnpm-workspace.yaml");
-    const workspaceContent = `packages:
-  - packages/*
-`;
-    await writeFile3(workspaceFile, workspaceContent);
+  let baseTemplateUri;
+  if (templateName.includes(":")) {
+    baseTemplateUri = templateName;
+  } else if (templateName.includes("/")) {
+    baseTemplateUri = `github:${templateName}`;
+  } else {
+    baseTemplateUri = `github:climateinteractive/SDEverywhere/examples/template-${templateName}`;
   }
-  return options.template;
+  const templateUri = `${baseTemplateUri}#${commit}`;
+  ora8(green8(`Using "${bold7(templateUri)}" as the template for the project.`)).succeed();
+  return {
+    uri: templateUri,
+    name: templateName
+  };
 }
-async function copyTemplate(templateTarget, dstDir, spinner) {
+async function copyTemplate(template, projDir, pkgManager, configDirExisted, mdlExisted) {
+  const templateSpinner = ora8("Copying template files...").start();
   try {
-    const tmpDir = mkdtempSync(joinPath4(tmpdir(), "sde-create-"));
-    await downloadTemplate(`github:${templateTarget}`, {
+    const tmpDir = mkdtempSync(joinPath3(tmpdir(), "sde-create-"));
+    await downloadTemplate(template.uri, {
       force: true,
-      provider: "github",
       dir: tmpDir
     });
     if (!existsSync4(tmpDir) || readdirSync(tmpDir).length === 0) {
       throw new Error("Failed to download the requested template: the temporary directory is empty.");
     }
-    await copy(tmpDir, dstDir, {
+    if (configDirExisted) {
+      rmSync2(joinPath3(tmpDir, "config"), { recursive: true, force: true });
+    }
+    if (mdlExisted) {
+      rmSync2(joinPath3(tmpDir, "model"), { recursive: true, force: true });
+    }
+    await copy(tmpDir, projDir, {
       overwrite: false,
       errorOnExist: false
     });
+    if (!mdlExisted) {
+      renameSync(joinPath3(projDir, "model", "MODEL_NAME.mdl"), joinPath3(projDir, "model", "sample.mdl"));
+    }
     rmSync2(tmpDir, { recursive: true, force: true });
   } catch (e) {
-    spinner.fail();
+    templateSpinner.fail();
     console.error(red3(e.message));
     console.error(yellow5("\nThere was a problem copying the template."));
     console.error(
@@ -852,6 +853,15 @@ async function copyTemplate(templateTarget, dstDir, spinner) {
     );
     process.exit(0);
   }
+  if (existsSync4(joinPath3(projDir, "packages")) && pkgManager === "pnpm") {
+    const workspaceFile = joinPath3(projDir, "pnpm-workspace.yaml");
+    const workspaceContent = `packages:
+  - packages/*
+`;
+    await writeFile2(workspaceFile, workspaceContent);
+  }
+  templateSpinner.text = green8("Template copied!");
+  templateSpinner.succeed();
 }
 
 // src/index.ts
@@ -864,34 +874,44 @@ async function main() {
     ora9().info(dim9(`--dry-run enabled, no files will be written.`));
   }
   console.log(`
-${bold7("Welcome to SDEverywhere!")}`);
+${bold8("Welcome to SDEverywhere!")}`);
   console.log(`Let's create a new SDEverywhere project for your model.
 `);
   const projDir = await chooseProjectDir(args);
   console.log();
   const configDirExisted = existsSync5(resolvePath5(projDir, "config"));
-  const templateName = await chooseTemplate(projDir, args, pkgManager);
+  const template = await chooseTemplate(args);
   console.log();
-  const mdlPath = await chooseMdlFile(projDir);
+  let mdlPath = await chooseMdlFile(projDir);
+  const mdlExisted = mdlPath !== void 0;
   console.log();
+  if (!args.dryRun) {
+    await copyTemplate(template, projDir, pkgManager, configDirExisted, mdlExisted);
+    console.log();
+  }
+  if (mdlPath === void 0) {
+    mdlPath = `model${posix2.sep}sample.mdl`;
+  }
   const genFormat = await chooseCodeFormat();
   if (!args.dryRun) {
     await updateSdeConfig(projDir, mdlPath, genFormat);
-    await generateSampleYamlFiles(projDir);
+    const modelCheckFilesExist = existsSync5(resolvePath5(projDir, "model", "checks")) || existsSync5(resolvePath5(projDir, "model", "comparisons"));
+    if (!modelCheckFilesExist) {
+      await generateSampleYamlFiles(projDir);
+    }
   }
   console.log();
-  if (templateName === "template-default") {
-    if (configDirExisted) {
-      ora9().succeed(`Found existing "${bold7("config")}" directory.`);
-      ora9().info(
-        dim9(`You can edit the files in the "${cyan6("config")}" directory later to configure graphs and sliders.`)
-      );
+  if (configDirExisted) {
+    ora9().succeed(`Found existing "${bold8("config")}" directory.`);
+    ora9().info(
+      dim9(`You can edit the files in the "${cyan5("config")}" directory later to configure graphs and sliders.`)
+    );
+    console.log();
+  } else {
+    const configDirExistsNow = existsSync5(resolvePath5(projDir, "config"));
+    if (configDirExistsNow && mdlExisted && !args.dryRun) {
+      await chooseGenConfig(projDir, mdlPath);
       console.log();
-    } else {
-      if (!args.dryRun) {
-        await chooseGenConfig(projDir, mdlPath);
-        console.log();
-      }
     }
   }
   if (genFormat === "c") {
@@ -909,9 +929,9 @@ ${bgCyan(black(" Next steps "))}
   const relProjDir = relative3(process.cwd(), projDir);
   const devCmd = pkgManager === "npm" ? "npm run dev" : `${pkgManager} dev`;
   if (relProjDir !== "") {
-    console.log(`You can now ${bold7(cyan6("cd"))} into the ${bold7(cyan6(relProjDir))} project directory.`);
+    console.log(`You can now ${bold8(cyan5("cd"))} into the ${bold8(cyan5(relProjDir))} project directory.`);
   }
-  console.log(`Run ${bold7(cyan6(devCmd))} to start the local dev server. ${bold7(cyan6("CTRL-C"))} to close.`);
+  console.log(`Run ${bold8(cyan5(devCmd))} to start the local dev server. ${bold8(cyan5("CTRL-C"))} to close.`);
   console.log("");
 }
 export {