ic-mops 1.7.2 → 1.8.0

package/dist/cli.js

@@ -27,6 +27,7 @@ import { resolvePackages } from './resolve-packages.js';
 import { watch } from './commands/watch/watch.js';
 import { addOwner, printOwners, removeOwner } from './commands/owner.js';
 import { addMaintainer, printMaintainers, removeMaintainer } from './commands/maintainer.js';
+import { format } from './commands/format.js';
 events.setMaxListeners(20);
 let networkFile = getNetworkFile();
 if (fs.existsSync(networkFile)) {
@@ -404,6 +405,7 @@ program
     .description('Watch *.mo files and check for syntax errors, warnings, run tests, generate declarations and deploy canisters')
     .option('-e, --error', 'Check Motoko canisters or *.mo files for syntax errors')
     .option('-w, --warning', 'Check Motoko canisters or *.mo files for warnings')
+    .option('-f, --format', 'Format Motoko code')
     .option('-t, --test', 'Run tests')
     .option('-g, --generate', 'Generate declarations for Motoko canisters')
     .option('-d, --deploy', 'Deploy Motoko canisters')
@@ -411,4 +413,17 @@ program
     checkConfigFile(true);
     await watch(options);
 });
+// format
+program
+    .command('format [filter]')
+    .alias('fmt')
+    .description('Format Motoko code')
+    .addOption(new Option('--check', 'Check code formatting (do not change source files)'))
+    .action(async (filter, options) => {
+    checkConfigFile(true);
+    let { ok } = await format(filter, options);
+    if (!ok) {
+        process.exit(1);
+    }
+});
 program.parse();

package/dist/commands/format.d.ts

@@ -0,0 +1,14 @@
+type FormatOptions = {
+    check: boolean;
+    silent: boolean;
+};
+export type FormatResult = {
+    ok: boolean;
+    total: number;
+    checked: number;
+    valid: number;
+    invalid: number;
+    formatted: number;
+};
+export declare function format(filter: string, options?: Partial<FormatOptions>, signal?: AbortSignal, onProgress?: (result: FormatResult) => void): Promise<FormatResult>;
+export {};

package/dist/commands/format.js

@@ -0,0 +1,131 @@
+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';
+let ignore = [
+    '**/node_modules/**',
+    '**/.mops/**',
+    '**/.vessel/**',
+    '**/.git/**',
+    '**/dist/**',
+];
+let globConfig = {
+    nocase: true,
+    ignore: ignore,
+};
+export async function format(filter, options = {}, signal, onProgress) {
+    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) => {
+        let result = {
+            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 = {};
+        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) => 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);
+}

package/dist/commands/watch/formatter.d.ts

@@ -0,0 +1,19 @@
+import { FormatResult } from '../format.js';
+import { ErrorChecker } from './error-checker.js';
+export declare class Formatter {
+    verbose: boolean;
+    status: 'pending' | 'running' | 'syntax-error' | 'error' | 'success';
+    errorChecker: ErrorChecker;
+    aborted: boolean;
+    controller: AbortController;
+    currentRun: Promise<any> | undefined;
+    result: FormatResult | undefined;
+    constructor({ verbose, errorChecker }: {
+        verbose: boolean;
+        errorChecker: ErrorChecker;
+    });
+    reset(): void;
+    abortCurrent(): Promise<void>;
+    run(onProgress: () => void): Promise<void>;
+    getOutput(): string;
+}

package/dist/commands/watch/formatter.js

