ic-mops 2.9.0 → 2.10.0

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## 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

package/cli.ts

@@ -330,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(
@@ -342,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,
     });
@@ -372,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

@@ -6,7 +6,11 @@ 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";
@@ -41,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));
@@ -249,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 ?? []),
   ];
 

package/commands/check.ts

@@ -1,5 +1,4 @@
 import path from "node:path";
-import { existsSync } from "node:fs";
 import chalk from "chalk";
 import { execa } from "execa";
 import { cliError } from "../error.js";
@@ -9,13 +8,16 @@ import {
   readConfig,
   resolveConfigPath,
 } from "../mops.js";
-import { autofixMotoko } from "../helpers/autofix-motoko.js";
+import { AutofixResult, autofixMotoko } from "../helpers/autofix-motoko.js";
 import { getMocSemVer } from "../helpers/get-moc-version.js";
 import {
+  filterCanisters,
+  looksLikeFile,
   resolveCanisterConfigs,
-  resolveCanisterEntrypoints,
+  validateCanisterArgs,
 } from "../helpers/resolve-canisters.js";
-import { runStableCheck } from "./check-stable.js";
+import { CanisterConfig, Config } from "../types.js";
+import { resolveStablePath, runStableCheck } from "./check-stable.js";
 import { sourcesArgs } from "./sources.js";
 import { toolchain } from "./toolchain/index.js";
 import { collectLintRules, lint } from "./lint.js";
@@ -33,52 +35,197 @@ export interface CheckOptions {
   extraArgs: string[];
 }
 
