ic-mops 1.12.0 → 2.0.0

package/types.ts

@@ -1,46 +1,56 @@
 export type Config = {
-	package ?: {
-		name : string;
-		version : string;
-		description ?: string;
-		license ?: string;
-		repository ?: string;
-		keywords ?: string[];
-		baseDir ?: string;
-		readme ?: string;
-		files ?: string[];
-		homepage ?: string;
-		documentation ?: string;
-		dfx ?: string;
-		moc ?: string;
-		donation ?: string;
-	};
-	dependencies ?: Dependencies;
-	'dev-dependencies' ?: Dependencies;
-	toolchain ?: Toolchain;
-	requirements ?: Requirements;
-	// format ?: Format;
+  package?: {
+    name: string;
+    version: string;
+    description?: string;
+    license?: string;
+    repository?: string;
+    keywords?: string[];
+    baseDir?: string;
+    readme?: string;
+    files?: string[];
+    homepage?: string;
+    documentation?: string;
+    dfx?: string;
+    moc?: string;
+    donation?: string;
+  };
+  dependencies?: Dependencies;
+  "dev-dependencies"?: Dependencies;
+  toolchain?: Toolchain;
+  requirements?: Requirements;
+  canisters?: Record<string, string | CanisterConfig>;
+  build?: {
+    outputDir?: string;
+    args?: string[];
+  };
+};
+
+export type CanisterConfig = {
+  main: string;
+  args?: string[];
+  candid?: string;
 };
 
 export type Dependencies = Record<string, Dependency>;
 
 export type Dependency = {
-	name : string;
-	version ?: string; // mops package
-	repo ?: string; // github package
-	path ?: string; // local package
+  name: string;
+  version?: string; // mops package
+  repo?: string; // github package
+  path?: string; // local package
 };
 
 export type Toolchain = {
-	moc ?: string;
-	wasmtime ?: string;
-	'pocket-ic' ?: string;
+  moc?: string;
+  wasmtime?: string;
+  "pocket-ic"?: string;
 };
 
-export type Tool = 'moc' | 'wasmtime' | 'pocket-ic';
+export type Tool = "moc" | "wasmtime" | "pocket-ic";
 
 export type Requirements = {
-	moc ?: string;
+  moc?: string;
 };
 
 // export type Format = {
