ic-mops 1.12.0 → 2.0.0

package/commands/docs.ts

@@ -1,124 +1,134 @@
-import process from 'node:process';
-import {spawn} from 'node:child_process';
-import fs from 'node:fs';
-import path from 'node:path';
-import chalk from 'chalk';
-import {globSync} from 'glob';
-import {deleteSync} from 'del';
-import {create as createTar} from 'tar';
-import streamToPromise from 'stream-to-promise';
+import process from "node:process";
+import { spawn } from "node:child_process";
+import fs from "node:fs";
+import path from "node:path";
+import chalk from "chalk";
+import { globSync } from "glob";
+import { deleteSync } from "del";
+import { create as createTar } from "tar";
+import streamToPromise from "stream-to-promise";
 
-import {getRootDir} from '../mops.js';
-import {toolchain} from './toolchain/index.js';
+import { getRootDir } from "../mops.js";
+import { toolchain } from "./toolchain/index.js";
 
-let moDocPath : string;
+let moDocPath: string;
 
 type DocsOptions = {
-	source : string,
-	output : string,
-	format : 'md' | 'adoc' | 'html',
-	silent : boolean,
-	archive : boolean,
+  source: string;
+  output: string;
+  format: "md" | "adoc" | "html";
+  silent: boolean;
+  archive: boolean;
 };
 
