ic-mops 1.11.1 → 2.0.0

package/dist/commands/publish.js

@@ -1,20 +1,20 @@
-import process from 'node:process';
-import fs from 'node:fs';
-import path from 'node:path';
-import chalk from 'chalk';
-import logUpdate from 'log-update';
-import { globbySync } from 'globby';
-import { minimatch } from 'minimatch';
-import prompts from 'prompts';
-import { checkConfigFile, getIdentity, getRootDir, progressBar, readConfig } from '../mops.js';
-import { mainActor } from '../api/actors.js';
-import { parallel } from '../parallel.js';
-import { docs } from './docs.js';
-import { testWithReporter } from './test/test.js';
-import { SilentReporter } from './test/reporters/silent-reporter.js';
-import { findChangelogEntry } from '../helpers/find-changelog-entry.js';
-import { bench } from './bench.js';
-import { docsCoverage } from './docs-coverage.js';
+import process from "node:process";
+import fs from "node:fs";
+import path from "node:path";
+import chalk from "chalk";
+import logUpdate from "log-update";
+import { globbySync } from "globby";
+import { minimatch } from "minimatch";
+import prompts from "prompts";
+import { checkConfigFile, getIdentity, getRootDir, progressBar, readConfig, } from "../mops.js";
+import { mainActor } from "../api/actors.js";
+import { parallel } from "../parallel.js";
+import { docs } from "./docs.js";
+import { testWithReporter } from "./test/test.js";
+import { SilentReporter } from "./test/reporters/silent-reporter.js";
+import { findChangelogEntry } from "../helpers/find-changelog-entry.js";
+import { bench } from "./bench.js";
+import { docsCoverage } from "./docs-coverage.js";
 export async function publish(options = {}) {
     if (!checkConfigFile()) {
         return;
@@ -24,30 +24,38 @@ export async function publish(options = {}) {
     console.log(`Publishing ${config.package?.name}@${config.package?.version}`);
     // validate
     for (let key of Object.keys(config)) {
-        if (!['package', 'dependencies', 'dev-dependencies', 'toolchain', 'requirements'].includes(key)) {
-            console.log(chalk.red('Error: ') + `Unknown config section [${key}]`);
+        if (![
+            "package",
+            "dependencies",
+            "dev-dependencies",
+            "toolchain",
+            "requirements",
+        ].includes(key)) {
+            console.log(chalk.red("Error: ") + `Unknown config section [${key}]`);
             process.exit(1);
         }
     }
     // required fields
     if (!config.package) {
-        console.log(chalk.red('Error: ') + 'Please specify [package] section in your mops.toml');
+        console.log(chalk.red("Error: ") +
+            "Please specify [package] section in your mops.toml");
         process.exit(1);
     }
-    for (let key of ['name', 'version']) {
+    for (let key of ["name", "version"]) {
         // @ts-ignore
         if (!config.package[key]) {
-            console.log(chalk.red('Error: ') + `Please specify "${key}" in [package] section in your mops.toml`);
+            console.log(chalk.red("Error: ") +
+                `Please specify "${key}" in [package] section in your mops.toml`);
             process.exit(1);
         }
     }
     // desired fields
-    for (let key of ['description', 'repository']) {
+    for (let key of ["description", "repository"]) {
         // @ts-ignore
         if (!config.package[key] && !process.env.CI) {
             let res = await prompts({
-                type: 'confirm',
-                name: 'ok',
+                type: "confirm",
+                name: "ok",
                 message: `Missing recommended config key "${key}", publish anyway?`,
             });
             if (!res.ok) {
@@ -56,24 +64,24 @@ export async function publish(options = {}) {
         }
     }
     let packageKeys = [
-        'name',
-        'version',
-        'keywords',
-        'description',
-        'repository',
-        'documentation',
-        'homepage',
-        'baseDir',
-        'readme',
-        'license',
-        'files',
-        'dfx',
-        'moc',
-        'donation',
+        "name",
+        "version",
+        "keywords",
+        "description",
+        "repository",
+        "documentation",
+        "homepage",
+        "baseDir",
+        "readme",
+        "license",
+        "files",
+        "dfx",
+        "moc",
+        "donation",
     ];
     for (let key of Object.keys(config.package)) {
         if (!packageKeys.includes(key)) {
-            console.log(chalk.red('Error: ') + `Unknown config key 'package.${key}'`);
+            console.log(chalk.red("Error: ") + `Unknown config key 'package.${key}'`);
             process.exit(1);
         }
     }
@@ -97,18 +105,19 @@ export async function publish(options = {}) {
     for (let [key, max] of Object.entries(keysMax)) {
         // @ts-ignore
         if (config.package[key] && config.package[key].length > max) {
-            console.log(chalk.red('Error: ') + `package.${key} value max length is ${max}`);
+            console.log(chalk.red("Error: ") + `package.${key} value max length is ${max}`);
             process.exit(1);
         }
     }
     if (config.dependencies) {
         if (Object.keys(config.dependencies).length > 100) {
-            console.log(chalk.red('Error: ') + 'max dependencies is 100');
+            console.log(chalk.red("Error: ") + "max dependencies is 100");
             process.exit(1);
         }
         for (let dep of Object.values(config.dependencies)) {
             if (dep.path) {
-                console.log(chalk.red('Error: ') + 'you can\'t publish packages with local dependencies');
+                console.log(chalk.red("Error: ") +
+                    "you can't publish packages with local dependencies");
                 process.exit(1);
             }
             delete dep.path;
@@ -116,9 +125,9 @@ export async function publish(options = {}) {
         for (let dep of Object.values(config.dependencies)) {
             if (dep.repo && !process.env.CI) {
                 let res = await prompts({
-                    type: 'confirm',
-                    name: 'ok',
-                    message: chalk.yellow('GitHub dependencies make the registry less reliable and limit its capabilities.\nIf you are the owner of the dependency, please consider publishing it to the Mops registry.') + '\n\nPublish anyway?',
+                    type: "confirm",
+                    name: "ok",
+                    message: chalk.yellow("GitHub dependencies make the registry less reliable and limit its capabilities.\nIf you are the owner of the dependency, please consider publishing it to the Mops registry.") + "\n\nPublish anyway?",
                 });
                 if (!res.ok) {
                     return;
@@ -126,14 +135,15 @@ export async function publish(options = {}) {
             }
         }
     }
-    if (config['dev-dependencies']) {
-        if (Object.keys(config['dev-dependencies']).length > 100) {
-            console.log(chalk.red('Error: ') + 'max dev-dependencies is 100');
+    if (config["dev-dependencies"]) {
+        if (Object.keys(config["dev-dependencies"]).length > 100) {
+            console.log(chalk.red("Error: ") + "max dev-dependencies is 100");
             process.exit(1);
         }
-        for (let dep of Object.values(config['dev-dependencies'])) {
+        for (let dep of Object.values(config["dev-dependencies"])) {
             if (dep.path) {
-                console.log(chalk.red('Error: ') + 'you can\'t publish packages with local dev-dependencies');
+                console.log(chalk.red("Error: ") +
+                    "you can't publish packages with local dev-dependencies");
                 process.exit(1);
             }
             delete dep.path;
@@ -142,23 +152,23 @@ export async function publish(options = {}) {
     if (config.package.keywords) {
         for (let keyword of config.package.keywords) {
             if (keyword.length > 20) {
-                console.log(chalk.red('Error: ') + 'max keyword length is 20');
+                console.log(chalk.red("Error: ") + "max keyword length is 20");
                 return;
             }
         }
     }
     if (config.package.files) {
         for (let file of config.package.files) {
-            if (file.startsWith('/') || file.startsWith('../')) {
-                console.log(chalk.red('Error: ') + 'file path cannot start with \'/\' or \'../\'');
+            if (file.startsWith("/") || file.startsWith("../")) {
+                console.log(chalk.red("Error: ") + "file path cannot start with '/' or '../'");
                 return;
             }
         }
     }
     if (config.requirements) {
         Object.keys(config.requirements).forEach((name) => {
-            if (name !== 'moc') {
-                console.log(chalk.red('Error: ') + `Unknown requirement "${name}"`);
+            if (name !== "moc") {
+                console.log(chalk.red("Error: ") + `Unknown requirement "${name}"`);
                 return;
             }
         });
@@ -166,8 +176,8 @@ export async function publish(options = {}) {
     let toBackendDep = (dep) => {
         return {
             ...dep,
-            version: dep.version || '',
-            repo: dep.repo || '',
+            version: dep.version || "",
+            repo: dep.repo || "",
         };
     };
     let toBackendReq = ([name, value]) => {
@@ -178,51 +188,53 @@ export async function publish(options = {}) {
         name: config.package.name,
         version: config.package.version,
         keywords: config.package.keywords || [],
-        description: config.package.description || '',
-        repository: config.package.repository || '',
-        homepage: config.package.homepage || '',
-        documentation: config.package.documentation || '',
-        baseDir: 'src',
-        readme: 'README.md',
-        license: config.package.license || '',
-        dfx: config.package.dfx || '',
-        moc: config.package.moc || '',
-        donation: config.package.donation || '',
+        description: config.package.description || "",
+        repository: config.package.repository || "",
+        homepage: config.package.homepage || "",
+        documentation: config.package.documentation || "",
+        baseDir: "src",
+        readme: "README.md",
+        license: config.package.license || "",
+        dfx: config.package.dfx || "",
+        moc: config.package.moc || "",
+        donation: config.package.donation || "",
         dependencies: Object.values(config.dependencies || {}).map(toBackendDep),
-        devDependencies: Object.values(config['dev-dependencies'] || {}).map(toBackendDep),
+        devDependencies: Object.values(config["dev-dependencies"] || {}).map(toBackendDep),
         scripts: [],
-        requirements: [Object.entries(config.requirements || {}).map((req) => toBackendReq(req))],
+        requirements: [
+            Object.entries(config.requirements || {}).map((req) => toBackendReq(req)),
+        ],
     };
     let defaultFiles = [
-        'mops.toml',
-        'README.md',
-        'LICENSE',
-        'NOTICE',
-        '!.mops/**',
-        '!test/**',
-        '!tests/**',
-        '!**/*.test.mo',
-        '!**/*.Test.mo',
-        '!bench/**',
-        '!benchmark/**',
-        '!**/*.bench.mo',
-        '!**/*.Bench.mo',
-        '!**/node_modules/**',
+        "mops.toml",
+        "README.md",
+        "LICENSE",
+        "NOTICE",
+        "!.mops/**",
+        "!test/**",
+        "!tests/**",
+        "!**/*.test.mo",
+        "!**/*.Test.mo",
+        "!bench/**",
+        "!benchmark/**",
+        "!**/*.bench.mo",
+        "!**/*.Bench.mo",
+        "!**/node_modules/**",
     ];
-    let files = config.package.files || ['**/*.mo'];
+    let files = config.package.files || ["**/*.mo"];
     files = [...files, ...defaultFiles];
     files = globbySync([...files, ...defaultFiles]);
     if (options.verbose) {
-        console.log('Files:');
-        console.log(files.map((file) => '  ' + file).join('\n'));
+        console.log("Files:");
+        console.log(files.map((file) => "  " + file).join("\n"));
     }
     // generate docs
-    let docsFile = path.join(rootDir, '.mops/.docs/docs.tgz');
+    let docsFile = path.join(rootDir, ".mops/.docs/docs.tgz");
     let docsCov = 0;
     if (options.docs) {
-        console.log('Generating documentation...');
+        console.log("Generating documentation...");
         docsCov = await docsCoverage({
-            reporter: 'silent',
+            reporter: "silent",
         });
         await docs({ silent: true, archive: true });
         if (fs.existsSync(docsFile)) {
@@ -230,57 +242,61 @@ export async function publish(options = {}) {
         }
     }
     // check required files
-    if (!files.includes('mops.toml')) {
-        console.log(chalk.red('Error: ') + ' please add mops.toml file');
+    if (!files.includes("mops.toml")) {
+        console.log(chalk.red("Error: ") + " please add mops.toml file");
         process.exit(1);
     }
-    if (!files.includes('README.md')) {
-        console.log(chalk.red('Error: ') + ' please add README.md file');
+    if (!files.includes("README.md")) {
+        console.log(chalk.red("Error: ") + " please add README.md file");
         process.exit(1);
     }
     // check allowed exts
     for (let file of files) {
-        if (!minimatch(file, '**/*.{mo,did,md,toml}') && !file.toLowerCase().endsWith('license') && !file.toLowerCase().endsWith('notice') && file !== docsFile) {
-            console.log(chalk.red('Error: ') + `file ${file} has unsupported extension. Allowed: .mo, .did, .md, .toml`);
+        if (!minimatch(file, "**/*.{mo,did,md,toml}") &&
+            !file.toLowerCase().endsWith("license") &&
+            !file.toLowerCase().endsWith("notice") &&
+            file !== docsFile) {
+            console.log(chalk.red("Error: ") +
+                `file ${file} has unsupported extension. Allowed: .mo, .did, .md, .toml`);
             process.exit(1);
         }
     }
     // parse changelog
-    console.log('Parsing CHANGELOG.md...');
+    console.log("Parsing CHANGELOG.md...");
     let changelog = parseChangelog(config.package.version);
     if (!changelog && config.package.repository) {
-        console.log('Fetching release notes from GitHub...');
+        console.log("Fetching release notes from GitHub...");
         changelog = await fetchGitHubReleaseNotes(config.package.repository, config.package.version);
     }
     if (changelog) {
-        console.log('Changelog:');
+        console.log("Changelog:");
         console.log(chalk.gray(changelog));
     }
     // test
-    let reporter = new SilentReporter;
+    let reporter = new SilentReporter();
     if (options.test) {
-        console.log('Running tests...');
-        await testWithReporter(reporter, '', 'interpreter', config.toolchain?.['pocket-ic'] ? 'pocket-ic' : 'dfx');
+        console.log("Running tests...");
+        await testWithReporter(reporter, "", "interpreter", config.toolchain?.["pocket-ic"] ? "pocket-ic" : "dfx");
         if (reporter.failed > 0) {
-            console.log(chalk.red('Error: ') + 'tests failed');
+            console.log(chalk.red("Error: ") + "tests failed");
             process.exit(1);
         }
     }
     // bench
     let benchmarks = [];
     if (options.bench) {
-        console.log('Running benchmarks...');
+        console.log("Running benchmarks...");
         try {
-            benchmarks = await bench('', {
-                replica: config.toolchain?.['pocket-ic'] ? 'pocket-ic' : 'dfx',
-                gc: 'copying',
+            benchmarks = await bench("", {
+                replica: config.toolchain?.["pocket-ic"] ? "pocket-ic" : "dfx",
+                gc: "copying",
                 forceGc: true,
                 silent: true,
             });
         }
         catch (err) {
             console.error(err);
-            console.log(chalk.red('Error: ') + 'benchmarks failed');
+            console.log(chalk.red("Error: ") + "benchmarks failed");
             process.exit(1);
         }
     }
@@ -296,8 +312,8 @@ export async function publish(options = {}) {
     let actor = await mainActor(identity);
     progress();
     let publishing = await actor.startPublish(backendPkgConfig);
-    if ('err' in publishing) {
-        console.log(chalk.red('Error: ') + publishing.err);
+    if ("err" in publishing) {
+        console.log(chalk.red("Error: ") + publishing.err);
         process.exit(1);
     }
     let puiblishingId = publishing.ok;
@@ -332,8 +348,8 @@ export async function publish(options = {}) {
             file = path.basename(file);
         }
         let res = await actor.startFileUpload(puiblishingId, file, BigInt(chunkCount), firstChunk);
-        if ('err' in res) {
-            console.log(chalk.red('Error: ') + res.err);
+        if ("err" in res) {
+            console.log(chalk.red("Error: ") + res.err);
             process.exit(1);
         }
         let fileId = res.ok;
@@ -341,27 +357,31 @@ export async function publish(options = {}) {
             let start = i * chunkSize;
             let chunk = Array.from(content.slice(start, start + chunkSize));
             let res = await actor.uploadFileChunk(puiblishingId, fileId, BigInt(i), chunk);
-            if ('err' in res) {
-                console.log(chalk.red('Error: ') + res.err);
+            if ("err" in res) {
+                console.log(chalk.red("Error: ") + res.err);
                 process.exit(1);
             }
         }
     });
-    fs.rmSync(path.join(rootDir, '.mops/.docs'), { force: true, recursive: true });
+    fs.rmSync(path.join(rootDir, ".mops/.docs"), {
+        force: true,
+        recursive: true,
+    });
     // finish
     progress();
     logUpdate.done();
     let res = await actor.finishPublish(puiblishingId);
-    if ('err' in res) {
-        console.log(chalk.red('Error: ') + res.err);
+    if ("err" in res) {
+        console.log(chalk.red("Error: ") + res.err);
         process.exit(1);
     }
-    console.log(chalk.green('Published ') + `${config.package.name}@${config.package.version}`);
+    console.log(chalk.green("Published ") +
+        `${config.package.name}@${config.package.version}`);
 }
 function parseChangelog(version) {
     let rootDir = getRootDir();
-    let changelogFile = '';
-    let files = ['CHANGELOG.md', 'Changelog.md', 'changelog.md'];
+    let changelogFile = "";
+    let files = ["CHANGELOG.md", "Changelog.md", "changelog.md"];
     for (let file of files) {
         if (fs.existsSync(path.join(rootDir, file))) {
             changelogFile = path.join(rootDir, file);
@@ -369,26 +389,26 @@ function parseChangelog(version) {
         }
     }
     if (!changelogFile) {
-        console.log(chalk.yellow('CHANGELOG.md not found'));
-        return '';
+        console.log(chalk.yellow("CHANGELOG.md not found"));
+        return "";
     }
-    let str = fs.readFileSync(changelogFile, 'utf-8');
+    let str = fs.readFileSync(changelogFile, "utf-8");
     let changelog = findChangelogEntry(str, version);
     if (!changelog) {
-        console.log(chalk.yellow('No changelog entry found'));
+        console.log(chalk.yellow("No changelog entry found"));
     }
-    return changelog || '';
+    return changelog || "";
 }
 async function fetchGitHubReleaseNotes(repo, version) {
     let repoPath = new URL(repo).pathname;
     let res = await fetch(`https://api.github.com/repos${repoPath}/releases/tags/${version}`);
     let release = await res.json();
-    if (release.message === 'Not Found') {
+    if (release.message === "Not Found") {
         res = await fetch(`https://api.github.com/repos${repoPath}/releases/tags/v${version}`);
         release = await res.json();
-        if (release.message === 'Not Found') {
+        if (release.message === "Not Found") {
             console.log(chalk.yellow(`No GitHub release found with name ${version} or v${version}`));
-            return '';
+            return "";
         }
     }
     return release.body;

package/dist/commands/remove.d.ts

@@ -2,7 +2,7 @@ type RemoveOptions = {
     verbose?: boolean;
     dev?: boolean;
     dryRun?: boolean;
-    lock?: 'update' | 'ignore';
+    lock?: "update" | "ignore";
 };
 export declare function remove(name: string, { dev, verbose, dryRun, lock }?: RemoveOptions): Promise<void>;
 export {};

package/dist/commands/remove.js

@@ -1,26 +1,31 @@
-import fs from 'node:fs';
-import { deleteSync } from 'del';
-import chalk from 'chalk';
-import { checkConfigFile, getRootDir, readConfig, writeConfig } from '../mops.js';
-import { checkIntegrity } from '../integrity.js';
-import { getDepCacheDir, getDepCacheName } from '../cache.js';
-import path from 'node:path';
-import { syncLocalCache } from './install/sync-local-cache.js';
-import { getPackageId } from '../helpers/get-package-id.js';
+import fs from "node:fs";
+import { deleteSync } from "del";
+import chalk from "chalk";
+import { checkConfigFile, getRootDir, readConfig, writeConfig, } from "../mops.js";
+import { checkIntegrity } from "../integrity.js";
+import { getDepCacheDir, getDepCacheName } from "../cache.js";
+import path from "node:path";
+import { syncLocalCache } from "./install/sync-local-cache.js";
+import { getPackageId } from "../helpers/get-package-id.js";
 export async function remove(name, { dev = false, verbose = false, dryRun = false, lock } = {}) {
     if (!checkConfigFile()) {
         return;
     }
     function getTransitiveDependencies(config, exceptPkgId) {
         let deps = Object.values(config.dependencies || {});
-        let devDeps = Object.values(config['dev-dependencies'] || {});
+        let devDeps = Object.values(config["dev-dependencies"] || {});
         return [...deps, ...devDeps]
             .filter((dep) => {
-            let depId = getPackageId(dep.name, dep.version || '');
+            let depId = getPackageId(dep.name, dep.version || "");
             return depId !== exceptPkgId;
-        }).map((dep) => {
-            return [dep, ...getTransitiveDependenciesOf(dep.name, dep.version, dep.repo)];
-        }).flat();
+        })
+            .map((dep) => {
+            return [
+                dep,
+                ...getTransitiveDependenciesOf(dep.name, dep.version, dep.repo),
+            ];
+        })
+            .flat();
     }
     function getTransitiveDependenciesOf(name, version, repo) {
         let value = version || repo;
@@ -29,42 +34,49 @@ export async function remove(name, { dev = false, verbose = false, dryRun = fals
         }
         let cacheName = getDepCacheName(name, value);
         let pkgDir = getDepCacheDir(cacheName);
-        let configFile = pkgDir + '/mops.toml';
+        let configFile = pkgDir + "/mops.toml";
         if (!fs.existsSync(configFile)) {
-            verbose && console.log('no config', configFile);
+            verbose && console.log("no config", configFile);
             return [];
         }
         let config = readConfig(configFile);
-        let deps = Object.values(config.dependencies || {}).map((dep) => {
+        let deps = Object.values(config.dependencies || {})
+            .map((dep) => {
             return [dep, ...getTransitiveDependenciesOf(dep.name, dep.version)];
-        }).flat();
+        })
+            .flat();
         return deps;
     }
     let config = readConfig();
-    let deps = dev ? config['dev-dependencies'] : config.dependencies;
+    let deps = dev ? config["dev-dependencies"] : config.dependencies;
     deps = deps || {};
     let pkgDetails = deps[name];
     if (!pkgDetails) {
-        return console.log(chalk.red('Error: ') + `No ${dev ? 'dev ' : ''}dependency to remove "${name}"`);
+        return console.log(chalk.red("Error: ") +
+            `No ${dev ? "dev " : ""}dependency to remove "${name}"`);
     }
     let version = pkgDetails.version;
-    let packageId = getPackageId(name, version || '');
+    let packageId = getPackageId(name, version || "");
     // transitive deps ignoring deps of this package
     let transitiveDeps = getTransitiveDependencies(config, packageId);
     let transitiveDepIds = new Set(transitiveDeps.map((dep) => {
-        return getPackageId(dep.name, dep.version || '');
+        return getPackageId(dep.name, dep.version || "");
     }));
     // transitive deps of this package (including itself)
-    let transitiveDepsOfPackage = [pkgDetails, ...getTransitiveDependenciesOf(name, version)];
+    let transitiveDepsOfPackage = [
+        pkgDetails,
+        ...getTransitiveDependenciesOf(name, version),
+    ];
     // remove local cache
     for (let dep of transitiveDepsOfPackage) {
-        let depId = getPackageId(dep.name, dep.version || '');
+        let depId = getPackageId(dep.name, dep.version || "");
         if (transitiveDepIds.has(depId)) {
-            verbose && console.log(`Ignored transitive dependency ${depId} (other deps depend on it)`);
+            verbose &&
+                console.log(`Ignored transitive dependency ${depId} (other deps depend on it)`);
             continue;
         }
-        let cacheName = getDepCacheName(dep.name, dep.version || dep.repo || '');
-        let localCacheDir = path.join(getRootDir(), '.mops', cacheName);
+        let cacheName = getDepCacheName(dep.name, dep.version || dep.repo || "");
+        let localCacheDir = path.join(getRootDir(), ".mops", cacheName);
         if (localCacheDir && fs.existsSync(localCacheDir)) {
             dryRun || deleteSync([localCacheDir], { force: true });
             verbose && console.log(`Removed local cache ${localCacheDir}`);
@@ -74,11 +86,11 @@ export async function remove(name, { dev = false, verbose = false, dryRun = fals
     if (!dev && config.dependencies) {
         delete config.dependencies[name];
     }
-    if (dev && config['dev-dependencies']) {
-        delete config['dev-dependencies'][name];
+    if (dev && config["dev-dependencies"]) {
+        delete config["dev-dependencies"][name];
     }
     dryRun || writeConfig(config);
     await syncLocalCache();
     await checkIntegrity(lock);
-    console.log(chalk.green('Package removed ') + `${name} = "${version}"`);
+    console.log(chalk.green("Package removed ") + `${name} = "${version}"`);
 }