@@ -52,4 +62,4 @@ export type Requirements = {
 // 	trailingComma ?: 'none' | 'all';
 // };
 
-export type TestMode = 'interpreter' | 'wasi' | 'replica';
+export type TestMode = "interpreter" | "wasi" | "replica";

package/vessel.ts

@@ -1,199 +1,231 @@
-import process from 'node:process';
-import {existsSync, mkdirSync, createWriteStream, readFileSync, writeFileSync} from 'node:fs';
-import path from 'node:path';
-import {pipeline} from 'node:stream';
-import {deleteSync} from 'del';
-import {execaCommand} from 'execa';
-import chalk from 'chalk';
-import {createLogUpdate} from 'log-update';
-import got from 'got';
-import decompress from 'decompress';
-import {parseGithubURL, progressBar} from './mops.js';
-import {getDepCacheDir, getGithubDepCacheName, isDepCached} from './cache.js';
-
-const dhallFileToJson = async (filePath : string, silent : boolean) => {
-	if (existsSync(filePath)) {
-		let cwd = new URL(path.dirname(import.meta.url)).pathname;
-		let res;
-		try {
-			res = await execaCommand(`dhall-to-json --file ${filePath}`, {preferLocal:true, cwd});
-		}
-		catch (err : any) {
-			silent || console.error('dhall-to-json error:', err.message?.split('Message:')[0]);
-			return null;
-		}
-
-		if (res.exitCode === 0) {
-			return JSON.parse(res.stdout);
-		}
-		else {
-			return res;
-		}
-	}
-
-	return null;
+import process from "node:process";
+import {
+  existsSync,
+  mkdirSync,
+  createWriteStream,
+  readFileSync,
+  writeFileSync,
+} from "node:fs";
+import path from "node:path";
+import { pipeline } from "node:stream";
+import { deleteSync } from "del";
+import { execaCommand } from "execa";
+import chalk from "chalk";
+import { createLogUpdate } from "log-update";
+import got from "got";
+import decompress from "decompress";
+import { parseGithubURL, progressBar } from "./mops.js";
+import { getDepCacheDir, getGithubDepCacheName, isDepCached } from "./cache.js";
+
+const dhallFileToJson = async (filePath: string, silent: boolean) => {
+  if (existsSync(filePath)) {
+    let cwd = new URL(path.dirname(import.meta.url)).pathname;
+    let res;
+    try {
+      res = await execaCommand(`dhall-to-json --file ${filePath}`, {
+        preferLocal: true,
+        cwd,
+      });
+    } catch (err: any) {
+      silent ||
+        console.error(
+          "dhall-to-json error:",
+          err.message?.split("Message:")[0],
+        );
+      return null;
+    }
+
+    if (res.exitCode === 0) {
+      return JSON.parse(res.stdout);
+    } else {
+      return res;
+    }
+  }
+
+  return null;
 };
 
 export type VesselConfig = {
-	dependencies : VesselDependencies;
-	'dev-dependencies' : VesselDependencies;
+  dependencies: VesselDependencies;
+  "dev-dependencies": VesselDependencies;
 };
 
 export type VesselDependencies = Array<{
-	name : string;
-	version ?: string; // mops package
-	repo ?: string; // github package
-	path ?: string; // local package
+  name: string;
+  version?: string; // mops package
+  repo?: string; // github package
+  path?: string; // local package
 }>;
 
-export const readVesselConfig = async (dir : string, {cache = true, silent = false} = {}) : Promise<VesselConfig | null> => {
-	const cachedFile = (dir || process.cwd()) + '/vessel.json';
-
-	if (existsSync(cachedFile)) {
-		let cachedConfig = readFileSync(cachedFile).toString();
-		return JSON.parse(cachedConfig);
-	}
-
-	const [vessel, packageSetArray] = await Promise.all([
-		dhallFileToJson((dir || process.cwd()) + '/vessel.dhall', silent),
-		dhallFileToJson((dir || process.cwd()) + '/package-set.dhall', silent),
-	]);
-
-	if (!vessel || !packageSetArray) {
-		return null;
-	}
-
-	let repos : Record<string, string> = {};
-	for (const {name, repo, version} of packageSetArray) {
-		const {org, gitName} = parseGithubURL(repo);
-		repos[name] = `https://github.com/${org}/${gitName}#${version}`;
-	}
-
-	let config : VesselConfig = {
-		dependencies: vessel.dependencies.map((name : string) => {
-			return {name, repo: repos[name], version: ''};
-		}),
-		'dev-dependencies': [],
-	};
-
-	if (cache === true) {
-		writeFileSync(cachedFile, JSON.stringify(config), 'utf-8');
-	}
-
-	return config;
+export const readVesselConfig = async (
+  dir: string,
+  { cache = true, silent = false } = {},
+): Promise<VesselConfig | null> => {
+  const cachedFile = (dir || process.cwd()) + "/vessel.json";
+
+  if (existsSync(cachedFile)) {
+    let cachedConfig = readFileSync(cachedFile).toString();
+    return JSON.parse(cachedConfig);
+  }
+
+  const [vessel, packageSetArray] = await Promise.all([
+    dhallFileToJson((dir || process.cwd()) + "/vessel.dhall", silent),
+    dhallFileToJson((dir || process.cwd()) + "/package-set.dhall", silent),
+  ]);
+
+  if (!vessel || !packageSetArray) {
+    return null;
+  }
+
+  let repos: Record<string, string> = {};
+  for (const { name, repo, version } of packageSetArray) {
+    const { org, gitName } = parseGithubURL(repo);
+    repos[name] = `https://github.com/${org}/${gitName}#${version}`;
+  }
+
+  let config: VesselConfig = {
+    dependencies: vessel.dependencies.map((name: string) => {
+      return { name, repo: repos[name], version: "" };
+    }),
+    "dev-dependencies": [],
+  };
+
+  if (cache === true) {
+    writeFileSync(cachedFile, JSON.stringify(config), "utf-8");
+  }
+
+  return config;
 };
 
-export const downloadFromGithub = async (repo : string, dest : string, onProgress : any) => {
-	const {branch, org, gitName, commitHash} = parseGithubURL(repo);
-
-	const zipFile = `https://github.com/${org}/${gitName}/archive/${commitHash || branch}.zip`;
-	const readStream = got.stream(zipFile);
-
-	const promise = new Promise((resolve, reject) => {
-		readStream.on('error', (err) => {
-			console.error(chalk.red(`Error: failed to download from GitHub: ${zipFile}`));
-			console.error(err.message);
-			reject(err);
-		});
-
-		readStream.on('downloadProgress', ({transferred, total}) => {
-			onProgress?.(transferred, total || 2 * (1024 ** 2));
-		});
-
-		readStream.on('response', (response) => {
-			if (response.headers.age > 3600) {
-				console.error(chalk.red('Error: ') +  'Failure - response too old');
-				readStream.destroy(); // Destroy the stream to prevent hanging resources.
-				reject();
-				return;
-			}
-
-			// Prevent `onError` being called twice.
-			readStream.off('error', reject);
-			const tmpDir = path.resolve(process.cwd(), '.mops/_tmp/');
-			const tmpFile = path.resolve(tmpDir, `${gitName}@${(commitHash || branch).replaceAll('/', '___')}.zip`);
-
-			try {
-				mkdirSync(tmpDir, {recursive: true});
-
-				pipeline(readStream, createWriteStream(tmpFile), (err) => {
-					if (err) {
-						deleteSync([tmpDir]);
-						reject(err);
-					}
-					else {
-						let options = {
-							extract: true,
-							strip: 1,
-							headers: {
-								accept: 'application/zip',
-							},
-						};
-						decompress(tmpFile, dest, options).then((unzippedFiles) => {
-							deleteSync([tmpDir]);
-							resolve(unzippedFiles);
-						}).catch(err => {
-							deleteSync([tmpDir]);
-							reject(err);
-						});
-					}
-				});
-			}
-			catch (err) {
-				deleteSync([tmpDir]);
-				reject(err);
-			}
-		});
-	});
-
-	return promise;
+export const downloadFromGithub = async (
+  repo: string,
+  dest: string,
+  onProgress: any,
+) => {
+  const { branch, org, gitName, commitHash } = parseGithubURL(repo);
+
+  const zipFile = `https://github.com/${org}/${gitName}/archive/${commitHash || branch}.zip`;
+  const readStream = got.stream(zipFile);
+
+  const promise = new Promise((resolve, reject) => {
+    readStream.on("error", (err) => {
+      console.error(
+        chalk.red(`Error: failed to download from GitHub: ${zipFile}`),
+      );
+      console.error(err.message);
+      reject(err);
+    });
+
+    readStream.on("downloadProgress", ({ transferred, total }) => {
+      onProgress?.(transferred, total || 2 * 1024 ** 2);
+    });
+
+    readStream.on("response", (response) => {
+      if (response.headers.age > 3600) {
+        console.error(chalk.red("Error: ") + "Failure - response too old");
+        readStream.destroy(); // Destroy the stream to prevent hanging resources.
+        reject();
+        return;
+      }
+
+      // Prevent `onError` being called twice.
+      readStream.off("error", reject);
+      const tmpDir = path.resolve(process.cwd(), ".mops/_tmp/");
+      const tmpFile = path.resolve(
+        tmpDir,
+        `${gitName}@${(commitHash || branch).replaceAll("/", "___")}.zip`,
+      );
+
+      try {
+        mkdirSync(tmpDir, { recursive: true });
+
+        pipeline(readStream, createWriteStream(tmpFile), (err) => {
+          if (err) {
+            deleteSync([tmpDir]);
+            reject(err);
+          } else {
+            let options = {
+              extract: true,
+              strip: 1,
+              headers: {
+                accept: "application/zip",
+              },
+            };
+            decompress(tmpFile, dest, options)
+              .then((unzippedFiles) => {
+                deleteSync([tmpDir]);
+                resolve(unzippedFiles);
+              })
+              .catch((err) => {
+                deleteSync([tmpDir]);
+                reject(err);
+              });
+          }
+        });
+      } catch (err) {
+        deleteSync([tmpDir]);
+        reject(err);
+      }
+    });
+  });
+
+  return promise;
 };
 
-export const installFromGithub = async (name : string, repo : string, {verbose = false, dep = false, silent = false, ignoreTransitive = false} = {}) => {
-	let cacheName = getGithubDepCacheName(name, repo);
-	let cacheDir = getDepCacheDir(cacheName);
-
-	let logUpdate = createLogUpdate(process.stdout, {showCursor: true});
-
-	if (isDepCached(cacheName)) {
-		silent || logUpdate(`${dep ? 'Dependency' : 'Installing'} ${repo} (cache)`);
-	}
-	else {
-		let progress = (step : number, total : number) => {
-			silent || logUpdate(`${dep ? 'Dependency' : 'Installing'} ${repo} ${progressBar(step, total)}`);
-		};
-
-		progress(0, 1024 * 500);
-
-		mkdirSync(cacheDir, {recursive: true});
-
-		try {
-			await downloadFromGithub(repo, cacheDir, progress);
-		}
-		catch (err) {
-			deleteSync([cacheDir], {force: true});
-			process.exit(1);
-		}
-	}
-
-	if (verbose) {
-		silent || logUpdate.done();
-	}
-	else {
-		logUpdate.clear();
-	}
-
-	if (ignoreTransitive) {
-		return;
-	}
-
-	const config = await readVesselConfig(cacheDir, {silent});
-
-	if (config) {
-		for (const {name, repo} of config.dependencies) {
-			if (repo) {
-				await installFromGithub(name, repo, {verbose, silent, dep: true});
-			}
-		}
-	}
-};
+export const installFromGithub = async (
+  name: string,
+  repo: string,
+  {
+    verbose = false,
+    dep = false,
+    silent = false,
+    ignoreTransitive = false,
+  } = {},
+) => {
+  let cacheName = getGithubDepCacheName(name, repo);
+  let cacheDir = getDepCacheDir(cacheName);
+
+  let logUpdate = createLogUpdate(process.stdout, { showCursor: true });
+
+  if (isDepCached(cacheName)) {
+    silent || logUpdate(`${dep ? "Dependency" : "Installing"} ${repo} (cache)`);
+  } else {
+    let progress = (step: number, total: number) => {
+      silent ||
+        logUpdate(
+          `${dep ? "Dependency" : "Installing"} ${repo} ${progressBar(step, total)}`,
+        );
+    };
+
+    progress(0, 1024 * 500);
+
+    mkdirSync(cacheDir, { recursive: true });
+
+    try {
+      await downloadFromGithub(repo, cacheDir, progress);
+    } catch (err) {
+      deleteSync([cacheDir], { force: true });
+      process.exit(1);
+    }
+  }
+
+  if (verbose) {
+    silent || logUpdate.done();
+  } else {
+    logUpdate.clear();
+  }
+
+  if (ignoreTransitive) {
+    return;
+  }
+
+  const config = await readVesselConfig(cacheDir, { silent });
+
+  if (config) {
+    for (const { name, repo } of config.dependencies) {
+      if (repo) {
+        await installFromGithub(name, repo, { verbose, silent, dep: true });
+      }
+    }
+  }
+};