@@ -0,0 +1,57 @@
+import chalk from 'chalk';
+import { format } from '../format.js';
+export class Formatter {
+    constructor({ verbose, errorChecker }) {
+        this.verbose = false;
+        this.status = 'pending';
+        this.aborted = false;
+        this.controller = new AbortController();
+        this.verbose = verbose;
+        this.errorChecker = errorChecker;
+    }
+    reset() {
+        this.status = 'pending';
+        this.result = undefined;
+    }
+    async abortCurrent() {
+        this.aborted = true;
+        await this.currentRun;
+        this.reset();
+        this.aborted = false;
+    }
+    async run(onProgress) {
+        await this.abortCurrent();
+        if (this.errorChecker.status === 'error') {
+            this.status = 'syntax-error';
+            onProgress();
+            return;
+        }
+        this.status = 'running';
+        onProgress();
+        this.controller = new AbortController();
+        this.currentRun = format('', { silent: true }, this.controller.signal, (result) => {
+            this.result = result;
+            onProgress();
+        });
+        await this.currentRun;
+        if (!this.aborted) {
+            this.status = 'success';
+        }
+        onProgress();
+    }
+    getOutput() {
+        if (this.status === 'pending') {
+            return `Format: ${chalk.gray('(pending)')}`;
+        }
+        if (this.status === 'syntax-error') {
+            return `Format: ${chalk.gray('(errors)')}`;
+        }
+        if (!this.result) {
+            return `Format: ${chalk.gray('(pending)')}`;
+        }
+        if (this.status === 'running') {
+            return `Format: ${this.result.checked}/${this.result.total} ${chalk.gray('(running)')}`;
+        }
+        return `Format: ${chalk.greenBright(`${this.result.formatted}`)}`;
+    }
+}

package/dist/commands/watch/watch.d.ts

@@ -4,4 +4,5 @@ export declare function watch(options: {
     test: boolean;
     generate: boolean;
     deploy: boolean;
+    format: boolean;
 }): Promise<void>;

package/dist/commands/watch/watch.js

@@ -9,6 +9,7 @@ import { getRootDir } from '../../mops.js';
 import { Tester } from './tester.js';
 import { Generator } from './generator.js';
 import { Deployer } from './deployer.js';
+import { Formatter } from './formatter.js';
 let ignore = [
     '**/node_modules/**',
     '**/.mops/**',
@@ -24,6 +25,7 @@ export async function watch(options) {
             test: true,
             generate: true,
             deploy: true,
+            format: false,
         };
     }
     options.error = true;