-export async function docs(options : Partial<DocsOptions> = {}) {
-	let {source, output, format, silent, archive} = {
-		source: 'src',
-		output: '.mops/.docs',
-		format: 'adoc',
-		silent: false,
-		archive: false,
-		...options,
-	};
+export async function docs(options: Partial<DocsOptions> = {}) {
+  let { source, output, format, silent, archive } = {
+    source: "src",
+    output: ".mops/.docs",
+    format: "adoc",
+    silent: false,
+    archive: false,
+    ...options,
+  };
 
-	if (format === 'md') {
-		format = 'plain';
-	}
+  if (format === "md") {
+    format = "plain";
+  }
 
-	let rootDir = getRootDir();
-	let docsDir = path.join(rootDir, output);
-	let docsDirRelative = path.relative(process.cwd(), docsDir);
+  let rootDir = getRootDir();
+  let docsDir = path.join(rootDir, output);
+  let docsDirRelative = path.relative(process.cwd(), docsDir);
 
-	deleteSync([docsDir], {force: true});
+  deleteSync([docsDir], { force: true });
 
-	// detect mocv (legacy)
-	if (process.env.DFX_MOC_PATH && process.env.DFX_MOC_PATH.includes('mocv/versions')) {
-		moDocPath = process.env.DFX_MOC_PATH.replace(/\/moc$/, '/mo-doc');
-	}
-	else {
-		// fallbacks to dfx moc if not specified in config
-		let mocPath = await toolchain.bin('moc', {fallback: true});
-		moDocPath = mocPath.replace(/\/moc$/, '/mo-doc');
-	}
+  // detect mocv (legacy)
+  if (
+    process.env.DFX_MOC_PATH &&
+    process.env.DFX_MOC_PATH.includes("mocv/versions")
+  ) {
+    moDocPath = process.env.DFX_MOC_PATH.replace(/\/moc$/, "/mo-doc");
+  } else {
+    // fallbacks to dfx moc if not specified in config
+    let mocPath = await toolchain.bin("moc", { fallback: true });
+    moDocPath = mocPath.replace(/\/moc$/, "/mo-doc");
+  }
 
-	// generate docs
-	await new Promise<void>((resolve) => {
-		let proc = spawn(moDocPath, [
-			`--source=${path.join(rootDir, source)}`,
-			`--output=${docsDirRelative}`,
-			`--format=${format}`,
-		]);
+  // generate docs
+  await new Promise<void>((resolve) => {
+    let proc = spawn(moDocPath, [
+      `--source=${path.join(rootDir, source)}`,
+      `--output=${docsDirRelative}`,
+      `--format=${format}`,
+    ]);
 
-		// stdout
-		proc.stdout.on('data', (data) => {
-			let text = data.toString().trim();
-			let failedText = 'Failed to extract documentation';
-			if (text.includes(failedText)) {
-				silent ||console.log(text.replaceAll(failedText, chalk.yellow('Warning: ') + failedText));
-			}
-			silent || console.log('stdout', text);
-		});
+    // stdout
+    proc.stdout.on("data", (data) => {
+      let text = data.toString().trim();
+      let failedText = "Failed to extract documentation";
+      if (text.includes(failedText)) {
+        silent ||
+          console.log(
+            text.replaceAll(failedText, chalk.yellow("Warning: ") + failedText),
+          );
+      }
+      silent || console.log("stdout", text);
+    });
 
-		// stderr
-		let stderr = '';
-		proc.stderr.on('data', (data) => {
-			let text = data.toString().trim();
-			if (text.includes('syntax error')) {
-				console.log(chalk.red('Error:'), text);
-				process.exit(1);
-			}
-			if (text.includes('No such file or directory') || text.includes('Couldn\'t find a module expression')) {
-				silent || console.log(text);
-				return;
-			}
-			stderr += text;
-		});
+    // stderr
+    let stderr = "";
+    proc.stderr.on("data", (data) => {
+      let text = data.toString().trim();
+      if (text.includes("syntax error")) {
+        console.log(chalk.red("Error:"), text);
+        process.exit(1);
+      }
+      if (
+        text.includes("No such file or directory") ||
+        text.includes("Couldn't find a module expression")
+      ) {
+        silent || console.log(text);
+        return;
+      }
+      stderr += text;
+    });
 
-		// exit
-		proc.on('exit', (code) => {
-			// if no source files found
-			if (code === 2 && !stderr) {
-				resolve();
-				return;
-			}
-			if (code !== 0) {
-				console.log(chalk.red('Error:'), code, stderr);
-				process.exit(1);
-			}
-			resolve();
-		});
-	});
+    // exit
+    proc.on("exit", (code) => {
+      // if no source files found
+      if (code === 2 && !stderr) {
+        resolve();
+        return;
+      }
+      if (code !== 0) {
+        console.log(chalk.red("Error:"), code, stderr);
+        process.exit(1);
+      }
+      resolve();
+    });
+  });
 
-	// create archive
-	if (archive) {
-		let ignore = [
-			`${docsDir}/**/*.test.adoc`,
-			`${docsDir}/test/**/*`,
-		];
-		let files = globSync(`${docsDir}/**/*.adoc`, {ignore}).map(f => path.relative(docsDir, f));
-		files.sort();
-		if (files.length) {
-			let stream = createTar(
-				{
-					cwd: docsDir,
-					gzip: true,
-					portable: true,
-				},
-				files
-			).pipe(fs.createWriteStream(path.join(docsDir, 'docs.tgz')));
-			await streamToPromise(stream);
-		}
-	}
+  // create archive
+  if (archive) {
+    let ignore = [`${docsDir}/**/*.test.adoc`, `${docsDir}/test/**/*`];
+    let files = globSync(`${docsDir}/**/*.adoc`, { ignore }).map((f) =>
+      path.relative(docsDir, f),
+    );
+    files.sort();
+    if (files.length) {
+      let stream = createTar(
+        {
+          cwd: docsDir,
+          gzip: true,
+          portable: true,
+        },
+        files,
+      ).pipe(fs.createWriteStream(path.join(docsDir, "docs.tgz")));
+      await streamToPromise(stream);
+    }
+  }
 
-	silent || console.log(`${chalk.green('Documentation generated')} at ${docsDirRelative}`);
-}
+  silent ||
+    console.log(
+      `${chalk.green("Documentation generated")} at ${docsDirRelative}`,
+    );
+}

package/commands/format.ts

@@ -1,169 +1,185 @@
-import fs from 'node:fs/promises';
-import path from 'node:path';
-import {globSync} from 'glob';
-import chalk from 'chalk';
-import * as prettier from 'prettier';
-import motokoPlugin from 'prettier-plugin-motoko';
+import fs from "node:fs/promises";
+import path from "node:path";
+import { globSync } from "glob";
+import chalk from "chalk";
+import * as prettier from "prettier";
+import motokoPlugin from "prettier-plugin-motoko";
 
-import {getRootDir} from '../mops.js';
-import {absToRel} from './test/utils.js';
-import {parallel} from '../parallel.js';
+import { getRootDir } from "../mops.js";
+import { absToRel } from "./test/utils.js";
+import { parallel } from "../parallel.js";
 
 let ignore = [
-	'**/node_modules/**',
-	'**/.mops/**',
-	'**/.vessel/**',
-	'**/.git/**',
-	'**/dist/**',
+  "**/node_modules/**",
+  "**/.mops/**",
+  "**/.vessel/**",
+  "**/.git/**",
+  "**/dist/**",
 ];
 
 let globConfig = {
-	nocase: true,
-	ignore: ignore,
+  nocase: true,
+  ignore: ignore,
 };
 
 type FormatOptions = {
-	check : boolean,
-	silent : boolean,
+  check: boolean;
+  silent: boolean;
 };
 
 export type FormatResult = {
-	ok : boolean,
-	total : number,
-	checked : number,
-	valid : number,
-	invalid : number,
-	formatted : number,
+  ok: boolean;
+  total: number;
+  checked: number;
+  valid: number;
+  invalid: number;
+  formatted: number;
 };
 
