ic-mops 0.23.0 → 0.24.0

package/dist/cli.js

@@ -27,10 +27,11 @@ let packageJson = JSON.parse(fs.readFileSync(new URL('package.json', import.meta
 program.version(`CLI ${packageJson.version}\nAPI ${apiVersion}`, '-v --version');
 // init
 program
-    .command('init [name]')
-    .description('Create mops.toml')
-    .action(async (name) => {
-    await init(name);
+    .command('init')
+    .description('Initialize a new project or package in the current directory')
+    .option('-y, --yes', 'Accept all defaults')
+    .action(async (options) => {
+    await init(options);
 });
 // add
 program
@@ -99,7 +100,7 @@ program
 program
     .command('set-network <network>')
     .alias('sn')
-    .description('Set network local|dev|ic')
+    .description('Set network local|staging|ic')
     .action(async (network) => {
     await setNetwork(network);
     console.log(`Selected '${network}' network`);

package/dist/commands/init.d.ts

@@ -1 +1,3 @@
-export declare function init(name?: string): Promise<void>;
+export declare function init({ yes }?: {
+    yes?: boolean | undefined;
+}): Promise<void>;

package/dist/commands/init.js

@@ -1,59 +1,169 @@
 import { execSync } from 'node:child_process';
 import path from 'node:path';
-import fs from 'node:fs';
+import { existsSync, readFileSync, writeFileSync } from 'node:fs';
 import chalk from 'chalk';
-import { checkApiCompatibility, mainActor, readDfxJson, writeConfig } from '../mops.js';
+import prompts from 'prompts';
+import { checkApiCompatibility, mainActor, writeConfig } from '../mops.js';
 import { installAll } from './install-all.js';
 import { readVesselConfig } from '../vessel.js';
-export async function init(name = '') {
+import { template } from './template.js';
+export async function init({ yes = false } = {}) {
     let configFile = path.join(process.cwd(), 'mops.toml');
-    let exists = fs.existsSync(configFile);
+    let exists = existsSync(configFile);
     if (exists) {
         console.log(chalk.yellow('mops.toml already exists'));
         return;
     }
     console.log('Initializing...');
     let config = {};
+    if (yes) {
+        await applyInit({
+            type: 'project',
+            config,
+            setupWorkflow: true,
+            addTest: false,
+            copyrightOwner: '',
+        });
+        return;
+    }
+    // migrate from vessel
+    let vesselFile = path.join(process.cwd(), 'vessel.dhall');
     let vesselConfig = { dependencies: [], 'dev-dependencies': [] };
-    let deps = {};
-    const vesselFile = path.join(process.cwd(), 'vessel.dhall');
-    if (fs.existsSync(vesselFile)) {
+    if (existsSync(vesselFile)) {
         console.log('Reading vessel.dhall file');
-        const res = await readVesselConfig(process.cwd(), { cache: false });
+        let res = await readVesselConfig(process.cwd(), { cache: false });
         if (res) {
             vesselConfig = { ...res };
         }
     }
     if (vesselConfig.dependencies) {
+        let deps = {};
         deps = {};
         for (const dep of (vesselConfig.dependencies || [])) {
             deps[dep.name] = dep;
         }
+        if (Object.keys(deps).length) {
+            config.dependencies = deps;
+        }
     }
-    // lib mode
-    if (name) {
+    let promptsConfig = {
+        onCancel() {
+            console.log('aborted');
+            process.exit(0);
+        }
+    };
+    // type
+    let { type } = await prompts({
+        type: 'select',
+        name: 'type',
+        message: 'Select type:',
+        choices: [
+            { title: `Project ${chalk.dim('(I just want to use mops packages in my project)')}`, value: 'project' },
+            { title: `Package ${chalk.dim('(I plan to publish this package on mops)')}`, value: 'package' },
+        ],
+    }, promptsConfig);
+    let addTest = false;
+    let copyrightOwner = '';
+    // package details
+    if (type === 'package') {
+        let res = await prompts([
+            {
+                type: 'text',
+                name: 'name',
+                message: 'Enter package name:',
+                initial: '',
+            },
+            {
+                type: 'text',
+                name: 'description',
+                message: 'Enter package description:',
+                initial: '',
+            },
+            {
+                type: 'text',
+                name: 'repository',
+                message: 'Enter package repository url:',
+                initial: '',
+            },
+            {
+                type: 'text',
+                name: 'keywords',
+                message: 'Enter keywords separated by spaces:',
+                initial: '',
+            },
+            {
+                type: 'select',
+                name: 'license',
+                message: 'Choose a license:',
+                choices: [
+                    { title: 'MIT', value: 'MIT' },
+                    { title: 'Apache-2.0', value: 'Apache-2.0' },
+                ],
+                initial: 0,
+            },
+            {
+                type: 'text',
+                name: 'copyrightOwner',
+                message: 'Enter license copyright owner:',
+                initial: '',
+            },
+            {
+                type: 'confirm',
+                name: 'addTest',
+                message: `Add example test file? ${chalk.dim('(test/lib.test.mo)')}`,
+                initial: true,
+            },
+        ], promptsConfig);
         config.package = {
-            name,
-            version: '0.1.0',
-            description: '',
-            repository: '',
+            name: (res.name || '').trim(),
+            version: '1.0.0',
+            description: (res.description || '').trim(),
+            repository: (res.repository || '').trim(),
+            keywords: [...new Set(res.keywords.split(' ').filter(Boolean))],
+            license: (res.license || '').trim(),
         };
-        if (deps) {
-            config.dependencies = deps;
-        }
-        writeConfig(config, configFile);
-        if (Object.keys(config.dependencies || {}).length) {
-            await installAll({ verbose: true });
+        addTest = res.addTest;
+        copyrightOwner = res.copyrightOwner;
+    }
+    // GitHub workflow
+    let { setupWorkflow } = await prompts({
+        type: 'confirm',
+        name: 'setupWorkflow',
+        message: `Setup GitHub workflow? ${chalk.dim('(run `mops test` on push)')}`,
+        initial: true,
+    }, promptsConfig);
+    await applyInit({
+        type,
+        config,
+        setupWorkflow,
+        addTest,
+        copyrightOwner,
+    });
+}
+async function applyInit({ type, config, setupWorkflow, addTest, copyrightOwner }) {
+    // set packtool in dfx.json
+    let dfxJson = path.resolve(process.cwd(), 'dfx.json');
+    let dfxJsonData;
+    if (existsSync(dfxJson)) {
+        let dfxJsonText = readFileSync(dfxJson).toString();
+        dfxJsonData = JSON.parse(dfxJsonText);
+        console.log('Setting packtool in dfx.json...');
+        dfxJsonData.defaults = dfxJsonData.defaults || {};
+        dfxJsonData.defaults.build = dfxJsonData.defaults.build || {};
+        if (dfxJsonData.defaults.build.packtool !== 'mops sources') {
+            dfxJsonData.defaults.build.packtool = 'mops sources';
+            let indent = dfxJsonText.match(/([ \t]+)"/)?.[1] || '  ';
+            writeFileSync(path.join(process.cwd(), 'dfx.json'), JSON.stringify(dfxJsonData, null, indent));
+            console.log(chalk.green('packtool set to "mops sources"'));
         }
     }
-    // project mode
-    if (!name) {
+    // get default packages
+    if (type === 'project') {
         let compatible = await checkApiCompatibility();
         if (!compatible) {
             return;
         }
-        let dfxJson = readDfxJson();
-        let dfxVersion = dfxJson?.dfx || '';
+        let dfxVersion = dfxJsonData?.dfx || '';
         if (!dfxVersion) {
             try {
                 let res = execSync('dfx --version').toString();
@@ -64,19 +174,54 @@ export async function init(name = '') {
             }
             catch { }
         }
+        console.log(`Fetching default packages for dfx ${dfxVersion}...`);
         let actor = await mainActor();
         let defaultPackages = await actor.getDefaultPackages(dfxVersion);
         if (!config.dependencies) {
             config.dependencies = {};
         }
-        if (deps) {
-            config.dependencies = deps;
-        }
         for (let [name, version] of defaultPackages) {
             config.dependencies[name] = { name, version };
         }
-        writeConfig(config, configFile);
+    }
+    // save config
+    let configFile = path.join(process.cwd(), 'mops.toml');
+    writeConfig(config, configFile);
+    console.log(chalk.green('Created'), 'mops.toml');
+    // add src/lib.mo
+    if (type === 'package' && !existsSync(path.join(process.cwd(), 'src'))) {
+        await template('lib.mo');
+    }
+    // add src/lib.test.mo
+    if (addTest && !existsSync(path.join(process.cwd(), 'test'))) {
+        await template('lib.test.mo');
+    }
+    // add license
+    if (config.package?.license) {
+        await template(`license:${config.package.license}`, { copyrightOwner });
+    }
+    // add readme
+    if (type === 'package') {
+        await template('readme');
+    }
+    // add GitHub workflow
+    if (setupWorkflow) {
+        await template('github-workflow:mops-test');
+    }
+    // add .mops to .gitignore
+    {
+        let gitignore = path.join(process.cwd(), '.gitignore');
+        let gitignoreData = existsSync(gitignore) ? readFileSync(gitignore).toString() : '';
+        let lf = gitignoreData.endsWith('\n') ? '\n' : '';
+        if (!gitignoreData.includes('.mops')) {
+            writeFileSync(gitignore, `${gitignoreData}\n.mops${lf}`.trimStart());
+            console.log(chalk.green('Added'), '.mops to .gitignore');
+        }
+    }
+    // install deps
+    if (Object.keys(config.dependencies || {}).length) {
+        console.log('Installing dependencies...');
         await installAll({ verbose: true });
     }
-    console.log(chalk.green('mops.toml has been created'));
+    console.log(chalk.green('Done!'));
 }

package/dist/commands/template.d.ts

@@ -1 +1 @@
-export declare function template(): Promise<void>;
+export declare function template(templateName?: string, options?: any): Promise<void>;

package/dist/commands/template.js

@@ -2,27 +2,90 @@ import fs from 'node:fs';
 import path from 'node:path';
 import chalk from 'chalk';
 import prompts from 'prompts';
-import { getRootDir } from '../mops.js';
-export async function template() {
-    let res = await prompts({
-        type: 'select',
-        name: 'value',
-        message: 'Select template:',
-        choices: [
-            { title: 'GitHub Workflow to run \'mops test\'', value: 'github-workflow:mops-test' },
-            { title: '× Cancel', value: '' },
-        ],
-        initial: 0,
-    });
-    if (res.value === 'github-workflow:mops-test') {
+import camelCase from 'camelcase';
+import { getRootDir, readConfig } from '../mops.js';
+export async function template(templateName, options = {}) {
+    if (!templateName) {
+        let res = await prompts({
+            type: 'select',
+            name: 'value',
+            message: 'Select template:',
+            choices: [
+                { title: 'README.md', value: 'readme' },
+                { title: 'src/lib.mo', value: 'lib.mo' },
+                { title: 'test/lib.test.mo', value: 'lib.test.mo' },
+                { title: 'License MIT', value: 'license:MIT' },
+                { title: 'License Apache-2.0', value: 'license:Apache-2.0' },
+                { title: 'GitHub Workflow to run \'mops test\'', value: 'github-workflow:mops-test' },
+                { title: '× Cancel', value: '' },
+            ],
+            initial: 0,
+        });
+        templateName = res.value;
+    }
+    if (templateName === 'github-workflow:mops-test') {
         let dest = path.resolve(getRootDir(), '.github/workflows/mops-test.yml');
         if (fs.existsSync(dest)) {
-            console.log(chalk.yellow('Workflow already exists:'), dest);
+            console.log(chalk.yellow('Workflow already exists:'), path.relative(getRootDir(), dest));
             return;
         }
         let mopsTestYml = new URL('../templates/mops-test.yml', import.meta.url);
         fs.mkdirSync(path.resolve(getRootDir(), '.github/workflows'), { recursive: true });
         fs.copyFileSync(mopsTestYml, dest);
-        console.log(chalk.green('Workflow created:'), dest);
+        console.log(chalk.green('Created'), path.relative(getRootDir(), dest));
+    }
+    else if (templateName?.startsWith('license:')) {
+        let dest = path.resolve(getRootDir(), 'LICENSE');
+        if (fs.existsSync(dest)) {
+            console.log(chalk.yellow('LICENSE already exists'));
+            return;
+        }
+        let setYearAndOwner = (file) => {
+            let license = fs.readFileSync(file).toString();
+            license = license.replace(/<year>/g, new Date().getFullYear().toString());
+            if (options.copyrightOwner) {
+                license = license.replace(/<copyright-owner>/g, options.copyrightOwner);
+            }
+            fs.writeFileSync(file, license);
+        };
+        if (templateName === 'license:MIT') {
+            fs.copyFileSync(new URL('../templates/licenses/MIT', import.meta.url), path.resolve(getRootDir(), 'LICENSE'));
+            setYearAndOwner(path.resolve(getRootDir(), 'LICENSE'));
+            console.log(chalk.green('Created'), path.relative(getRootDir(), 'LICENSE'));
+        }
+        else if (templateName === 'license:Apache-2.0') {
+            fs.copyFileSync(new URL('../templates/licenses/Apache-2.0', import.meta.url), path.resolve(getRootDir(), 'LICENSE'));
+            fs.copyFileSync(new URL('../templates/licenses/Apache-2.0-NOTICE', import.meta.url), path.resolve(getRootDir(), 'NOTICE'));
+            setYearAndOwner(path.resolve(getRootDir(), 'NOTICE'));
+            console.log(chalk.green('Created'), path.relative(getRootDir(), 'LICENSE'));
+            console.log(chalk.green('Created'), path.relative(getRootDir(), 'NOTICE'));
+        }
+    }
+    else if (templateName === 'lib.mo') {
+        fs.mkdirSync(path.join(getRootDir(), 'src'), { recursive: true });
+        fs.copyFileSync(new URL('../templates/src/lib.mo', import.meta.url), path.resolve(getRootDir(), 'src/lib.mo'));
+        console.log(chalk.green('Created'), path.relative(getRootDir(), 'src/lib.mo'));
+    }
+    else if (templateName === 'lib.test.mo') {
+        fs.mkdirSync(path.join(getRootDir(), 'test'), { recursive: true });
+        fs.copyFileSync(new URL('../templates/test/lib.test.mo', import.meta.url), path.resolve(getRootDir(), 'test/lib.test.mo'));
+        console.log(chalk.green('Created'), path.relative(getRootDir(), 'test/lib.test.mo'));
+    }
+    else if (templateName === 'readme') {
+        let dest = path.resolve(getRootDir(), 'README.md');
+        if (fs.existsSync(dest)) {
+            console.log(chalk.yellow('README.md already exists'));
+            return;
+        }
+        fs.copyFileSync(new URL('../templates/README.md', import.meta.url), dest);
+        let config = readConfig();
+        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 }));
+        }
+        fs.writeFileSync(dest, data);
+        console.log(chalk.green('Created'), path.relative(getRootDir(), 'README.md'));
     }
 }

package/dist/declarations/main/main.did

@@ -1,5 +1,3 @@
-type Version = text;
-type Ver = text;
 type User__1 = 
  record {
    displayName: text;
@@ -48,7 +46,7 @@ type Result_6 =
 type Result_5 = 
  variant {
    err: Err;
-   ok: Ver;
+   ok: PackageVersion;
  };
 type Result_4 = 
  variant {
@@ -78,6 +76,7 @@ type Result =
 type PublishingId = text;
 type PublishingErr = text;
 type PageCount = nat;
+type PackageVersion = text;
 type PackageSummary__1 = 
  record {
    config: PackageConfigV2__1;
@@ -186,20 +185,21 @@ service : {
   getAirdropAmount: () -> (nat) query;
   getAirdropAmountAll: () -> (nat) query;
   getApiVersion: () -> (Text) query;
-  getDefaultPackages: (text) -> (vec record {
-                                       PackageName__1;
-                                       Version;
-                                     }) query;
+  getDefaultPackages: (text) ->
+   (vec record {
+          PackageName__1;
+          PackageVersion;
+        }) query;
   getDownloadTrendByPackageId: (PackageId) ->
    (vec DownloadsSnapshot__1) query;
   getDownloadTrendByPackageName: (PackageName__1) ->
    (vec DownloadsSnapshot__1) query;
-  getFileIds: (PackageName__1, Ver) -> (Result_6) query;
+  getFileIds: (PackageName__1, PackageVersion) -> (Result_6) query;
   getHighestVersion: (PackageName__1) -> (Result_5) query;
   getMostDownloadedPackages: () -> (vec PackageSummary) query;
   getMostDownloadedPackagesIn7Days: () -> (vec PackageSummary) query;
   getNewPackages: () -> (vec PackageSummary) query;
-  getPackageDetails: (PackageName__1, Ver) -> (Result_4) query;
+  getPackageDetails: (PackageName__1, PackageVersion) -> (Result_4) query;
   getPackagesByCategory: () -> (vec record {
                                       text;
                                       vec PackageSummary;
@@ -212,7 +212,7 @@ service : {
   getTotalDownloads: () -> (nat) query;
   getTotalPackages: () -> (nat) query;
   getUser: (principal) -> (opt User__1) query;
-  notifyInstall: (PackageName__1, Ver) -> () oneway;
+  notifyInstall: (PackageName__1, PackageVersion) -> () oneway;
   search: (Text, opt nat, opt nat) -> (vec PackageSummary, PageCount) query;
   setUserProp: (text, text) -> (Result_3);
   startFileUpload: (PublishingId, Text, nat, blob) -> (Result_2);

package/dist/declarations/main/main.did.d.ts

@@ -94,6 +94,7 @@ export interface PackageSummary__1 {
   'config' : PackageConfigV2__1,
   'publication' : PackagePublication,
 }
+export type PackageVersion = string;
 export type PageCount = bigint;
 export type PublishingErr = string;
 export type PublishingId = string;
@@ -107,7 +108,7 @@ export type Result_3 = { 'ok' : null } |
   { 'err' : string };
 export type Result_4 = { 'ok' : PackageDetails } |
   { 'err' : Err };
-export type Result_5 = { 'ok' : Ver } |
+export type Result_5 = { 'ok' : PackageVersion } |
   { 'err' : Err };
 export type Result_6 = { 'ok' : Array<FileId> } |
   { 'err' : Err };
@@ -144,8 +145,6 @@ export interface User__1 {
   'githubVerified' : boolean,
   'github' : string,
 }
-export type Ver = string;
-export type Version = string;
 export interface _SERVICE {
   'claimAirdrop' : ActorMethod<[Principal], string>,
   'finishPublish' : ActorMethod<[PublishingId], Result>,
@@ -154,7 +153,7 @@ export interface _SERVICE {
   'getApiVersion' : ActorMethod<[], Text>,
   'getDefaultPackages' : ActorMethod<
     [string],
-    Array<[PackageName__1, Version]>
+    Array<[PackageName__1, PackageVersion]>
   >,
   'getDownloadTrendByPackageId' : ActorMethod<
     [PackageId],
@@ -164,12 +163,12 @@ export interface _SERVICE {
     [PackageName__1],
     Array<DownloadsSnapshot__1>
   >,
-  'getFileIds' : ActorMethod<[PackageName__1, Ver], Result_6>,
+  'getFileIds' : ActorMethod<[PackageName__1, PackageVersion], Result_6>,
   'getHighestVersion' : ActorMethod<[PackageName__1], Result_5>,
   'getMostDownloadedPackages' : ActorMethod<[], Array<PackageSummary>>,
   'getMostDownloadedPackagesIn7Days' : ActorMethod<[], Array<PackageSummary>>,
   'getNewPackages' : ActorMethod<[], Array<PackageSummary>>,
-  'getPackageDetails' : ActorMethod<[PackageName__1, Ver], Result_4>,
+  'getPackageDetails' : ActorMethod<[PackageName__1, PackageVersion], Result_4>,
   'getPackagesByCategory' : ActorMethod<
     [],
     Array<[string, Array<PackageSummary>]>
@@ -179,7 +178,7 @@ export interface _SERVICE {
   'getTotalDownloads' : ActorMethod<[], bigint>,
   'getTotalPackages' : ActorMethod<[], bigint>,
   'getUser' : ActorMethod<[Principal], [] | [User__1]>,
-  'notifyInstall' : ActorMethod<[PackageName__1, Ver], undefined>,
+  'notifyInstall' : ActorMethod<[PackageName__1, PackageVersion], undefined>,
   'search' : ActorMethod<
     [Text, [] | [bigint], [] | [bigint]],
     [Array<PackageSummary>, PageCount]

package/dist/declarations/main/main.did.js

@@ -4,7 +4,7 @@ export const idlFactory = ({ IDL }) => {
   const Result = IDL.Variant({ 'ok' : IDL.Null, 'err' : Err });
   const Text = IDL.Text;
   const PackageName__1 = IDL.Text;
-  const Version = IDL.Text;
+  const PackageVersion = IDL.Text;
   const PackageId = IDL.Text;
   const Time = IDL.Int;
   const DownloadsSnapshot__1 = IDL.Record({
@@ -12,10 +12,9 @@ export const idlFactory = ({ IDL }) => {
     'endTime' : Time,
     'downloads' : IDL.Nat,
   });
-  const Ver = IDL.Text;
   const FileId = IDL.Text;
   const Result_6 = IDL.Variant({ 'ok' : IDL.Vec(FileId), 'err' : Err });
-  const Result_5 = IDL.Variant({ 'ok' : Ver, 'err' : Err });
+  const Result_5 = IDL.Variant({ 'ok' : PackageVersion, 'err' : Err });
   const User = IDL.Record({
     'id' : IDL.Principal,
     'emailVerified' : IDL.Bool,
@@ -145,7 +144,7 @@ export const idlFactory = ({ IDL }) => {
     'getApiVersion' : IDL.Func([], [Text], ['query']),
     'getDefaultPackages' : IDL.Func(
         [IDL.Text],
-        [IDL.Vec(IDL.Tuple(PackageName__1, Version))],
+        [IDL.Vec(IDL.Tuple(PackageName__1, PackageVersion))],
         ['query'],
       ),
     'getDownloadTrendByPackageId' : IDL.Func(
@@ -158,7 +157,11 @@ export const idlFactory = ({ IDL }) => {
         [IDL.Vec(DownloadsSnapshot__1)],
         ['query'],
       ),
-    'getFileIds' : IDL.Func([PackageName__1, Ver], [Result_6], ['query']),
+    'getFileIds' : IDL.Func(
+        [PackageName__1, PackageVersion],
+        [Result_6],
+        ['query'],
+      ),
     'getHighestVersion' : IDL.Func([PackageName__1], [Result_5], ['query']),
     'getMostDownloadedPackages' : IDL.Func(
         [],
@@ -172,7 +175,7 @@ export const idlFactory = ({ IDL }) => {
       ),
     'getNewPackages' : IDL.Func([], [IDL.Vec(PackageSummary)], ['query']),
     'getPackageDetails' : IDL.Func(
-        [PackageName__1, Ver],
+        [PackageName__1, PackageVersion],
         [Result_4],
         ['query'],
       ),
@@ -194,7 +197,11 @@ export const idlFactory = ({ IDL }) => {
     'getTotalDownloads' : IDL.Func([], [IDL.Nat], ['query']),
     'getTotalPackages' : IDL.Func([], [IDL.Nat], ['query']),
     'getUser' : IDL.Func([IDL.Principal], [IDL.Opt(User__1)], ['query']),
-    'notifyInstall' : IDL.Func([PackageName__1, Ver], [], ['oneway']),
+    'notifyInstall' : IDL.Func(
+        [PackageName__1, PackageVersion],
+        [],
+        ['oneway'],
+      ),
     'search' : IDL.Func(
         [Text, IDL.Opt(IDL.Nat), IDL.Opt(IDL.Nat)],
         [IDL.Vec(PackageSummary), PageCount],

package/dist/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "ic-mops",
-	"version": "0.23.0",
+	"version": "0.24.0",
 	"type": "module",
 	"bin": {
 		"mops": "dist/cli.js"
@@ -40,6 +40,7 @@
 		"@iarna/toml": "^2.2.5",
 		"as-table": "^1.0.55",
 		"cacheable-request": "10.2.12",
+		"camelcase": "^7.0.1",
 		"chalk": "^5.3.0",
 		"chokidar": "^3.5.3",
 		"commander": "^11.0.0",

package/dist/templates/README.md

@@ -0,0 +1,13 @@
+# <name>
+
+## Install
+```
+mops add <name>
+```
+
+## Usage
+```motoko
+import <import-name> "mo:<name>";
+
+// example...
+```