ic-mops 1.12.0 → 2.0.0

package/resolve-packages.ts

@@ -1,189 +1,231 @@
-import process from 'node:process';
-import path from 'node:path';
-import {existsSync} from 'node:fs';
-import chalk from 'chalk';
-import {checkConfigFile, getRootDir, parseGithubURL, readConfig} from './mops.js';
-import {VesselConfig, readVesselConfig} from './vessel.js';
-import {Config, Dependency} from './types.js';
-import {getDepCacheDir, getDepCacheName} from './cache.js';
-import {getPackageId} from './helpers/get-package-id.js';
-import {checkLockFileLight, readLockFile} from './integrity.js';
-
-export async function resolvePackages({conflicts = 'ignore' as 'warning' | 'error' | 'ignore'} = {}) : Promise<Record<string, string>> {
-	if (!checkConfigFile()) {
-		return {};
-	}
-
-	if (checkLockFileLight()) {
-		let lockFileJson = readLockFile();
-
-		if (lockFileJson && lockFileJson.version === 3) {
-			return lockFileJson.deps;
-		}
-	}
-
-	let rootDir = getRootDir();
-	let packages : Record<string, Dependency & {isRoot : boolean;}> = {};
-	let versions : Record<string, Array<{
-		isMopsPackage : boolean;
-		version : string;
-		dependencyOf : string;
-	}>> = {};
-
-	let compareVersions = (a : string = '0.0.0', b : string = '0.0.0') => {
-		let ap = a.split('.').map((x : string) => parseInt(x)) as [number, number, number];
-		let bp = b.split('.').map((x : string) => parseInt(x)) as [number, number, number];
-		if (ap[0] - bp[0]) {
-			return Math.sign(ap[0] - bp[0]);
-		}
-		if (ap[0] === bp[0] && ap[1] - bp[1]) {
-			return Math.sign(ap[1] - bp[1]);
-		}
-		if (ap[0] === bp[0] && ap[1] === bp[1] && ap[2] - bp[2]) {
-			return Math.sign(ap[2] - bp[2]);
-		}
-		return 0;
-	};
-
-	const gitVerRegex = new RegExp(/v(\d{1,2}\.\d{1,2}\.\d{1,2})(-.*)?$/);
-
-	const compareGitVersions = (repoA : string, repoB : string) => {
-		const {branch: a} = parseGithubURL(repoA);
-		const {branch: b} = parseGithubURL(repoB);
-
-		if (gitVerRegex.test(a) && gitVerRegex.test(b)) {
-			return compareVersions(a.substring(1), b.substring(1));
-		}
-		else if (!gitVerRegex.test(a)) {
-			return -1;
-		}
-		else {
-			return 1;
-		}
-	};
-
-	let collectDeps = async (config : Config | VesselConfig, configDir : string, isRoot = false) => {
-		let allDeps = [...Object.values(config.dependencies || {})];
-		if (isRoot) {
-			allDeps = [...allDeps, ...Object.values(config['dev-dependencies'] || {})];
-		}
-		for (const pkgDetails of allDeps) {
-			const {name, repo, version} = pkgDetails;
-
-			// take root dep version or bigger one
-			if (
-				isRoot
-				|| !packages[name]
-				|| !packages[name]?.isRoot
-				&& (
-					repo && packages[name]?.repo && compareGitVersions(packages[name]?.repo || '', repo) === -1
-					|| compareVersions(packages[name]?.version, version) === -1)
-			) {
-				let temp = {
-					...pkgDetails,
-					isRoot,
-				};
-				packages[name] = temp;
-
-				// normalize path relative to the root config dir
-				if (pkgDetails.path) {
-					temp.path = path.relative(rootDir, path.resolve(configDir, pkgDetails.path));
-				}
-			}
-
-			let nestedConfig;
-			let localNestedDir = '';
-
-			// read nested config
-			if (repo) {
-				let cacheDir = getDepCacheName(name, repo);
-				nestedConfig = await readVesselConfig(getDepCacheDir(cacheDir), {silent: true}) || {};
-			}
-			else if (pkgDetails.path) {
-				localNestedDir = path.resolve(configDir, pkgDetails.path).replaceAll('{MOPS_ENV}', process.env.MOPS_ENV || 'local');
-				let mopsToml = path.join(localNestedDir, 'mops.toml');
-				if (existsSync(mopsToml)) {
-					nestedConfig = readConfig(mopsToml);
-				}
-			}
-			else if (version) {
-				let cacheDir = getDepCacheName(name, version);
-				nestedConfig = readConfig(getDepCacheDir(cacheDir) + '/mops.toml');
-			}
-
-			// collect nested deps
-			if (nestedConfig) {
-				await collectDeps(nestedConfig, localNestedDir, false);
-			}
-
-			if (!versions[name]) {
-				versions[name] = [];
-			}
-
-			let parentPkgId = isRoot ? '<root>' : '';
-			if ('package' in config) {
-				parentPkgId = getPackageId(config.package?.name || '', config.package?.version || '');
-			}
-
-			if (repo) {
-				const {branch} = parseGithubURL(repo);
-				versions[name]?.push({
-					version: branch,
-					dependencyOf: parentPkgId,
-					isMopsPackage: false,
-				});
-			}
-			else if (version) {
-				versions[name]?.push({
-					version: version,
-					dependencyOf: parentPkgId,
-					isMopsPackage: true,
-				});
-			}
-		}
-	};
-
-	let config = readConfig();
-	await collectDeps(config, rootDir, true);
-
-	// show conflicts
-	let hasConflicts = false;
-
-	if (conflicts !== 'ignore') {
-		for (let [dep, vers] of Object.entries(versions)) {
-			let majors = new Set(vers.filter(x => x.isMopsPackage).map(x => x.version.split('.')[0]));
-			if (majors.size > 1) {
-				console.error(chalk.reset('') + chalk.redBright(conflicts === 'error' ? 'Error!' : 'Warning!'), `Conflicting versions of dependency "${dep}"`);
-
-				for (let {version, dependencyOf} of vers.reverse()) {
-					console.error(chalk.reset('  ') + `${dep} ${chalk.bold.red(version.split('.')[0])}.${version.split('.').slice(1).join('.')} is dependency of ${chalk.bold(dependencyOf)}`);
-				}
-
-				hasConflicts = true;
-			}
-		}
-	}
-
-	if (conflicts === 'error' && hasConflicts) {
-		process.exit(1);
-	}
-
-	return Object.fromEntries(
-		Object.entries(packages).map(([name, pkg]) => {
-			let version : string;
-			if (pkg.path) {
-				version = path.resolve(rootDir, pkg.path).replaceAll('{MOPS_ENV}', process.env.MOPS_ENV || 'local');
-			}
-			else if (pkg.repo) {
-				version = pkg.repo;
-			}
-			else if (pkg.version) {
-				version = pkg.version;
-			}
-			else {
-				return [name, ''];
-			}
-			return [name, version];
-		}).filter(([, version]) => version !== '')
-	);
-}
+import process from "node:process";
+import path from "node:path";
+import { existsSync } from "node:fs";
+import chalk from "chalk";
+import {
+  checkConfigFile,
+  getRootDir,
+  parseGithubURL,
+  readConfig,
+} from "./mops.js";
+import { VesselConfig, readVesselConfig } from "./vessel.js";
+import { Config, Dependency } from "./types.js";
+import { getDepCacheDir, getDepCacheName } from "./cache.js";
+import { getPackageId } from "./helpers/get-package-id.js";
+import { checkLockFileLight, readLockFile } from "./integrity.js";
+
+export async function resolvePackages({
+  conflicts = "ignore" as "warning" | "error" | "ignore",
+} = {}): Promise<Record<string, string>> {
+  if (!checkConfigFile()) {
+    return {};
+  }
+
+  if (checkLockFileLight()) {
+    let lockFileJson = readLockFile();
+
+    if (lockFileJson && lockFileJson.version === 3) {
+      return lockFileJson.deps;
+    }
+  }
+
+  let rootDir = getRootDir();
+  let packages: Record<string, Dependency & { isRoot: boolean }> = {};
+  let versions: Record<
+    string,
+    Array<{
+      isMopsPackage: boolean;
+      version: string;
+      dependencyOf: string;
+    }>
+  > = {};
+
+  let compareVersions = (a: string = "0.0.0", b: string = "0.0.0") => {
+    let ap = a.split(".").map((x: string) => parseInt(x)) as [
+      number,
+      number,
+      number,
+    ];
+    let bp = b.split(".").map((x: string) => parseInt(x)) as [
+      number,
+      number,
+      number,
+    ];
+    if (ap[0] - bp[0]) {
+      return Math.sign(ap[0] - bp[0]);
+    }
+    if (ap[0] === bp[0] && ap[1] - bp[1]) {
+      return Math.sign(ap[1] - bp[1]);
+    }
+    if (ap[0] === bp[0] && ap[1] === bp[1] && ap[2] - bp[2]) {
+      return Math.sign(ap[2] - bp[2]);
+    }
+    return 0;
+  };
+
+  const gitVerRegex = new RegExp(/v(\d{1,2}\.\d{1,2}\.\d{1,2})(-.*)?$/);
+
+  const compareGitVersions = (repoA: string, repoB: string) => {
+    const { branch: a } = parseGithubURL(repoA);
+    const { branch: b } = parseGithubURL(repoB);
+
+    if (gitVerRegex.test(a) && gitVerRegex.test(b)) {
+      return compareVersions(a.substring(1), b.substring(1));
+    } else if (!gitVerRegex.test(a)) {
+      return -1;
+    } else {
+      return 1;
+    }
+  };
+
+  let collectDeps = async (
+    config: Config | VesselConfig,
+    configDir: string,
+    isRoot = false,
+  ) => {
+    let allDeps = [...Object.values(config.dependencies || {})];
+    if (isRoot) {
+      allDeps = [
+        ...allDeps,
+        ...Object.values(config["dev-dependencies"] || {}),
+      ];
+    }
+    for (const pkgDetails of allDeps) {
+      const { name, repo, version } = pkgDetails;
+
+      // take root dep version or bigger one
+      if (
+        isRoot ||
+        !packages[name] ||
+        (!packages[name]?.isRoot &&
+          ((repo &&
+            packages[name]?.repo &&
+            compareGitVersions(packages[name]?.repo || "", repo) === -1) ||
+            compareVersions(packages[name]?.version, version) === -1))
+      ) {
+        let temp = {
+          ...pkgDetails,
+          isRoot,
+        };
+        packages[name] = temp;
+
+        // normalize path relative to the root config dir
+        if (pkgDetails.path) {
+          temp.path = path.relative(
+            rootDir,
+            path.resolve(configDir, pkgDetails.path),
+          );
+        }
+      }
+
+      let nestedConfig;
+      let localNestedDir = "";
+
+      // read nested config
+      if (repo) {
+        let cacheDir = getDepCacheName(name, repo);
+        nestedConfig =
+          (await readVesselConfig(getDepCacheDir(cacheDir), {
+            silent: true,
+          })) || {};
+      } else if (pkgDetails.path) {
+        localNestedDir = path
+          .resolve(configDir, pkgDetails.path)
+          .replaceAll("{MOPS_ENV}", process.env.MOPS_ENV || "local");
+        let mopsToml = path.join(localNestedDir, "mops.toml");
+        if (existsSync(mopsToml)) {
+          nestedConfig = readConfig(mopsToml);
+        }
+      } else if (version) {
+        let cacheDir = getDepCacheName(name, version);
+        nestedConfig = readConfig(getDepCacheDir(cacheDir) + "/mops.toml");
+      }
+
+      // collect nested deps
+      if (nestedConfig) {
+        await collectDeps(nestedConfig, localNestedDir, false);
+      }
+
+      if (!versions[name]) {
+        versions[name] = [];
+      }
+
+      let parentPkgId = isRoot ? "<root>" : "";
+      if ("package" in config) {
+        parentPkgId = getPackageId(
+          config.package?.name || "",
+          config.package?.version || "",
+        );
+      }
+
+      if (repo) {
+        const { branch } = parseGithubURL(repo);
+        versions[name]?.push({
+          version: branch,
+          dependencyOf: parentPkgId,
+          isMopsPackage: false,
+        });
+      } else if (version) {
+        versions[name]?.push({
+          version: version,
+          dependencyOf: parentPkgId,
+          isMopsPackage: true,
+        });
+      }
+    }
+  };
+
+  let config = readConfig();
+  await collectDeps(config, rootDir, true);
+
+  // show conflicts
+  let hasConflicts = false;
+
+  if (conflicts !== "ignore") {
+    for (let [dep, vers] of Object.entries(versions)) {
+      let majors = new Set(
+        vers.filter((x) => x.isMopsPackage).map((x) => x.version.split(".")[0]),
+      );
+      if (majors.size > 1) {
+        console.error(
+          chalk.reset("") +
+            chalk.redBright(conflicts === "error" ? "Error!" : "Warning!"),
+          `Conflicting versions of dependency "${dep}"`,
+        );
+
+        for (let { version, dependencyOf } of vers.reverse()) {
+          console.error(
+            chalk.reset("  ") +
+              `${dep} ${chalk.bold.red(version.split(".")[0])}.${version.split(".").slice(1).join(".")} is dependency of ${chalk.bold(dependencyOf)}`,
+          );
+        }
+
+        hasConflicts = true;
+      }
+    }
+  }
+
+  if (conflicts === "error" && hasConflicts) {
+    process.exit(1);
+  }
+
+  return Object.fromEntries(
+    Object.entries(packages)
+      .map(([name, pkg]) => {
+        let version: string;
+        if (pkg.path) {
+          version = path
+            .resolve(rootDir, pkg.path)
+            .replaceAll("{MOPS_ENV}", process.env.MOPS_ENV || "local");
+        } else if (pkg.repo) {
+          version = pkg.repo;
+        } else if (pkg.version) {
+          version = pkg.version;
+        } else {
+          return [name, ""];
+        }
+        return [name, version];
+      })
+      .filter(([, version]) => version !== ""),
+  );
+}

