ic-mops 1.4.0-pre.0 → 1.4.0

package/CHANGELOG.md

@@ -1,9 +1,23 @@
 # Mops CLI Changelog
 
+## 1.4.0
+- Update `mops bench` command output:
+  - Print only final results if benchmarks run in a CI environment or there is no vertical space to progressively print the results
+  - Hide "Stable Memory" table if it has no data
+  - Hide verbose output when running in a CI environment ("Starting replica...", "Running simple.bench.mo...", etc.)
+  - Add LaTeX colors to the diffs when running in a CI environment with `--compare` flag
+- CLI now fails if excess arguments are passed to it
+
+## 1.3.0
+- Show error on `mops install <pkg>` command. Use `mops add <pkg>` instead.
+- Added support for pocket-ic replica that comes with dfx in `mops bench` command. To activate it, remove `pocket-ic` from `mops.toml` and run `mops bench --replica pocket-ic`. Requires dfx 0.24.1 or higher.
+- `mops init` now pre-fills package name with current directory name in kebab-case
+- Updated non-major npm dependencies
+
 ## 1.2.0
 - Removed `mops transfer-ownership` command
 - Added `mops owner` command to manage package owners ([docs](https://docs.mops.one/cli/mops-owner))
-- Added `mops maintainers` command to manage package maintainers ([docs](https://docs.mops.one/cli/mops-maintainers))
+- Added `mops maintainer` command to manage package maintainers ([docs](https://docs.mops.one/cli/mops-maintainer))
 - Added experimental support for pocket-ic replica that comes with dfx in `mops test` command ([docs](https://docs.mops.one/cli/mops-test#--replica))
 - Added flag `--verbose` to `mops test` command to show replica logs
 - Fixed bug where `mops watch` would fail if dfx.json did not exist

package/README.md

@@ -2,7 +2,10 @@
 
 Mops is a package manager for the Motoko programming language.
 
-See https://mops.one
+- [Motoko Package Registry](https://mops.one)
+- [Documentation](https://docs.mops.one)
+- [Blog](https://blog.mops.one)
+- [CLI](https://cli.mops.one)
 
 ## Setup
 
@@ -12,6 +15,10 @@ See https://mops.one
 
 ### 2. Install CLI tool
 ```
+curl -fsSL cli.mops.one/install.sh | sh
+```
+or
+```
 npm i -g ic-mops
 ```
 
@@ -33,8 +40,6 @@ Add `mops` as a packtool to your `dfx.json`
 ### 2. Initialize
 Run this command in the root directory of your project (where is `dfx.json` placed)
 
-If there are Vessel config files, mops will migrate packages from `vessel.dhall` to `mops.toml`
-
 ```
 mops init
 ```
@@ -110,4 +115,7 @@ Publish package to the mops registry!
 
 ```
 mops publish
-```
+```
+
+------------
+*Built for the [Supernova Hackathon](https://dfinity.org/supernova/)*

package/cli.ts

@@ -2,6 +2,7 @@ import process from 'node:process';
 import fs from 'node:fs';
 import events from 'node:events';
 import {Command, Argument, Option} from 'commander';
+import chalk from 'chalk';
 
 import {init} from './commands/init.js';
 import {publish} from './commands/publish.js';
@@ -98,6 +99,11 @@ program
 	.option('--verbose')
 	.addOption(new Option('--lock <action>', 'Lockfile action').choices(['check', 'update', 'ignore']))
 	.action(async (options) => {
+		if (process.argv.at(-1) !== 'install') {
+			console.log(`${chalk.red('Error:')} ${chalk.yellow('mops install')} command installs all dependencies.\nUse ${chalk.green(`mops add ${process.argv.at(-1)}`)} instead.`);
+			process.exit(1);
+		}
+
 		if (!checkConfigFile()) {
 			process.exit(1);
 		}

package/commands/bench-replica.ts

@@ -7,33 +7,36 @@ import {PocketIc, PocketIcServer} from 'pic-ic';
 import {getRootDir, readConfig} from '../mops.js';
 import {createActor, idlFactory} from '../declarations/bench/index.js';
 import {toolchain} from './toolchain/index.js';
+import {getDfxVersion} from '../helpers/get-dfx-version.js';
 
 export class BenchReplica {
-	type : 'dfx' | 'pocket-ic';
+	type : 'dfx' | 'pocket-ic' | 'dfx-pocket-ic';
 	verbose = false;
 	canisters : Record<string, {cwd : string; canisterId : string; actor : any;}> = {};
 	pocketIcServer ?: PocketIcServer;
 	pocketIc ?: PocketIc;
 
-	constructor(type : 'dfx' | 'pocket-ic', verbose = false) {
+	constructor(type : 'dfx' | 'pocket-ic' | 'dfx-pocket-ic', verbose = false) {
 		this.type = type;
 		this.verbose = verbose;
 	}
 
 	async start({silent = false} = {}) {
-		silent || console.log(`Starting ${this.type} replica...`);
+		if (!process.env.CI && !silent) {
+			console.log(`Starting ${this.type} replica...`);
+		}
 
-		if (this.type == 'dfx') {
+		if (this.type == 'dfx' || this.type === 'dfx-pocket-ic') {
 			await this.stop();
 			let dir = path.join(getRootDir(), '.mops/.bench');
 			fs.writeFileSync(path.join(dir, 'dfx.json'), JSON.stringify(this.dfxJson(''), null, 2));
-			execSync('dfx start --background --clean --artificial-delay 0' + (this.verbose ? '' : ' -qqqq'), {cwd: dir, stdio: ['inherit', this.verbose ? 'inherit' : 'ignore', 'inherit']});
+			execSync('dfx start --background --clean --artificial-delay 0' + (this.type === 'dfx-pocket-ic' ? ' --pocketic' : '') + (this.verbose ? '' : ' -qqqq'), {cwd: dir, stdio: ['inherit', this.verbose ? 'inherit' : 'ignore', 'inherit']});
 		}
 		else {
 			let pocketIcBin = await toolchain.bin('pocket-ic');
 			let config = readConfig();
-			if (config.toolchain?.['pocket-ic'] !== '6.0.0') {
-				console.error('Current Mops CLI only supports pocket-ic 6.0.0');
+			if (config.toolchain?.['pocket-ic'] !== '4.0.0') {
+				console.error('Current Mops CLI only supports pocket-ic 4.0.0');
 				process.exit(1);
 			}
 			this.pocketIcServer = await PocketIcServer.start({
@@ -44,7 +47,7 @@ export class BenchReplica {
 	}
 
 	async stop() {
-		if (this.type == 'dfx') {
+		if (this.type == 'dfx' || this.type === 'dfx-pocket-ic') {
 			let dir = path.join(getRootDir(), '.mops/.bench');
 			execSync('dfx stop' + (this.verbose ? '' : ' -qqqq'), {cwd: dir, stdio: ['pipe', this.verbose ? 'inherit' : 'ignore', 'pipe']});
 		}
@@ -55,7 +58,7 @@ export class BenchReplica {
 	}
 
 	async deploy(name : string, wasm : string, cwd : string = process.cwd()) {
-		if (this.type === 'dfx') {
+		if (this.type === 'dfx' || this.type === 'dfx-pocket-ic') {
 			await execaCommand(`dfx deploy ${name} --mode reinstall --yes --identity anonymous`, {cwd, stdio: this.verbose ? 'pipe' : ['pipe', 'ignore', 'pipe']});
 			let canisterId = execSync(`dfx canister id ${name}`, {cwd}).toString().trim();
 			let actor = await createActor(canisterId, {
@@ -96,6 +99,7 @@ export class BenchReplica {
 		return {
 			version: 1,
 			canisters,
+			dfx: getDfxVersion(),
 			defaults: {
 				build: {
 					packtool: 'mops sources',
@@ -109,4 +113,4 @@ export class BenchReplica {
 			},
 		};
 	}
-}
+}

package/commands/bench.ts

@@ -5,9 +5,12 @@ import os from 'node:os';
 import chalk from 'chalk';
 import {globSync} from 'glob';
 import {markdownTable} from 'markdown-table';
-import logUpdate from 'log-update';
+import {createLogUpdate} from 'log-update';
 import {execaCommand} from 'execa';
 import stringWidth from 'string-width';
+import {filesize} from 'filesize';
+import terminalSize from 'terminal-size';
+import {SemVer} from 'semver';
 
 import {getRootDir, readConfig} from '../mops.js';
 import {parallel} from '../parallel.js';
@@ -20,7 +23,8 @@ import {sources} from './sources.js';
 import {Benchmark, Benchmarks} from '../declarations/main/main.did.js';
 import {BenchResult, _SERVICE} from '../declarations/bench/bench.did.js';
 import {BenchReplica} from './bench-replica.js';
-import {filesize} from 'filesize';
+
+type ReplicaName = 'dfx' | 'pocket-ic' | 'dfx-pocket-ic';
 
 let ignore = [
 	'**/node_modules/**',
@@ -35,7 +39,7 @@ let globConfig = {
 };
 
 type BenchOptions = {
-	replica : 'dfx' | 'pocket-ic',
+	replica : ReplicaName,
 	replicaVersion : string,
 	compiler : 'moc',
 	compilerVersion : string,
@@ -66,16 +70,34 @@ export async function bench(filter = '', optionsArg : Partial<BenchOptions> = {}
 
 	let options : BenchOptions = {...defaultOptions, ...optionsArg};
 
-	if (options.replica == 'dfx') {
+	let replicaType = options.replica ?? (config.toolchain?.['pocket-ic'] ? 'pocket-ic' : 'dfx' as ReplicaName);
+	if (replicaType === 'pocket-ic' && !config.toolchain?.['pocket-ic']) {
+		let dfxVersion = getDfxVersion();
+		if (!dfxVersion || new SemVer(dfxVersion).compare('0.24.1') < 0) {
+			console.log(chalk.red('Please update dfx to the version >=0.24.1 or specify pocket-ic version in mops.toml'));
+			process.exit(1);
+		}
+		else {
+			replicaType = 'dfx-pocket-ic';
+		}
+	}
+
+	options.replica = replicaType;
+
+	if (process.env.CI) {
+		console.log('# Benchmark Results\n\n');
+	}
+
+	if (replicaType == 'dfx') {
 		options.replicaVersion = getDfxVersion();
 	}
-	else if (options.replica == 'pocket-ic') {
+	else if (replicaType == 'pocket-ic') {
 		options.replicaVersion = config.toolchain?.['pocket-ic'] || '';
 	}
 
 	options.verbose && console.log(options);
 
-	let replica = new BenchReplica(options.replica, options.verbose);
+	let replica = new BenchReplica(replicaType, options.verbose);
 
 	let rootDir = getRootDir();
 	let globStr = '**/bench?(mark)/**/*.bench.mo';
@@ -106,14 +128,19 @@ export async function bench(filter = '', optionsArg : Partial<BenchOptions> = {}
 		for (let file of files) {
 			console.log(chalk.gray(`• ${absToRel(file)}`));
 		}
-		console.log('');
-		console.log('='.repeat(50));
-		console.log('');
+		if (!process.env.CI) {
+			console.log('');
+			console.log('='.repeat(50));
+			console.log('');
+		}
 	}
 
 	await replica.start({silent: options.silent});
 
-	options.silent || console.log('Deploying canisters...');
+	if (!process.env.CI && !options.silent) {
+		console.log('Deploying canisters...');
+	}
+
 	await parallel(os.cpus().length, files, async (file : string) => {
 		try {
 			await deployBenchFile(file, options, replica);
@@ -128,8 +155,8 @@ export async function bench(filter = '', optionsArg : Partial<BenchOptions> = {}
 	let benchResults : Benchmarks = [];
 
 	await parallel(1, files, async (file : string) => {
-		if (!options.silent) {
-			console.log('\n' + '—'.repeat(50));
+		if (!options.silent && !process.env.CI) {
+			console.log('\n' + '-'.repeat(50));
 			console.log(`\nRunning ${chalk.gray(absToRel(file))}...`);
 			console.log('');
 		}
@@ -144,7 +171,9 @@ export async function bench(filter = '', optionsArg : Partial<BenchOptions> = {}
 		}
 	});
 
-	options.silent || console.log('Stopping replica...');
+	if (!process.env.CI && !options.silent) {
+		console.log('Stopping replica...');
+	}
 	await replica.stop();
 
 	fs.rmSync(benchDir, {recursive: true, force: true});
@@ -234,6 +263,7 @@ async function runBenchFile(file : string, options : BenchOptions, replica : Ben
 
 	let getTable = (prop : keyof BenchResult) : string => {
 		let resArr = [['', ...schema.cols]];
+		let allZero = true;
 
 		for (let [_rowIndex, row] of schema.rows.entries()) {
 			let curRow = [row];
@@ -241,6 +271,9 @@ async function runBenchFile(file : string, options : BenchOptions, replica : Ben
 			for (let [_colIndex, col] of schema.cols.entries()) {
 				let res = results.get(`${row}:${col}`);
 				if (res) {
+					if (res[prop] != 0n) {
+						allZero = false;
+					}
 
 					// compare with previous results
 					let diff = '';
@@ -248,10 +281,18 @@ async function runBenchFile(file : string, options : BenchOptions, replica : Ben
 						let prevRes = prevResults.get(`${row}:${col}`);
 						if (prevRes) {
 							let percent = (Number(res[prop]) - Number(prevRes[prop])) / Number(prevRes[prop]) * 100;
+							if (Object.is(percent, NaN)) {
+								percent = 0;
+							}
 							let sign = percent > 0 ? '+' : '';
 							let percentText = percent == 0 ? '0%' : sign + percent.toFixed(2) + '%';
 							let color : keyof typeof chalk = percent == 0 ? 'gray' : (percent > 0 ? 'red' : 'green');
-							diff = ` (${chalk[color](percentText)})`;
+							if (process.env.CI) {
+								diff = ` $({\\color{${color}}${percentText.replace('%', '\\\\%')}})$`;
+							}
+							else {
+								diff = ` (${chalk[color](percentText)})`;
+							}
 						}
 						else {
 							diff = chalk.yellow(' (no previous results)');
@@ -278,25 +319,47 @@ async function runBenchFile(file : string, options : BenchOptions, replica : Ben
 			resArr.push(curRow);
 		}
 
+		// don't show Stable Memory table if all values are 0
+		if (allZero && prop == 'rts_logical_stable_memory_size') {
+			return '';
+		}
+
 		return markdownTable(resArr, {
 			align: ['l', ...'r'.repeat(schema.cols.length)],
 			stringLength: stringWidth,
 		});
 	};
 
-	let printResults = () => {
-		logUpdate(`
-			\n${chalk.bold(schema.name)}
-			${schema.description ? '\n' + chalk.gray(schema.description) : ''}
+	let logUpdate = createLogUpdate(process.stdout, {showCursor: true});
+
+	let getOutput = () => {
+		return `
+			\n${process.env.CI ? `## ${schema.name}` : chalk.bold(schema.name)}
+			${schema.description ? '\n' + (process.env.CI ? `_${schema.description}_` : chalk.gray(schema.description)) : ''}
 			\n\n${chalk.blue('Instructions')}\n\n${getTable('instructions')}
 			\n\n${chalk.blue('Heap')}\n\n${getTable('rts_heap_size')}
-			\n\n${chalk.blue('Stable Memory')}\n\n${getTable('rts_logical_stable_memory_size')}
 			\n\n${chalk.blue('Garbage Collection')}\n\n${getTable('rts_reclaimed')}
-		`);
+			${getTable('rts_logical_stable_memory_size') ? `\n\n${chalk.blue('Stable Memory')}\n\n${getTable('rts_logical_stable_memory_size')}` : ''}
+		`;
 	};
 
-	if (!process.env.CI && !options.silent) {
-		printResults();
+	let canUpdateLog = !process.env.CI && !options.silent && terminalSize().rows > getOutput().split('\n').length;
+
+	let log = () => {
+		if (options.silent) {
+			return;
+		}
+		let output = getOutput();
+		if (process.env.CI || terminalSize().rows <= output.split('\n').length) {
+			console.log(output);
+		}
+		else {
+			logUpdate(output);
+		}
+	};
+
+	if (canUpdateLog) {
+		log();
 	}
 
 	// run all cells
@@ -314,16 +377,18 @@ async function runBenchFile(file : string, options : BenchOptions, replica : Ben
 			// @ts-ignore
 			reclaimedCells[rowIndex][colIndex] = res.rts_reclaimed;
 
-			if (!process.env.CI && !options.silent) {
-				printResults();
+			if (canUpdateLog) {
+				log();
 			}
 		}
 	}
 
-	if (process.env.CI) {
-		printResults();
+	if (canUpdateLog) {
+		logUpdate.done();
+	}
+	else {
+		log();
 	}
-	logUpdate.done();
 
 	// save results
 	if (options.save) {

package/commands/init.ts

@@ -11,6 +11,7 @@ import {installAll} from './install/install-all.js';
 import {VesselConfig, readVesselConfig} from '../vessel.js';
 import {Config, Dependencies} from '../types.js';
 import {template} from './template.js';
+import {kebabCase} from 'change-case';
 
 export async function init({yes = false} = {}) {
 	let configFile = path.join(process.cwd(), 'mops.toml');
@@ -88,7 +89,7 @@ export async function init({yes = false} = {}) {
 				type: 'text',
 				name: 'name',
 				message: 'Enter package name:',
-				initial: '',
+				initial: kebabCase(path.basename(process.cwd())),
 			},
 			{
 				type: 'text',
@@ -133,7 +134,7 @@ export async function init({yes = false} = {}) {
 		], promptsConfig);
 
 		config.package = {
-			name: (res.name || '').trim(),
+			name: kebabCase((res.name || '').trim()),
 			version: '1.0.0',
 			description: (res.description || '').trim(),
 			repository: (res.repository || '').trim(),

package/commands/replica.ts

@@ -87,8 +87,8 @@ export class Replica {
 
 			// eslint-disable-next-line
 			let config = readConfig();
-			if (config.toolchain?.['pocket-ic'] !== '6.0.0') {
-				console.error('Current Mops CLI only supports pocket-ic 6.0.0');
+			if (config.toolchain?.['pocket-ic'] !== '4.0.0') {
+				console.error('Current Mops CLI only supports pocket-ic 4.0.0');
 				process.exit(1);
 			}
 

package/commands/template.ts

@@ -2,7 +2,7 @@ import fs from 'node:fs';
 import path from 'node:path';
 import chalk from 'chalk';
 import prompts from 'prompts';
-import camelCase from 'camelcase';
+import {kebabCase, pascalCase} from 'change-case';
 import {getRootDir, readConfig} from '../mops.js';
 import {copyTemplateFileSync} from '../templates.js';
 
@@ -99,8 +99,8 @@ export async function template(templateName ?: string, options : any = {}) {
 		let data = fs.readFileSync(dest).toString();
 		data = data.replace(/<year>/g, new Date().getFullYear().toString());
 		if (config.package?.name) {
-			data = data.replace(/<name>/g, config.package.name);
-			data = data.replace(/<import-name>/g, camelCase(config.package.name, {pascalCase: true}));
+			data = data.replace(/<name>/g, kebabCase(config.package.name));
+			data = data.replace(/<import-name>/g, pascalCase(config.package.name));
 		}
 		fs.writeFileSync(dest, data);
 

package/dist/cli.js

@@ -2,6 +2,7 @@ import process from 'node:process';
 import fs from 'node:fs';
 import events from 'node:events';
 import { Command, Argument, Option } from 'commander';
+import chalk from 'chalk';
 import { init } from './commands/init.js';
 import { publish } from './commands/publish.js';
 import { sources } from './commands/sources.js';
@@ -80,6 +81,10 @@ program
     .option('--verbose')
     .addOption(new Option('--lock <action>', 'Lockfile action').choices(['check', 'update', 'ignore']))
     .action(async (options) => {
+    if (process.argv.at(-1) !== 'install') {
+        console.log(`${chalk.red('Error:')} ${chalk.yellow('mops install')} command installs all dependencies.\nUse ${chalk.green(`mops add ${process.argv.at(-1)}`)} instead.`);
+        process.exit(1);
+    }
     if (!checkConfigFile()) {
         process.exit(1);
     }

package/dist/commands/bench-replica.d.ts

@@ -1,6 +1,6 @@
 import { PocketIc, PocketIcServer } from 'pic-ic';
 export declare class BenchReplica {
-    type: 'dfx' | 'pocket-ic';
+    type: 'dfx' | 'pocket-ic' | 'dfx-pocket-ic';
     verbose: boolean;
     canisters: Record<string, {
         cwd: string;
@@ -9,7 +9,7 @@ export declare class BenchReplica {
     }>;
     pocketIcServer?: PocketIcServer;
     pocketIc?: PocketIc;
-    constructor(type: 'dfx' | 'pocket-ic', verbose?: boolean);
+    constructor(type: 'dfx' | 'pocket-ic' | 'dfx-pocket-ic', verbose?: boolean);
     start({ silent }?: {
         silent?: boolean | undefined;
     }): Promise<void>;
@@ -20,6 +20,7 @@ export declare class BenchReplica {
     dfxJson(canisterName: string): {
         version: number;
         canisters: Record<string, any>;
+        dfx: string;
         defaults: {
             build: {
                 packtool: string;

package/dist/commands/bench-replica.js

@@ -7,6 +7,7 @@ import { PocketIc, PocketIcServer } from 'pic-ic';
 import { getRootDir, readConfig } from '../mops.js';
 import { createActor, idlFactory } from '../declarations/bench/index.js';
 import { toolchain } from './toolchain/index.js';
+import { getDfxVersion } from '../helpers/get-dfx-version.js';
 export class BenchReplica {
     constructor(type, verbose = false) {
         this.verbose = false;
@@ -15,18 +16,20 @@ export class BenchReplica {
         this.verbose = verbose;
     }
     async start({ silent = false } = {}) {
-        silent || console.log(`Starting ${this.type} replica...`);
-        if (this.type == 'dfx') {
+        if (!process.env.CI && !silent) {
+            console.log(`Starting ${this.type} replica...`);
+        }
+        if (this.type == 'dfx' || this.type === 'dfx-pocket-ic') {
             await this.stop();
             let dir = path.join(getRootDir(), '.mops/.bench');
             fs.writeFileSync(path.join(dir, 'dfx.json'), JSON.stringify(this.dfxJson(''), null, 2));
-            execSync('dfx start --background --clean --artificial-delay 0' + (this.verbose ? '' : ' -qqqq'), { cwd: dir, stdio: ['inherit', this.verbose ? 'inherit' : 'ignore', 'inherit'] });
+            execSync('dfx start --background --clean --artificial-delay 0' + (this.type === 'dfx-pocket-ic' ? ' --pocketic' : '') + (this.verbose ? '' : ' -qqqq'), { cwd: dir, stdio: ['inherit', this.verbose ? 'inherit' : 'ignore', 'inherit'] });
         }
         else {
             let pocketIcBin = await toolchain.bin('pocket-ic');
             let config = readConfig();
-            if (config.toolchain?.['pocket-ic'] !== '6.0.0') {
-                console.error('Current Mops CLI only supports pocket-ic 6.0.0');
+            if (config.toolchain?.['pocket-ic'] !== '4.0.0') {
+                console.error('Current Mops CLI only supports pocket-ic 4.0.0');
                 process.exit(1);
             }
             this.pocketIcServer = await PocketIcServer.start({
@@ -36,7 +39,7 @@ export class BenchReplica {
         }
     }
     async stop() {
-        if (this.type == 'dfx') {
+        if (this.type == 'dfx' || this.type === 'dfx-pocket-ic') {
             let dir = path.join(getRootDir(), '.mops/.bench');
             execSync('dfx stop' + (this.verbose ? '' : ' -qqqq'), { cwd: dir, stdio: ['pipe', this.verbose ? 'inherit' : 'ignore', 'pipe'] });
         }
@@ -46,7 +49,7 @@ export class BenchReplica {
         }
     }
     async deploy(name, wasm, cwd = process.cwd()) {
-        if (this.type === 'dfx') {
+        if (this.type === 'dfx' || this.type === 'dfx-pocket-ic') {
             await execaCommand(`dfx deploy ${name} --mode reinstall --yes --identity anonymous`, { cwd, stdio: this.verbose ? 'pipe' : ['pipe', 'ignore', 'pipe'] });
             let canisterId = execSync(`dfx canister id ${name}`, { cwd }).toString().trim();
             let actor = await createActor(canisterId, {
@@ -83,6 +86,7 @@ export class BenchReplica {
         return {
             version: 1,
             canisters,
+            dfx: getDfxVersion(),
             defaults: {
                 build: {
                     packtool: 'mops sources',

package/dist/commands/bench.d.ts

@@ -1,6 +1,7 @@
 import { Benchmarks } from '../declarations/main/main.did.js';
+type ReplicaName = 'dfx' | 'pocket-ic' | 'dfx-pocket-ic';
 type BenchOptions = {
-    replica: 'dfx' | 'pocket-ic';
+    replica: ReplicaName;
     replicaVersion: string;
     compiler: 'moc';
     compilerVersion: string;

package/dist/commands/bench.js

@@ -5,9 +5,12 @@ import os from 'node:os';
 import chalk from 'chalk';
 import { globSync } from 'glob';
 import { markdownTable } from 'markdown-table';
-import logUpdate from 'log-update';
+import { createLogUpdate } from 'log-update';
 import { execaCommand } from 'execa';
 import stringWidth from 'string-width';
+import { filesize } from 'filesize';
+import terminalSize from 'terminal-size';
+import { SemVer } from 'semver';
 import { getRootDir, readConfig } from '../mops.js';
 import { parallel } from '../parallel.js';
 import { absToRel } from './test/utils.js';
@@ -16,7 +19,6 @@ import { getDfxVersion } from '../helpers/get-dfx-version.js';
 import { getMocPath } from '../helpers/get-moc-path.js';
 import { sources } from './sources.js';
 import { BenchReplica } from './bench-replica.js';
-import { filesize } from 'filesize';
 let ignore = [
     '**/node_modules/**',
     '**/.mops/**',
@@ -42,14 +44,29 @@ export async function bench(filter = '', optionsArg = {}) {
         silent: false,
     };
     let options = { ...defaultOptions, ...optionsArg };
-    if (options.replica == 'dfx') {
+    let replicaType = options.replica ?? (config.toolchain?.['pocket-ic'] ? 'pocket-ic' : 'dfx');
+    if (replicaType === 'pocket-ic' && !config.toolchain?.['pocket-ic']) {
+        let dfxVersion = getDfxVersion();
+        if (!dfxVersion || new SemVer(dfxVersion).compare('0.24.1') < 0) {
+            console.log(chalk.red('Please update dfx to the version >=0.24.1 or specify pocket-ic version in mops.toml'));
+            process.exit(1);
+        }
+        else {
+            replicaType = 'dfx-pocket-ic';
+        }
+    }
+    options.replica = replicaType;
+    if (process.env.CI) {
+        console.log('# Benchmark Results\n\n');
+    }
+    if (replicaType == 'dfx') {
         options.replicaVersion = getDfxVersion();
     }
-    else if (options.replica == 'pocket-ic') {
+    else if (replicaType == 'pocket-ic') {
         options.replicaVersion = config.toolchain?.['pocket-ic'] || '';
     }
     options.verbose && console.log(options);
-    let replica = new BenchReplica(options.replica, options.verbose);
+    let replica = new BenchReplica(replicaType, options.verbose);
     let rootDir = getRootDir();
     let globStr = '**/bench?(mark)/**/*.bench.mo';
     if (filter) {
@@ -76,12 +93,16 @@ export async function bench(filter = '', optionsArg = {}) {
         for (let file of files) {
             console.log(chalk.gray(`• ${absToRel(file)}`));
         }
-        console.log('');
-        console.log('='.repeat(50));
-        console.log('');
+        if (!process.env.CI) {
+            console.log('');
+            console.log('='.repeat(50));
+            console.log('');
+        }
     }
     await replica.start({ silent: options.silent });
-    options.silent || console.log('Deploying canisters...');
+    if (!process.env.CI && !options.silent) {
+        console.log('Deploying canisters...');
+    }
     await parallel(os.cpus().length, files, async (file) => {
         try {
             await deployBenchFile(file, options, replica);
@@ -94,8 +115,8 @@ export async function bench(filter = '', optionsArg = {}) {
     });
     let benchResults = [];
     await parallel(1, files, async (file) => {
-        if (!options.silent) {
-            console.log('\n' + '—'.repeat(50));
+        if (!options.silent && !process.env.CI) {
+            console.log('\n' + '-'.repeat(50));
             console.log(`\nRunning ${chalk.gray(absToRel(file))}...`);
             console.log('');
         }
@@ -109,7 +130,9 @@ export async function bench(filter = '', optionsArg = {}) {
             throw err;
         }
     });
-    options.silent || console.log('Stopping replica...');
+    if (!process.env.CI && !options.silent) {
+        console.log('Stopping replica...');
+    }
     await replica.stop();
     fs.rmSync(benchDir, { recursive: true, force: true });
     return benchResults;
@@ -182,21 +205,33 @@ async function runBenchFile(file, options, replica) {
     };
     let getTable = (prop) => {
         let resArr = [['', ...schema.cols]];
+        let allZero = true;
         for (let [_rowIndex, row] of schema.rows.entries()) {
             let curRow = [row];
             for (let [_colIndex, col] of schema.cols.entries()) {
                 let res = results.get(`${row}:${col}`);
                 if (res) {
+                    if (res[prop] != 0n) {
+                        allZero = false;
+                    }
                     // compare with previous results
                     let diff = '';
                     if (options.compare && prevResults) {
                         let prevRes = prevResults.get(`${row}:${col}`);
                         if (prevRes) {
                             let percent = (Number(res[prop]) - Number(prevRes[prop])) / Number(prevRes[prop]) * 100;
+                            if (Object.is(percent, NaN)) {
+                                percent = 0;
+                            }
                             let sign = percent > 0 ? '+' : '';
                             let percentText = percent == 0 ? '0%' : sign + percent.toFixed(2) + '%';
                             let color = percent == 0 ? 'gray' : (percent > 0 ? 'red' : 'green');
-                            diff = ` (${chalk[color](percentText)})`;
+                            if (process.env.CI) {
+                                diff = ` $({\\color{${color}}${percentText.replace('%', '\\\\%')}})$`;
+                            }
+                            else {
+                                diff = ` (${chalk[color](percentText)})`;
+                            }
                         }
                         else {
                             diff = chalk.yellow(' (no previous results)');
@@ -221,23 +256,41 @@ async function runBenchFile(file, options, replica) {
             }
             resArr.push(curRow);
         }
+        // don't show Stable Memory table if all values are 0
+        if (allZero && prop == 'rts_logical_stable_memory_size') {
+            return '';
+        }
         return markdownTable(resArr, {
             align: ['l', ...'r'.repeat(schema.cols.length)],
             stringLength: stringWidth,
         });
     };
-    let printResults = () => {
-        logUpdate(`
-			\n${chalk.bold(schema.name)}
-			${schema.description ? '\n' + chalk.gray(schema.description) : ''}
+    let logUpdate = createLogUpdate(process.stdout, { showCursor: true });
+    let getOutput = () => {
+        return `
+			\n${process.env.CI ? `## ${schema.name}` : chalk.bold(schema.name)}
+			${schema.description ? '\n' + (process.env.CI ? `_${schema.description}_` : chalk.gray(schema.description)) : ''}
 			\n\n${chalk.blue('Instructions')}\n\n${getTable('instructions')}
 			\n\n${chalk.blue('Heap')}\n\n${getTable('rts_heap_size')}
-			\n\n${chalk.blue('Stable Memory')}\n\n${getTable('rts_logical_stable_memory_size')}
 			\n\n${chalk.blue('Garbage Collection')}\n\n${getTable('rts_reclaimed')}
-		`);
+			${getTable('rts_logical_stable_memory_size') ? `\n\n${chalk.blue('Stable Memory')}\n\n${getTable('rts_logical_stable_memory_size')}` : ''}
+		`;
     };
-    if (!process.env.CI && !options.silent) {
-        printResults();
+    let canUpdateLog = !process.env.CI && !options.silent && terminalSize().rows > getOutput().split('\n').length;
+    let log = () => {
+        if (options.silent) {
+            return;
+        }
+        let output = getOutput();
+        if (process.env.CI || terminalSize().rows <= output.split('\n').length) {
+            console.log(output);
+        }
+        else {
+            logUpdate(output);
+        }
+    };
+    if (canUpdateLog) {
+        log();
     }
     // run all cells
     for (let [rowIndex, row] of schema.rows.entries()) {
@@ -252,15 +305,17 @@ async function runBenchFile(file, options, replica) {
             logicalStableMemoryCells[rowIndex][colIndex] = res.rts_logical_stable_memory_size;
             // @ts-ignore
             reclaimedCells[rowIndex][colIndex] = res.rts_reclaimed;
-            if (!process.env.CI && !options.silent) {
-                printResults();
+            if (canUpdateLog) {
+                log();
             }
         }
     }
-    if (process.env.CI) {
-        printResults();
+    if (canUpdateLog) {
+        logUpdate.done();
+    }
+    else {
+        log();
     }
-    logUpdate.done();
     // save results
     if (options.save) {
         console.log(`Saving results to ${chalk.gray(absToRel(resultsJsonFile))}`);

package/dist/commands/init.js

@@ -9,6 +9,7 @@ import { mainActor } from '../api/actors.js';
 import { installAll } from './install/install-all.js';
 import { readVesselConfig } from '../vessel.js';
 import { template } from './template.js';
+import { kebabCase } from 'change-case';
 export async function init({ yes = false } = {}) {
     let configFile = path.join(process.cwd(), 'mops.toml');
     let exists = existsSync(configFile);
@@ -73,7 +74,7 @@ export async function init({ yes = false } = {}) {
                 type: 'text',
                 name: 'name',
                 message: 'Enter package name:',
-                initial: '',
+                initial: kebabCase(path.basename(process.cwd())),
             },
             {
                 type: 'text',
@@ -117,7 +118,7 @@ export async function init({ yes = false } = {}) {
             },
         ], promptsConfig);
         config.package = {
-            name: (res.name || '').trim(),
+            name: kebabCase((res.name || '').trim()),
             version: '1.0.0',
             description: (res.description || '').trim(),
             repository: (res.repository || '').trim(),

package/dist/commands/replica.js

@@ -65,8 +65,8 @@ export class Replica {
             let pocketIcBin = await toolchain.bin('pocket-ic');
             // eslint-disable-next-line
             let config = readConfig();
-            if (config.toolchain?.['pocket-ic'] !== '6.0.0') {
-                console.error('Current Mops CLI only supports pocket-ic 6.0.0');
+            if (config.toolchain?.['pocket-ic'] !== '4.0.0') {
+                console.error('Current Mops CLI only supports pocket-ic 4.0.0');
                 process.exit(1);
             }
             this.pocketIcServer = await PocketIcServer.start({

package/dist/commands/template.js

@@ -2,7 +2,7 @@ import fs from 'node:fs';
 import path from 'node:path';
 import chalk from 'chalk';
 import prompts from 'prompts';
-import camelCase from 'camelcase';
+import { kebabCase, pascalCase } from 'change-case';
 import { getRootDir, readConfig } from '../mops.js';
 import { copyTemplateFileSync } from '../templates.js';
 export async function template(templateName, options = {}) {
@@ -93,8 +93,8 @@ export async function template(templateName, options = {}) {
         let data = fs.readFileSync(dest).toString();
         data = data.replace(/<year>/g, new Date().getFullYear().toString());
         if (config.package?.name) {
-            data = data.replace(/<name>/g, config.package.name);
-            data = data.replace(/<import-name>/g, camelCase(config.package.name, { pascalCase: true }));
+            data = data.replace(/<name>/g, kebabCase(config.package.name));
+            data = data.replace(/<import-name>/g, pascalCase(config.package.name));
         }
         fs.writeFileSync(dest, data);
         console.log(chalk.green('Created'), path.relative(getRootDir(), 'README.md'));

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ic-mops",
-  "version": "1.4.0-pre.0",
+  "version": "1.4.0",
   "type": "module",
   "bin": {
     "mops": "bin/mops.js",
@@ -28,20 +28,20 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "@dfinity/agent": "2.2.0",
-    "@dfinity/candid": "2.2.0",
-    "@dfinity/identity": "2.2.0",
-    "@dfinity/identity-secp256k1": "2.2.0",
-    "@dfinity/principal": "2.2.0",
+    "@dfinity/agent": "2.3.0",
+    "@dfinity/candid": "2.3.0",
+    "@dfinity/identity": "2.3.0",
+    "@dfinity/identity-secp256k1": "2.3.0",
+    "@dfinity/principal": "2.3.0",
     "@iarna/toml": "2.2.5",
-    "@noble/hashes": "1.5.0",
+    "@noble/hashes": "1.7.1",
     "as-table": "1.0.55",
     "buffer": "6.0.3",
     "cacheable-request": "12.0.1",
-    "camelcase": "8.0.0",
-    "chalk": "5.3.0",
+    "chalk": "5.4.1",
+    "change-case": "5.4.4",
     "chokidar": "3.6.0",
-    "commander": "12.1.0",
+    "commander": "13.1.0",
     "debounce": "2.1.1",
     "decomp-tarxz": "0.1.1",
     "decompress": "4.2.1",
@@ -51,25 +51,26 @@
     "filesize": "10.1.6",
     "fs-extra": "11.2.0",
     "get-folder-size": "5.0.0",
-    "glob": "11.0.0",
+    "glob": "11.0.1",
     "globby": "14.0.2",
-    "got": "14.4.2",
+    "got": "14.4.6",
     "log-update": "6.1.0",
-    "markdown-table": "3.0.3",
-    "mdast-util-from-markdown": "2.0.1",
-    "mdast-util-to-markdown": "2.1.0",
+    "markdown-table": "3.0.4",
+    "mdast-util-from-markdown": "2.0.2",
+    "mdast-util-to-markdown": "2.1.2",
     "minimatch": "10.0.1",
     "ncp": "2.0.0",
     "node-fetch": "3.3.2",
     "octokit": "3.1.2",
     "pem-file": "1.0.1",
-    "pic-ic": "0.7.0",
+    "pic-ic": "0.5.3",
     "promisify-child-process": "4.1.2",
     "prompts": "2.4.2",
-    "semver": "7.6.3",
+    "semver": "7.7.1",
     "stream-to-promise": "3.0.0",
     "string-width": "7.2.0",
-    "tar": "7.4.3"
+    "tar": "7.4.3",
+    "terminal-size": "4.0.0"
   },
   "devDependencies": {
     "@tsconfig/strictest": "2.0.5",
@@ -78,7 +79,7 @@
     "@types/fs-extra": "11.0.4",
     "@types/glob": "8.1.0",
     "@types/ncp": "2.0.8",
-    "@types/node": "22.7.4",
+    "@types/node": "22.13.4",
     "@types/prompts": "2.4.9",
     "@types/semver": "7.5.8",
     "@types/stream-to-promise": "2.2.4",
@@ -86,7 +87,7 @@
     "bun": "1.1.27",
     "esbuild": "0.23.1",
     "eslint": "8.57.0",
-    "tsx": "4.19.1",
-    "typescript": "5.6.2"
+    "tsx": "4.19.2",
+    "typescript": "5.7.3"
   }
 }

package/dist/pem.d.ts

@@ -2,4 +2,4 @@ import { Buffer } from 'node:buffer';
 import { Ed25519KeyIdentity } from '@dfinity/identity';
 import { Secp256k1KeyIdentity } from '@dfinity/identity-secp256k1';
 export declare function decodeFile(file: string, password?: string): Secp256k1KeyIdentity | Ed25519KeyIdentity;
-export declare function encrypt(buffer: Buffer, password: string): Buffer;
+export declare function encrypt(buffer: Buffer, password: string): Buffer<ArrayBuffer>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ic-mops",
-  "version": "1.4.0-pre.0",
+  "version": "1.4.0",
   "type": "module",
   "bin": {
     "mops": "dist/bin/mops.js",
@@ -44,20 +44,20 @@
     "esbuild": "esbuild"
   },
   "dependencies": {
-    "@dfinity/agent": "2.2.0",
-    "@dfinity/candid": "2.2.0",
-    "@dfinity/identity": "2.2.0",
-    "@dfinity/identity-secp256k1": "2.2.0",
-    "@dfinity/principal": "2.2.0",
+    "@dfinity/agent": "2.3.0",
+    "@dfinity/candid": "2.3.0",
+    "@dfinity/identity": "2.3.0",
+    "@dfinity/identity-secp256k1": "2.3.0",
+    "@dfinity/principal": "2.3.0",
     "@iarna/toml": "2.2.5",
-    "@noble/hashes": "1.5.0",
+    "@noble/hashes": "1.7.1",
     "as-table": "1.0.55",
     "buffer": "6.0.3",
     "cacheable-request": "12.0.1",
-    "camelcase": "8.0.0",
-    "chalk": "5.3.0",
+    "chalk": "5.4.1",
+    "change-case": "5.4.4",
     "chokidar": "3.6.0",
-    "commander": "12.1.0",
+    "commander": "13.1.0",
     "debounce": "2.1.1",
     "decomp-tarxz": "0.1.1",
     "decompress": "4.2.1",
@@ -67,25 +67,26 @@
     "filesize": "10.1.6",
     "fs-extra": "11.2.0",
     "get-folder-size": "5.0.0",
-    "glob": "11.0.0",
+    "glob": "11.0.1",
     "globby": "14.0.2",
-    "got": "14.4.2",
+    "got": "14.4.6",
     "log-update": "6.1.0",
-    "markdown-table": "3.0.3",
-    "mdast-util-from-markdown": "2.0.1",
-    "mdast-util-to-markdown": "2.1.0",
+    "markdown-table": "3.0.4",
+    "mdast-util-from-markdown": "2.0.2",
+    "mdast-util-to-markdown": "2.1.2",
     "minimatch": "10.0.1",
     "ncp": "2.0.0",
     "node-fetch": "3.3.2",
     "octokit": "3.1.2",
     "pem-file": "1.0.1",
-    "pic-ic": "0.7.0",
+    "pic-ic": "0.5.3",
     "promisify-child-process": "4.1.2",
     "prompts": "2.4.2",
-    "semver": "7.6.3",
+    "semver": "7.7.1",
     "stream-to-promise": "3.0.0",
     "string-width": "7.2.0",
-    "tar": "7.4.3"
+    "tar": "7.4.3",
+    "terminal-size": "4.0.0"
   },
   "devDependencies": {
     "@tsconfig/strictest": "2.0.5",
@@ -94,7 +95,7 @@
     "@types/fs-extra": "11.0.4",
     "@types/glob": "8.1.0",
     "@types/ncp": "2.0.8",
-    "@types/node": "22.7.4",
+    "@types/node": "22.13.4",
     "@types/prompts": "2.4.9",
     "@types/semver": "7.5.8",
     "@types/stream-to-promise": "2.2.4",
@@ -102,7 +103,7 @@
     "bun": "1.1.27",
     "esbuild": "0.23.1",
     "eslint": "8.57.0",
-    "tsx": "4.19.1",
-    "typescript": "5.6.2"
+    "tsx": "4.19.2",
+    "typescript": "5.7.3"
   }
 }