@@ -35,6 +37,7 @@ export async function watch(options) {
     let tester = new Tester({ errorChecker, verbose: true });
     let generator = new Generator({ errorChecker, verbose: true, canisters: canistersWithDeclarations });
     let deployer = new Deployer({ errorChecker, generator, verbose: true, canisters: canisters });
+    let formatter = new Formatter({ errorChecker, verbose: true });
     let watcher = chokidar.watch([
         path.join(rootDir, '**/*.mo'),
         path.join(rootDir, 'mops.toml'),
@@ -42,14 +45,23 @@ export async function watch(options) {
         ignored: ignore,
         ignoreInitial: true,
     });
+    let formatting = false;
     let run = debounce(async () => {
+        if (formatting) {
+            return;
+        }
         errorChecker.reset();
         warningChecker.reset();
         tester.reset();
         generator.reset();
         deployer.reset();
+        formatter.reset();
+        if (options.format) {
+            formatting = true;
+        }
         options.error && await errorChecker.run(print);
         options.warning && warningChecker.run(print);
+        options.format && formatter.run(print).then(() => setTimeout(() => formatting = false, 500));
         options.test && tester.run(print);
         options.generate && await generator.run(print);
         options.deploy && deployer.run(print);
@@ -59,12 +71,14 @@ export async function watch(options) {
         process.stdout.write('\x1Bc');
         options.error && console.log(errorChecker.getOutput());
         options.warning && console.log(warningChecker.getOutput());
+        options.format && console.log(formatter.getOutput());
         options.test && console.log(tester.getOutput());
         options.generate && console.log(generator.getOutput());
         options.deploy && console.log(deployer.getOutput());
         let statuses = [];
         options.error && statuses.push(errorChecker.status);
         options.warning && statuses.push(warningChecker.status);
+        options.format && statuses.push(formatter.status);
         options.test && statuses.push(tester.status);
         options.generate && statuses.push(generator.status);
         options.deploy && statuses.push(deployer.status);
@@ -74,6 +88,10 @@ export async function watch(options) {
             console.log(chalk.dim(`Press ${chalk.bold('Ctrl+C')} to exit.`));
         }
     };
-    watcher.on('all', run);
+    watcher.on('all', () => {
+        if (!formatting) {
+            run();
+        }
+    });
     run();
 }

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ic-mops",
-  "version": "1.7.2",
+  "version": "1.8.0",
   "type": "module",
   "bin": {
     "mops": "bin/mops.js",
@@ -64,6 +64,8 @@
     "octokit": "3.1.2",
     "pem-file": "1.0.1",
     "pic-ic": "0.5.3",
+    "prettier": "3.5.3",
+    "prettier-plugin-motoko": "0.11.0",
     "promisify-child-process": "4.1.2",
     "prompts": "2.4.2",
     "semver": "7.7.1",
@@ -84,7 +86,7 @@
     "@types/semver": "7.5.8",
     "@types/stream-to-promise": "2.2.4",
     "@types/tar": "6.1.13",
-    "bun": "1.1.27",
+    "bun": "1.2.10",
     "esbuild": "0.23.1",
     "eslint": "8.57.0",
     "tsx": "4.19.2",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ic-mops",
-  "version": "1.7.2",
+  "version": "1.8.0",
   "type": "module",
   "bin": {
     "mops": "dist/bin/mops.js",
@@ -31,8 +31,8 @@
     "build": "npm run prepare && npm run bundle",
     "dist": "tsc",
     "bundle": "rm -rf ./bundle && bun build ./cli.ts --outdir ./bundle --target node --minify --external @napi-rs/lzma --external fsevents --format esm --define '__dirname=import.meta.dirname' && npm run bundle:fix && npm run bundle:copy && npm run bundle:package-json && npm run bundle:tar",
-    "bundle:fix": "npx -y rexreplace 'new URL\\(\"\\.\\./templates' 'new URL(\"./templates' bundle/cli.js",
-    "bundle:copy": "cp -r commands/bench bundle && cp -r bin declarations templates package.json bundle",
+    "bundle:fix": "npx -y rexreplace 'new URL\\(\"\\.\\./templates' 'new URL(\"./templates' bundle/cli.js && npx -y rexreplace '\"import.meta.dirname\",\"wasm_bg.wasm\"' 'import.meta.dirname || new URL(\".\", import.meta.url).pathname,\"wasm_bg.wasm\"' bundle/cli.js",
+    "bundle:copy": "cp -r commands/bench bundle && cp -r bin declarations templates package.json bundle && cp -r node_modules/prettier-plugin-motoko/wasm/pkg/nodejs/wasm_bg.wasm bundle",
     "bundle:package-json": "tsx bundle-package-json.ts",
     "bundle:tar": "rm -f bundle/cli.tgz && touch -t 200101010101 bundle/cli.tgz && find bundle -exec touch -d '1970-01-01 00:00:00' {} + && tar --sort name --exclude bundle/cli.tgz -cvf - bundle | gzip -n > bundle/cli.tgz",
     "copy": "cp -r commands/bench dist/commands && cp -r declarations templates package.json bin dist | true",
@@ -80,6 +80,8 @@
     "octokit": "3.1.2",
     "pem-file": "1.0.1",
     "pic-ic": "0.5.3",
+    "prettier": "3.5.3",
+    "prettier-plugin-motoko": "0.11.0",
     "promisify-child-process": "4.1.2",
     "prompts": "2.4.2",
     "semver": "7.7.1",
@@ -100,7 +102,7 @@
     "@types/semver": "7.5.8",
     "@types/stream-to-promise": "2.2.4",
     "@types/tar": "6.1.13",
-    "bun": "1.1.27",
+    "bun": "1.2.10",
     "esbuild": "0.23.1",
     "eslint": "8.57.0",
     "tsx": "4.19.2",

package/types.ts

@@ -19,6 +19,7 @@ export type Config = {
 	'dev-dependencies' ?: Dependencies;
 	toolchain ?: Toolchain;
 	requirements ?: Requirements;
+	// format ?: Format;
 };
 
 export type Dependencies = Record<string, Dependency>;
@@ -42,4 +43,13 @@ export type Requirements = {
 	moc ?: string;
 };
 
+// export type Format = {
+// 	useTabs ?: boolean;
+// 	tabWidth ?: number;
+// 	printWidth ?: number;
+// 	semi ?: boolean;
+// 	bracketSpacing ?: boolean;
+// 	trailingComma ?: 'none' | 'all';
+// };
+
 export type TestMode = 'interpreter' | 'wasi' | 'replica';