ic-mops 2.8.1 → 2.10.0

package/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## Next
 
+## 2.10.0
+- `mops check` and `mops check-stable` now apply per-canister `[canisters.<name>].args` (previously only `mops build` applied them)
+- `mops check` now accepts canister names as arguments (e.g. `mops check backend`) to check a specific canister
+- `mops check-stable` now works without arguments, checking all canisters with `[check-stable]` configured
+- `mops check-stable` now accepts canister names as arguments (e.g. `mops check-stable backend`)
+
+## 2.9.0
+- Add `mops info <pkg>` command to show detailed package metadata from the registry
+- Add `[lint.extra]` config for applying additional lint rules to specific files via glob patterns
+
 ## 2.8.1
 
 - Fix `mops check-stable` failing when `[moc] args` contains flags with relative paths (e.g. `--actor-idl=system-idl`)

package/cli.ts

@@ -8,7 +8,7 @@ import { getNetwork } from "./api/network.js";
 import { cacheSize, cleanCache, show } from "./cache.js";
 import { add } from "./commands/add.js";
 import { bench } from "./commands/bench.js";
-import { build, DEFAULT_BUILD_OUTPUT_DIR } from "./commands/build.js";
+import { build } from "./commands/build.js";
 import { bump } from "./commands/bump.js";
 import { check } from "./commands/check.js";
 import { checkCandid } from "./commands/check-candid.js";
@@ -16,6 +16,7 @@ import { checkStable } from "./commands/check-stable.js";
 import { docsCoverage } from "./commands/docs-coverage.js";
 import { docs } from "./commands/docs.js";
 import { format } from "./commands/format.js";
+import { info } from "./commands/info.js";
 import { init } from "./commands/init.js";
 import { lint } from "./commands/lint.js";
 import { installAll } from "./commands/install/install-all.js";
@@ -279,6 +280,15 @@ program
     await search(text);
   });
 
+// info
+program
+  .command("info <pkg>")
+  .description("Show detailed information about a package from the registry")
+  .option("--versions", "List all published versions, one per line")
+  .action(async (pkg: string, options) => {
+    await info(pkg, options);
+  });
+
 // cache
 program
   .command("cache")
@@ -320,9 +330,9 @@ program
 
 // check
 program
-  .command("check [files...]")
+  .command("check [args...]")
   .description(
-    "Check Motoko files for syntax errors and type issues. If no files are specified, checks all canister entrypoints from mops.toml. Also runs stable compatibility checks for canisters with [check-stable] configured, and runs linting if lintoko is configured in [toolchain] and rule directories are present",
+    "Check Motoko canisters or files for syntax errors and type issues. Arguments can be canister names or file paths. If no arguments are given, checks all canisters from mops.toml. Also runs stable compatibility checks for canisters with [check-stable] configured, and runs linting if lintoko is configured in [toolchain]",
   )
   .option("--verbose", "Verbose console output")
   .addOption(
@@ -332,15 +342,15 @@ program
     ),
   )
   .allowUnknownOption(true)