package/templates/mops-publish.yml

@@ -9,9 +9,9 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
-      - uses: ZenVoich/setup-mops@v1
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: dfinity/setup-mops@v1
         with:
           # Make sure you set the MOPS_IDENTITY_PEM secret in your repository settings https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository
           identity-pem: ${{ secrets.MOPS_IDENTITY_PEM }}
-      - run: mops publish
+      - run: mops publish

package/templates/mops-test.yml

@@ -12,8 +12,8 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
-      - uses: ZenVoich/setup-mops@v1
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: dfinity/setup-mops@v1
         with:
           mops-version: 1
 
@@ -21,4 +21,4 @@ jobs:
         run: mops install
 
       - name: run tests
-        run: mops test
+        run: mops test

package/templates/src/lib.mo

@@ -1,15 +1,15 @@
 module {
-	// This comment will not be included in the documentation
-	// Use triple slash for documentation
+  // This comment will not be included in the documentation
+  // Use triple slash for documentation
 
-	/// Add two natural numbers
-	///
-	/// Example:
-	/// ```motoko
-	/// assert add(1, 2) == 3;
-	/// assert add(7, 3) == 10;
-	/// ```
-	public func add(x : Nat, y : Nat) : Nat {
-		return x + y;
-	};
-};
+  /// Add two natural numbers
+  ///
+  /// Example:
+  /// ```motoko
+  /// assert add(1, 2) == 3;
+  /// assert add(7, 3) == 10;
+  /// ```
+  public func add(x : Nat, y : Nat) : Nat {
+    return x + y;
+  };
+};

package/templates/test/lib.test.mo

@@ -1,4 +1,4 @@
-import {add} "../src";
+import { add } "../src";
 
 assert add(1, 2) == 3;
-assert add(3, 22) == 25;
+assert add(3, 22) == 25;

package/templates.ts

@@ -1,5 +1,5 @@
-import fs from 'node:fs';
+import fs from "node:fs";
 
-export function copyTemplateFileSync(file : string, dest : string) {
-	fs.copyFileSync(new URL(`./templates/${file}`, import.meta.url), dest);
-}
+export function copyTemplateFileSync(file: string, dest: string) {
+  fs.copyFileSync(new URL(`./templates/${file}`, import.meta.url), dest);
+}