-export async function format(filter : string, options : Partial<FormatOptions> = {}, signal ?: AbortSignal, onProgress ?: (result : FormatResult) => void) : Promise<FormatResult> {
-	let startTime = Date.now();
-
-	let rootDir = getRootDir();
-	let globStr = '**/*.mo';
-	if (filter) {
-		globStr = `**/*${filter}*.mo`;
-	}
-
-	let files = globSync(path.join(rootDir, globStr), {
-		...globConfig,
-		cwd: rootDir,
-	});
-	let invalidFiles = 0;
-	let checkedFiles = 0;
-
-	let getResult = (ok : boolean) => {
-		let result : FormatResult = {
-			ok,
-			total: files.length,
-			checked: checkedFiles,
-			valid: files.length - invalidFiles,
-			invalid: invalidFiles,
-			formatted: invalidFiles,
-		};
-		onProgress?.(result);
-		return result;
-	};
-
-	if (!files.length) {
-		if (filter) {
-			options.silent || console.log(`No files found for filter '${filter}'`);
-			return getResult(false);
-		}
-		if (!options.silent) {
-			console.log('No *.mo files found');
-		}
-		return getResult(false);
-	}
-
-	if (signal?.aborted) {
-		return getResult(false);
-	}
-
-	// get prettier config from .prettierrc
-	let prettierConfigFile = await prettier.resolveConfigFile();
-
-	await parallel(4, files, async (file) => {
-		if (signal?.aborted) {
-			return;
-		}
-
-		let conf = await prettier.resolveConfig(file, {editorconfig: true});
-		let prettierConfig : prettier.Options = {};
-		if (prettierConfigFile) {
-			if (conf) {
-				prettierConfig = conf;
-			}
-		}
-
-		// merge config from mops.toml [format]
-		// disabled, because we lose vscode extension support
-		// if (config.format) {
-		// 	Object.assign(prettierConfig, config.format);
-		// }
-
-		// add motoko parser plugin
-		Object.assign(prettierConfig, {
-			parser: 'motoko-tt-parse',
-			plugins: [motokoPlugin],
-			filepath: file,
-		});
-
-		// check file
-		let code = await fs.readFile(file, 'utf8');
-		let formatted = await prettier.format(code, prettierConfig);
-		let ok = formatted === code;
-		invalidFiles += Number(!ok);
-
-		if (options.check) {
-			if (ok) {
-				options.silent || console.log(`${chalk.green('✓')} ${absToRel(file)} ${chalk.gray('valid')}`);
-			}
-			else {
-				options.silent || console.log(`${chalk.red('✖')} ${absToRel(file)} ${chalk.gray('invalid')}`);
-			}
-		}
-		else {
-			if (ok) {
-				options.silent || console.log(`${chalk.green('✓')} ${absToRel(file)} ${chalk.gray('valid')}`);
-			}
-			else {
-				await fs.writeFile(file, formatted);
-				options.silent || console.log(`${chalk.yellow('*')} ${absToRel(file)} ${chalk.gray('formatted')}`);
-			}
-		}
-
-		checkedFiles += 1;
-
-		// trigger onProgress
-		getResult(false);
-	});
-
-	if (signal?.aborted) {
-		return getResult(false);
-	}
-
-	if (!options.silent) {
-		console.log('-'.repeat(50));
-
-		let plural = (n : number) => n === 1 ? '' : 's';
-		let str = `Checked ${chalk.gray(files.length)} file${plural(files.length)} in ${chalk.gray(((Date.now() - startTime) / 1000).toFixed(2) + 's')}`;
-		if (invalidFiles) {
-			str += options.check
-				? `, invalid ${chalk.redBright(invalidFiles)} file${plural(invalidFiles)}`
-				: `, formatted ${chalk.yellowBright(invalidFiles)} file${plural(invalidFiles)}`;
-		}
-		console.log(str);
-
-		if (!invalidFiles) {
-			console.log(chalk.green('✓ All files have valid formatting'));
-		}
-	}
-
-	if (options.check && invalidFiles && !options.silent) {
-		console.log(`${(`Run '${chalk.yellow('mops format' + (filter ? ` ${filter}` : ''))}' to format your code`)}`);
-		return getResult(false);
-	}
-
-	return getResult(true);
-}
+export async function format(
+  filter: string,
+  options: Partial<FormatOptions> = {},
+  signal?: AbortSignal,
+  onProgress?: (result: FormatResult) => void,
+): Promise<FormatResult> {
+  let startTime = Date.now();
+
+  let rootDir = getRootDir();
+  let globStr = "**/*.mo";
+  if (filter) {
+    globStr = `**/*${filter}*.mo`;
+  }
+
+  let files = globSync(path.join(rootDir, globStr), {
+    ...globConfig,
+    cwd: rootDir,
+  });
+  let invalidFiles = 0;
+  let checkedFiles = 0;
+
+  let getResult = (ok: boolean) => {
+    let result: FormatResult = {
+      ok,
+      total: files.length,
+      checked: checkedFiles,
+      valid: files.length - invalidFiles,
+      invalid: invalidFiles,
+      formatted: invalidFiles,
+    };
+    onProgress?.(result);
+    return result;
+  };
+
+  if (!files.length) {
+    if (filter) {
+      options.silent || console.log(`No files found for filter '${filter}'`);
+      return getResult(false);
+    }
+    if (!options.silent) {
+      console.log("No *.mo files found");
+    }
+    return getResult(false);
+  }
+
+  if (signal?.aborted) {
+    return getResult(false);
+  }
+
+  // get prettier config from .prettierrc
+  let prettierConfigFile = await prettier.resolveConfigFile();
+
+  await parallel(4, files, async (file) => {
+    if (signal?.aborted) {
+      return;
+    }
+
+    let conf = await prettier.resolveConfig(file, { editorconfig: true });
+    let prettierConfig: prettier.Options = {};
+    if (prettierConfigFile) {
+      if (conf) {
+        prettierConfig = conf;
+      }
+    }
+
+    // merge config from mops.toml [format]
+    // disabled, because we lose vscode extension support
+    // if (config.format) {
+    // 	Object.assign(prettierConfig, config.format);
+    // }
+
+    // add motoko parser plugin
+    Object.assign(prettierConfig, {
+      parser: "motoko-tt-parse",
+      plugins: [motokoPlugin],
+      filepath: file,
+    });
+
+    // check file
+    let code = await fs.readFile(file, "utf8");
+    let formatted = await prettier.format(code, prettierConfig);
+    let ok = formatted === code;
+    invalidFiles += Number(!ok);
+
+    if (options.check) {
+      if (ok) {
+        options.silent ||
+          console.log(
+            `${chalk.green("✓")} ${absToRel(file)} ${chalk.gray("valid")}`,
+          );
+      } else {
+        options.silent ||
+          console.log(
+            `${chalk.red("✖")} ${absToRel(file)} ${chalk.gray("invalid")}`,
+          );
+      }
+    } else {
+      if (ok) {
+        options.silent ||
+          console.log(
+            `${chalk.green("✓")} ${absToRel(file)} ${chalk.gray("valid")}`,
+          );
+      } else {
+        await fs.writeFile(file, formatted);
+        options.silent ||
+          console.log(
+            `${chalk.yellow("*")} ${absToRel(file)} ${chalk.gray("formatted")}`,
+          );
+      }
+    }
+
+    checkedFiles += 1;
+
+    // trigger onProgress
+    getResult(false);
+  });
+
+  if (signal?.aborted) {
+    return getResult(false);
+  }
+
+  if (!options.silent) {
+    console.log("-".repeat(50));
+
+    let plural = (n: number) => (n === 1 ? "" : "s");
+    let str = `Checked ${chalk.gray(files.length)} file${plural(files.length)} in ${chalk.gray(((Date.now() - startTime) / 1000).toFixed(2) + "s")}`;
+    if (invalidFiles) {
+      str += options.check
+        ? `, invalid ${chalk.redBright(invalidFiles)} file${plural(invalidFiles)}`
+        : `, formatted ${chalk.yellowBright(invalidFiles)} file${plural(invalidFiles)}`;
+    }
+    console.log(str);
+
+    if (!invalidFiles) {
+      console.log(chalk.green("✓ All files have valid formatting"));
+    }
+  }
+
+  if (options.check && invalidFiles && !options.silent) {
+    console.log(
+      `${`Run '${chalk.yellow("mops format" + (filter ? ` ${filter}` : ""))}' to format your code`}`,
+    );
+    return getResult(false);
+  }
+
+  return getResult(true);
+}