-  .action(async (files, options) => {
+  .action(async (args, options) => {
     checkConfigFile(true);
-    const { extraArgs, args: fileList } = parseExtraArgs(files);
+    const { extraArgs, args: argList } = parseExtraArgs(args);
     await installAll({
       silent: true,
       lock: "ignore",
       installFromLockFile: true,
     });
-    await check(fileList, {
+    await check(argList, {
       ...options,
       extraArgs,
     });
@@ -362,21 +372,21 @@ program
 
 // check-stable
 program
-  .command("check-stable <old-file> [canister]")
+  .command("check-stable [args...]")
   .description(
-    "Check stable variable compatibility between an old version (.mo or .most file) and the current canister entrypoint",
+    "Check stable variable compatibility. With no arguments, checks all canisters with [check-stable] configured. Arguments can be canister names or an old file path followed by an optional canister name",
   )
   .option("--verbose", "Verbose console output")
   .allowUnknownOption(true)
-  .action(async (oldFile, canister, options) => {
+  .action(async (args, options) => {
     checkConfigFile(true);
-    const { extraArgs } = parseExtraArgs();
+    const { extraArgs, args: argList } = parseExtraArgs(args);
     await installAll({
       silent: true,
       lock: "ignore",
       installFromLockFile: true,
     });
-    await checkStable(oldFile, canister, {
+    await checkStable(argList, {
       ...options,
       extraArgs,
     });

package/commands/build.ts

@@ -3,9 +3,14 @@ import { execa } from "execa";
 import { exists } from "fs-extra";
 import { mkdir, readFile, writeFile } from "node:fs/promises";
 import { join } from "node:path";
+import { lock, unlockSync } from "proper-lockfile";
 import { cliError } from "../error.js";
 import { isCandidCompatible } from "../helpers/is-candid-compatible.js";
-import { resolveCanisterConfigs } from "../helpers/resolve-canisters.js";
+import {
+  filterCanisters,
+  resolveCanisterConfigs,
+  validateCanisterArgs,
+} from "../helpers/resolve-canisters.js";
 import { CanisterConfig, Config } from "../types.js";
 import { CustomSection, getWasmBindings } from "../wasm.js";
 import { getGlobalMocArgs, readConfig, resolveConfigPath } from "../mops.js";
@@ -40,26 +45,11 @@ export async function build(
     cliError(`No Motoko canisters found in mops.toml configuration`);
   }
 
-  if (canisterNames) {
-    let invalidNames = canisterNames.filter((name) => !(name in canisters));
-    if (invalidNames.length) {
-      cliError(
-        `Motoko canister(s) not found in mops.toml configuration: ${invalidNames.join(", ")}`,
-      );
-    }
-  }
-
   if (!(await exists(outputDir))) {
     await mkdir(outputDir, { recursive: true });
   }
 
-  const filteredCanisters = canisterNames
-    ? Object.fromEntries(
-        Object.entries(canisters).filter(([name]) =>
-          canisterNames.includes(name),
-        ),
-      )
-    : canisters;
+  const filteredCanisters = filterCanisters(canisters, canisterNames);
 
   for (let [canisterName, canister] of Object.entries(filteredCanisters)) {
     console.log(chalk.blue("build canister"), chalk.bold(canisterName));
@@ -70,115 +60,149 @@ export async function build(
     motokoPath = resolveConfigPath(motokoPath);
     const wasmPath = join(outputDir, `${canisterName}.wasm`);
     const mostPath = join(outputDir, `${canisterName}.most`);
-    let args = [
-      "-c",
-      "--idl",
-      "--stable-types",
-      "-o",
-      wasmPath,
-      motokoPath,
-      ...(await sourcesArgs()).flat(),
-      ...getGlobalMocArgs(config),
-    ];
-    args.push(
-      ...collectExtraArgs(config, canister, canisterName, options.extraArgs),
-    );
-
-    const isPublicCandid = true; // always true for now to reduce corner cases
-    const candidVisibility = isPublicCandid ? "icp:public" : "icp:private";
-    if (isPublicCandid) {
-      args.push("--public-metadata", "candid:service");
-      args.push("--public-metadata", "candid:args");
+
+    // per-canister lock to prevent parallel builds of the same canister from clobbering output files
+    const lockTarget = join(outputDir, `.${canisterName}.buildlock`);
+    await writeFile(lockTarget, "", { flag: "a" });
+
+    let release: (() => Promise<void>) | undefined;
+    try {
+      release = await lock(lockTarget, {
+        stale: 300_000,
+        retries: { retries: 60, minTimeout: 500, maxTimeout: 5_000 },
+      });
+    } catch {
+      cliError(
+        `Failed to acquire build lock for canister ${canisterName} — another build may be stuck`,
+      );
     }
+
+    // proper-lockfile registers its own signal-exit handler, but it doesn't reliably
+    // fire on process.exit(). This manual handler covers that gap. Double-unlock is
+    // harmless (the second call throws and is caught).
+    const exitCleanup = () => {
+      try {
+        unlockSync(lockTarget);
+      } catch {}
+    };
+    process.on("exit", exitCleanup);
+
     try {
-      if (options.verbose) {
-        console.log(chalk.gray(mocPath, JSON.stringify(args)));
+      let args = [
+        "-c",
+        "--idl",
+        "--stable-types",
+        "-o",
+        wasmPath,
+        motokoPath,
+        ...(await sourcesArgs()).flat(),
+        ...getGlobalMocArgs(config),
+      ];
+      args.push(
+        ...collectExtraArgs(config, canister, canisterName, options.extraArgs),
+      );
+
+      const isPublicCandid = true; // always true for now to reduce corner cases
+      const candidVisibility = isPublicCandid ? "icp:public" : "icp:private";
+      if (isPublicCandid) {
+        args.push("--public-metadata", "candid:service");
+        args.push("--public-metadata", "candid:args");
       }
-      const result = await execa(mocPath, args, {
-        stdio: options.verbose ? "inherit" : "pipe",
-        reject: false,
-      });
+      try {
+        if (options.verbose) {
+          console.log(chalk.gray(mocPath, JSON.stringify(args)));
+        }
+        const result = await execa(mocPath, args, {
+          stdio: options.verbose ? "inherit" : "pipe",
+          reject: false,
+        });
 
-      if (result.exitCode !== 0) {
-        if (!options.verbose) {
-          if (result.stderr) {
-            console.error(chalk.red(result.stderr));
-          }
-          if (result.stdout?.trim()) {
-            console.error(chalk.yellow("Build output:"));
-            console.error(result.stdout);
+        if (result.exitCode !== 0) {
+          if (!options.verbose) {
+            if (result.stderr) {
+              console.error(chalk.red(result.stderr));
+            }
+            if (result.stdout?.trim()) {
+              console.error(chalk.yellow("Build output:"));
+              console.error(result.stdout);
+            }
           }
+          cliError(
+            `Build failed for canister ${canisterName} (exit code: ${result.exitCode})`,
+          );
         }
-        cliError(
-          `Build failed for canister ${canisterName} (exit code: ${result.exitCode})`,
-        );
-      }
 
-      if (options.verbose && result.stdout && result.stdout.trim()) {
-        console.log(result.stdout);
-      }
-
-      options.verbose &&
-        console.log(chalk.gray(`Stable types written to ${mostPath}`));
+        if (options.verbose && result.stdout && result.stdout.trim()) {
+          console.log(result.stdout);
+        }
 
-      const generatedDidPath = join(outputDir, `${canisterName}.did`);
-      const resolvedCandidPath = canister.candid
-        ? resolveConfigPath(canister.candid)
-        : null;
+        options.verbose &&
+          console.log(chalk.gray(`Stable types written to ${mostPath}`));
 
-      if (resolvedCandidPath) {
-        try {
-          const compatible = await isCandidCompatible(
-            generatedDidPath,
-            resolvedCandidPath,
-          );
+        const generatedDidPath = join(outputDir, `${canisterName}.did`);
+        const resolvedCandidPath = canister.candid
+          ? resolveConfigPath(canister.candid)
+          : null;
 
-          if (!compatible) {
-            cliError(
-              `Candid compatibility check failed for canister ${canisterName}`,
+        if (resolvedCandidPath) {
+          try {
+            const compatible = await isCandidCompatible(
+              generatedDidPath,
+              resolvedCandidPath,
             );
-          }
 
-          if (options.verbose) {
-            console.log(
-              chalk.gray(
-                `Candid compatibility check passed for canister ${canisterName}`,
-              ),
+            if (!compatible) {
+              cliError(
+                `Candid compatibility check failed for canister ${canisterName}`,
+              );
+            }
+
+            if (options.verbose) {
+              console.log(
+                chalk.gray(
+                  `Candid compatibility check passed for canister ${canisterName}`,
+                ),
+              );
+            }
+          } catch (err: any) {
+            cliError(
+              `Error during Candid compatibility check for canister ${canisterName}${err?.message ? `\n${err.message}` : ""}`,
             );
           }
-        } catch (err: any) {
-          cliError(
-            `Error during Candid compatibility check for canister ${canisterName}${err?.message ? `\n${err.message}` : ""}`,
-          );
         }
-      }
 
-      options.verbose &&
-        console.log(chalk.gray(`Adding metadata to ${wasmPath}`));
-      const candidPath = resolvedCandidPath ?? generatedDidPath;
-      const candidText = await readFile(candidPath, "utf-8");
-      const customSections: CustomSection[] = [
-        { name: `${candidVisibility} candid:service`, data: candidText },
-      ];
-      if (canister.initArg) {
-        customSections.push({
-          name: `${candidVisibility} candid:args`,
-          data: canister.initArg,
-        });
-      }
-      const wasmBytes = await readFile(wasmPath);
-      const newWasm = getWasmBindings().add_custom_sections(
-        wasmBytes,
-        customSections,
-      );
-      await writeFile(wasmPath, newWasm);
-    } catch (err: any) {
-      if (err.message?.includes("Build failed for canister")) {
-        throw err;
+        options.verbose &&
+          console.log(chalk.gray(`Adding metadata to ${wasmPath}`));
+        const candidPath = resolvedCandidPath ?? generatedDidPath;
+        const candidText = await readFile(candidPath, "utf-8");
+        const customSections: CustomSection[] = [
+          { name: `${candidVisibility} candid:service`, data: candidText },
+        ];
+        if (canister.initArg) {
+          customSections.push({
+            name: `${candidVisibility} candid:args`,
+            data: canister.initArg,
+          });
+        }
+        const wasmBytes = await readFile(wasmPath);
+        const newWasm = getWasmBindings().add_custom_sections(
+          wasmBytes,
+          customSections,
+        );
+        await writeFile(wasmPath, newWasm);
+      } catch (err: any) {
+        if (err.message?.includes("Build failed for canister")) {
+          throw err;
+        }
+        cliError(
+          `Error while compiling canister ${canisterName}${err?.message ? `\n${err.message}` : ""}`,
+        );
       }
-      cliError(
-        `Error while compiling canister ${canisterName}${err?.message ? `\n${err.message}` : ""}`,
-      );
+    } finally {
+      process.removeListener("exit", exitCleanup);
+      try {
+        await release?.();
+      } catch {}
     }
   }
 
@@ -214,11 +238,7 @@ function collectExtraArgs(
     args.push(...config.build.args);
   }
   if (canister.args) {
-    if (typeof canister.args === "string") {
-      cliError(
-        `Canister config 'args' should be an array of strings for canister ${canisterName}`,
-      );
-    }
+    validateCanisterArgs(canister, canisterName);
     args.push(...canister.args);
   }
   if (extraArgs) {

package/commands/check-stable.ts

@@ -5,7 +5,14 @@ import chalk from "chalk";
 import { execa } from "execa";
 import { cliError } from "../error.js";
 import { getGlobalMocArgs, readConfig, resolveConfigPath } from "../mops.js";
-import { resolveSingleCanister } from "../helpers/resolve-canisters.js";
+import { CanisterConfig } from "../types.js";
+import {
+  filterCanisters,
+  looksLikeFile,
+  resolveCanisterConfigs,
+  resolveSingleCanister,
+  validateCanisterArgs,
+} from "../helpers/resolve-canisters.js";
 import { sourcesArgs } from "./sources.js";
 import { toolchain } from "./toolchain/index.js";
 
@@ -16,29 +23,108 @@ export interface CheckStableOptions {
   extraArgs: string[];
 }
 
+export function resolveStablePath(
+  canister: CanisterConfig,
+  canisterName: string,
+  options?: { required?: boolean },
+): string | null {
+  const stableConfig = canister["check-stable"];
+  if (!stableConfig) {
+    if (options?.required) {
+      cliError(
+        `Canister '${canisterName}' has no [canisters.${canisterName}.check-stable] configuration in mops.toml`,
+      );
+    }
+    return null;
+  }
+  const stablePath = resolveConfigPath(stableConfig.path);
+  if (!existsSync(stablePath)) {
+    if (stableConfig.skipIfMissing) {
+      return null;
+    }
+    cliError(
+      `Deployed file not found: ${stablePath} (canister '${canisterName}')\n` +
+        "Set skipIfMissing = true in [canisters." +
+        canisterName +
+        ".check-stable] to skip this check when the file is missing.",
+    );
+  }
+  return stablePath;
+}
+
 export async function checkStable(
-  oldFile: string,
-  canisterName: string | undefined,
+  args: string[],
   options: Partial<CheckStableOptions> = {},
 ): Promise<void> {
   const config = readConfig();
-  const { name, canister } = resolveSingleCanister(config, canisterName);
+  const mocPath = await toolchain.bin("moc", { fallback: true });
+  const globalMocArgs = getGlobalMocArgs(config);
+
+  const firstArg = args[0];
+  if (firstArg && looksLikeFile(firstArg)) {
+    const oldFile = firstArg;
+    const canisterName = args[1];
+    const { name, canister } = resolveSingleCanister(config, canisterName);
+
+    if (!canister.main) {
+      cliError(`No main file specified for canister '${name}' in mops.toml`);
+    }
+
+    validateCanisterArgs(canister, name);
 
-  if (!canister.main) {
-    cliError(`No main file specified for canister '${name}' in mops.toml`);
+    await runStableCheck({
+      oldFile,
+      canisterMain: resolveConfigPath(canister.main),
+      canisterName: name,
+      mocPath,
+      globalMocArgs,
+      canisterArgs: canister.args ?? [],
+      options,
+    });
+    return;
   }
 
-  const mocPath = await toolchain.bin("moc", { fallback: true });
-  const globalMocArgs = getGlobalMocArgs(config);
+  const canisters = resolveCanisterConfigs(config);
+  const canisterNames = args.length > 0 ? args : undefined;
+  const filteredCanisters = filterCanisters(canisters, canisterNames);
+  const sources = (await sourcesArgs()).flat();
 
-  await runStableCheck({
-    oldFile,
-    canisterMain: resolveConfigPath(canister.main),
-    canisterName: name,
-    mocPath,
-    globalMocArgs,
-    options,
-  });
+  let checked = 0;
+  for (const [name, canister] of Object.entries(filteredCanisters)) {
+    if (!canister.main) {
+      cliError(`No main file specified for canister '${name}' in mops.toml`);
+    }
+
+    validateCanisterArgs(canister, name);
+    const stablePath = resolveStablePath(canister, name, {
+      required: !!canisterNames,
+    });
+    if (!stablePath) {
+      continue;
+    }
+
+    await runStableCheck({
+      oldFile: stablePath,
+      canisterMain: resolveConfigPath(canister.main),
+      canisterName: name,
+      mocPath,
+      globalMocArgs,
+      canisterArgs: canister.args ?? [],
+      sources,
+      options,
+    });
+    checked++;
+  }
+
+  if (checked === 0 && !canisterNames) {
+    cliError(
+      "No canisters with [check-stable] configuration found in mops.toml.\n" +
+        "Either pass an old file: mops check-stable <old-file> [canister]\n" +
+        "Or configure check-stable for a canister:\n\n" +
+        "  [canisters.backend.check-stable]\n" +
+        '  path = "deployed.mo"',
+    );
+  }
 }
 
 export interface RunStableCheckParams {
@@ -47,6 +133,8 @@ export interface RunStableCheckParams {
   canisterName: string;
   mocPath: string;
   globalMocArgs: string[];
+  canisterArgs: string[];
+  sources?: string[];
   options?: Partial<CheckStableOptions>;
 }
 
@@ -59,10 +147,11 @@ export async function runStableCheck(
     canisterName,
     mocPath,
     globalMocArgs,
+    canisterArgs,
     options = {},
   } = params;
 
-  const sources = (await sourcesArgs()).flat();
+  const sources = params.sources ?? (await sourcesArgs()).flat();
   const isOldMostFile = oldFile.endsWith(".most");
 
   if (!existsSync(oldFile)) {
@@ -80,6 +169,7 @@ export async function runStableCheck(
           join(CHECK_STABLE_DIR, "old.most"),
           sources,
           globalMocArgs,
+          canisterArgs,
           options,
         );
 
@@ -89,6 +179,7 @@ export async function runStableCheck(
       join(CHECK_STABLE_DIR, "new.most"),
       sources,
       globalMocArgs,
+      canisterArgs,
       options,
     );
 
@@ -134,6 +225,7 @@ async function generateStableTypes(
   outputPath: string,
   sources: string[],
   globalMocArgs: string[],
+  canisterArgs: string[],
   options: Partial<CheckStableOptions>,
 ): Promise<string> {
   const base = basename(outputPath, ".most");
@@ -145,6 +237,7 @@ async function generateStableTypes(
     moFile,
     ...sources,
     ...globalMocArgs,
+    ...canisterArgs,
     ...(options.extraArgs ?? []),
   ];