+function checkAllLibsSupport(verbose?: boolean): boolean {
+  const allLibs = supportsAllLibsFlag();
+  if (!allLibs) {
+    console.log(
+      chalk.yellow(
+        `moc < ${MOC_ALL_LIBS_MIN_VERSION}: some diagnostic hints may be missing`,
+      ),
+    );
+  } else if (verbose) {
+    console.log(
+      chalk.blue("check"),
+      chalk.gray("Using --all-libs for richer diagnostics"),
+    );
+  }
+  return allLibs;
+}
+
+function logAutofixResult(
+  fixResult: AutofixResult | null,
+  verbose?: boolean,
+): void {
+  if (fixResult) {
+    for (const [file, codes] of fixResult.fixedFiles) {
+      const unique = [...new Set(codes)].sort();
+      const n = codes.length;
+      const rel = path.relative(process.cwd(), file);
+      console.log(
+        chalk.green(
+          `Fixed ${rel} (${n} ${n === 1 ? "fix" : "fixes"}: ${unique.join(", ")})`,
+        ),
+      );
+    }
+    const fileCount = fixResult.fixedFiles.size;
+    console.log(
+      chalk.green(
+        `\n✓ ${fixResult.totalFixCount} ${fixResult.totalFixCount === 1 ? "fix" : "fixes"} applied to ${fileCount} ${fileCount === 1 ? "file" : "files"}`,
+      ),
+    );
+  } else if (verbose) {
+    console.log(chalk.yellow("No fixes were needed"));
+  }
+}
+
 export async function check(
-  files: string | string[],
+  args: string[],
   options: Partial<CheckOptions> = {},
 ): Promise<void> {
-  const explicitFiles = Array.isArray(files) ? files : files ? [files] : [];
-  let fileList = [...explicitFiles];
-
   const config = readConfig();
+  const canisters = resolveCanisterConfigs(config);
+  const hasCanisters = Object.keys(canisters).length > 0;
+  const fileArgs = args.filter(looksLikeFile);
+  const nonFileArgs = args.filter((a) => !looksLikeFile(a));
+  const isFileMode = fileArgs.length > 0;
 
-  if (fileList.length === 0) {
-    fileList = resolveCanisterEntrypoints(config).map(resolveConfigPath);
-  }
-
-  if (fileList.length === 0) {
+  if (isFileMode && nonFileArgs.length > 0) {
     cliError(
-      "No Motoko files specified and no canisters defined in mops.toml.\n" +
-        "Either pass files: mops check <files...>\n" +
-        "Or define canisters in mops.toml:\n\n" +
-        "  [canisters.backend]\n" +
-        '  main = "src/main.mo"',
+      `Cannot mix file paths and canister names: ${args.join(", ")}\n` +
+        "Pass either file paths (e.g. mops check src/main.mo) or canister names (e.g. mops check backend)",
     );
   }
+
+  if (isFileMode) {
+    await checkFiles(config, fileArgs, options);
+  } else {
+    if (!hasCanisters) {
+      cliError(
+        "No canisters defined in mops.toml.\n" +
+          "Either pass files: mops check <files...>\n" +
+          "Or define canisters in mops.toml:\n\n" +
+          "  [canisters.backend]\n" +
+          '  main = "src/main.mo"',
+      );
+    }
+
+    const canisterNames = args.length > 0 ? args : undefined;
+    const filtered = filterCanisters(canisters, canisterNames);
+    await checkCanisters(config, filtered, options);
+  }
+
+  if (config.toolchain?.lintoko) {
+    const rootDir = getRootDir();
+    const lintRules = await collectLintRules(config, rootDir);
+    const lintFiles = isFileMode ? fileArgs : undefined;
+    await lint(undefined, {
+      verbose: options.verbose,
+      fix: options.fix,
+      rules: lintRules,
+      files: lintFiles,
+    });
+  }
+}
+
+async function checkCanisters(
+  config: Config,
+  canisters: Record<string, CanisterConfig>,
+  options: Partial<CheckOptions>,
+): Promise<void> {
   const mocPath = await toolchain.bin("moc", { fallback: true });
-  const sources = await sourcesArgs();
+  const sources = (await sourcesArgs()).flat();
   const globalMocArgs = getGlobalMocArgs(config);
+  const allLibs = checkAllLibsSupport(options.verbose);
 
-  // --all-libs enables richer diagnostics with edit suggestions from moc (requires moc >= 1.3.0)
-  const allLibs = supportsAllLibsFlag();
+  for (const [canisterName, canister] of Object.entries(canisters)) {
+    if (!canister.main) {
+      cliError(
+        `No main file specified for canister '${canisterName}' in mops.toml`,
+      );
+    }
 
-  if (!allLibs) {
-    console.log(
-      chalk.yellow(
-        `moc < ${MOC_ALL_LIBS_MIN_VERSION}: some diagnostic hints may be missing`,
-      ),
-    );
-  } else if (options.verbose) {
-    console.log(
-      chalk.blue("check"),
-      chalk.gray("Using --all-libs for richer diagnostics"),
-    );
+    validateCanisterArgs(canister, canisterName);
+    const motokoPath = resolveConfigPath(canister.main);
+
+    const mocArgs = [
+      "--check",
+      ...(allLibs ? ["--all-libs"] : []),
+      ...sources,
+      ...globalMocArgs,
+      ...(canister.args ?? []),
+      ...(options.extraArgs ?? []),
+    ];
+
+    if (options.fix) {
+      if (options.verbose) {
+        console.log(
+          chalk.blue("check"),
+          chalk.gray(`Attempting to fix ${canisterName}`),
+        );
+      }
+
+      const fixResult = await autofixMotoko(mocPath, [motokoPath], mocArgs);
+      logAutofixResult(fixResult, options.verbose);
+    }
+
+    try {
+      const args = [motokoPath, ...mocArgs];
+      if (options.verbose) {
+        console.log(
+          chalk.blue("check"),
+          chalk.gray(`Checking canister ${canisterName}:`),
+        );
+        console.log(chalk.gray(mocPath, JSON.stringify(args)));
+      }
+
+      const result = await execa(mocPath, args, {
+        stdio: "inherit",
+        reject: false,
+      });
+
+      if (result.exitCode !== 0) {
+        cliError(
+          `✗ Check failed for canister ${canisterName} (exit code: ${result.exitCode})`,
+        );
+      }
+
+      console.log(chalk.green(`✓ ${canisterName}`));
+    } catch (err: any) {
+      cliError(
+        `Error while checking canister ${canisterName}${err?.message ? `\n${err.message}` : ""}`,
+      );
+    }
+
+    const stablePath = resolveStablePath(canister, canisterName);
+    if (stablePath) {
+      await runStableCheck({
+        oldFile: stablePath,
+        canisterMain: motokoPath,
+        canisterName,
+        mocPath,
+        globalMocArgs,
+        canisterArgs: canister.args ?? [],
+        sources,
+        options: { verbose: options.verbose, extraArgs: options.extraArgs },
+      });
+    }
   }
+}
+
+async function checkFiles(
+  config: Config,
+  files: string[],
+  options: Partial<CheckOptions>,
+): Promise<void> {
+  const mocPath = await toolchain.bin("moc", { fallback: true });
+  const sources = (await sourcesArgs()).flat();
+  const globalMocArgs = getGlobalMocArgs(config);
+  const allLibs = checkAllLibsSupport(options.verbose);
 
   const mocArgs = [
     "--check",
     ...(allLibs ? ["--all-libs"] : []),
-    ...sources.flat(),
+    ...sources,
     ...globalMocArgs,
     ...(options.extraArgs ?? []),
   ];
@@ -88,32 +235,11 @@ export async function check(
       console.log(chalk.blue("check"), chalk.gray("Attempting to fix files"));
     }
 
-    const fixResult = await autofixMotoko(mocPath, fileList, mocArgs);
-    if (fixResult) {
-      for (const [file, codes] of fixResult.fixedFiles) {
-        const unique = [...new Set(codes)].sort();
-        const n = codes.length;
-        const rel = path.relative(process.cwd(), file);
-        console.log(
-          chalk.green(
-            `Fixed ${rel} (${n} ${n === 1 ? "fix" : "fixes"}: ${unique.join(", ")})`,
-          ),
-        );
-      }
-      const fileCount = fixResult.fixedFiles.size;
-      console.log(
-        chalk.green(
-          `\n✓ ${fixResult.totalFixCount} ${fixResult.totalFixCount === 1 ? "fix" : "fixes"} applied to ${fileCount} ${fileCount === 1 ? "file" : "files"}`,
-        ),
-      );
-    } else {
-      if (options.verbose) {
-        console.log(chalk.yellow("No fixes were needed"));
-      }
-    }
+    const fixResult = await autofixMotoko(mocPath, files, mocArgs);
+    logAutofixResult(fixResult, options.verbose);
   }
 
-  for (const file of fileList) {
+  for (const file of files) {
     try {
       const args = [file, ...mocArgs];
       if (options.verbose) {
@@ -139,49 +265,4 @@ export async function check(
       );
     }
   }
-
-  const canisters = resolveCanisterConfigs(config);
-  for (const [name, canister] of Object.entries(canisters)) {
-    const stableConfig = canister["check-stable"];
-    if (!stableConfig) {
-      continue;
-    }
-
-    if (!canister.main) {
-      cliError(`No main file specified for canister '${name}' in mops.toml`);
-    }
-
-    const stablePath = resolveConfigPath(stableConfig.path);
-    if (!existsSync(stablePath)) {
-      if (stableConfig.skipIfMissing) {
-        continue;
-      }
-      cliError(
-        `Deployed file not found: ${stablePath} (canister '${name}')\n` +
-          "Set skipIfMissing = true in [canisters." +
-          name +
-          ".check-stable] to skip this check when the file is missing.",
-      );
-    }
-
-    await runStableCheck({
-      oldFile: stablePath,
-      canisterMain: resolveConfigPath(canister.main),
-      canisterName: name,
-      mocPath,
-      globalMocArgs,
-      options: { verbose: options.verbose, extraArgs: options.extraArgs },
-    });
-  }
-
-  if (config.toolchain?.lintoko) {
-    const rootDir = getRootDir();
-    const lintRules = await collectLintRules(config, rootDir);
-    await lint(undefined, {
-      verbose: options.verbose,
-      fix: options.fix,
-      rules: lintRules,
-      files: explicitFiles.length > 0 ? explicitFiles : undefined,
-    });
-  }
 }