ic-mops 0.3.3 → 0.3.4

package/README.md

@@ -1,16 +1,87 @@
 # MOPS
-CLI tool for [MOPS](https://mops.one)
 
-## Usage
+MOPS is a package manager for the Motoko programming language.
 
-**Install cli**
+See https://mops.one
+
+## Setup
+
+### 1. Check system requirements
+- [Node.js](https://nodejs.org/)
+- [DFX](https://internetcomputer.org/docs/current/developer-docs/quickstart/local-quickstart) >= 0.10.0
+
+### 2. Install CLI tool
 ```
 npm i -g ic-mops
 ```
 
-**Install specific Motoko package**
+## Install Packages
+
+### 1. Configure dfx.json
+Add `mops` as a packtool to your `dfx.json`
+
+```json
+{
+  "defaults": {
+    "build": {
+      "packtool": "mops sources"
+    }
+  }
+}
 ```
-mops i <package_name>
+
+### 2. Initialize
+Run this command in the root directory of your project (where is `dfx.json` placed)
+
 ```
+mops init
+```
+
+### 3. Install Motoko Packages
+Install your favorite packages
+
+```
+mops add <package_name>
+```
+
+### 4. Import Package
+Now you can import installed packages in your Motoko code
+
+```motoko
+import Lib "mo:<package_name>";
+```
+
+## Publish a Package
+
+### 1. Import Identity
+Create new identity to publish packages
 
-For more docs visit https://mops.one
+```
+dfx identity new mops
+```
+
+Import identity into `mops`
+
+```
+mops import-identity -- "$(dfx identity export mops)"
+```
+
+### 2. Initialize
+Run this command in your package root
+
+```
+mops init <your_package_name>
+```
+
+Edit `description` and `repository` fields in `mops.toml` file.
+
+Write your package code in `*.mo` source files in the `src/` directory.
+
+Create `README.md` file with information on how to use your package.
+
+### 3. Publish
+Publish package to the mops registry!
+
+```
+mops publish
+```

package/cli.js

@@ -6,16 +6,14 @@ import {program} from 'commander';
 import chalk from 'chalk';
 
 import {init} from './commands/init.js';
-import {install} from './commands/install.js';
 import {publish} from './commands/publish.js';
 import {importPem} from './commands/import-identity.js';
 import {sources} from './commands/sources.js';
-import {checkApiCompatibility, getHighestVersion, getNetwork, parseGithubURL, readConfig, setNetwork, writeConfig, apiVersion} from './mops.js';
+import {checkApiCompatibility, getNetwork, setNetwork, apiVersion} from './mops.js';
 import {whoami} from './commands/whoami.js';
 import {installAll} from './commands/install-all.js';
-import logUpdate from 'log-update';
-import {installFromGithub} from './vessel.js';
 import {search} from './commands/search.js';
+import {add} from './commands/add.js';
 
 let cwd = process.cwd();
 let configFile = path.join(cwd, 'mops.toml');
@@ -34,103 +32,39 @@ program
 		await init(name);
 	});
 
+// add
+program
+	.command('add <pkg>')
+	.description('Install the package and save it to mops.toml')
+	.option('--verbose')
+	.action(async (pkg, options) => {
+		await add(pkg, options);
+	});
+
 // install
 program
 	.command('install [pkg]')
 	.alias('i')
-	.alias('add')
-	.description('Install package and save it as a dependency in the mops.toml file')
-	.option('--verbose', '')
+	.description('Install all dependencies specified in mops.toml')
+	.option('--verbose')
 	.action(async (pkg, options) => {
-		let config = {};
-		let exists = fs.existsSync(configFile);
-		if (exists) {
-			config = readConfig(configFile);
-		}
-		else {
+		if (!fs.existsSync(configFile)) {
 			console.log(chalk.red('Error: ') + `mops.toml not found. Please run ${chalk.green('mops init')} first`);
 			return;
 		}
-		if (!config.dependencies) {
-			config.dependencies = {};
-		}
 
 		let compatible = await checkApiCompatibility();
 		if (!compatible) {
 			return;
 		}
 
-		if (!pkg) {
-			installAll(options);
-			return;
-		}
-
-		let pkgDetails;
-		let existingPkg = config.dependencies[pkg];
-
-		if (pkg.startsWith('https://github.com') || pkg.split('/') > 1) {
-			const {org, gitName, branch} = parseGithubURL(pkg);
-
-			pkgDetails = {
-				name: parseGithubURL(pkg).gitName,
-				repo: `https://github.com/${org}/${gitName}#${branch}`,
-				version: ''
-			};
-
-			existingPkg = config.dependencies[pkgDetails.name];
-		}
-		else if (!existingPkg || !existingPkg.repo) {
-			let ver;
-			if (pkg.includes('@')) {
-				[pkg, ver] = pkg.split('@');
-			}
-			else {
-				let versionRes = await getHighestVersion(pkg);
-				if (versionRes.err) {
-					console.log(chalk.red('Error: ') + versionRes.err);
-					return;
-				}
-				ver = versionRes.ok;
-			}
-
-			pkgDetails = {
-				name: pkg,
-				repo: '',
-				version:  ver,
-			};
-
-		}
-		else {
-			options.silent || logUpdate(`Installing ${existingPkg.name}@${existingPkg.version} (cache) from Github`);
-			return;
-		}
-
-		const {name, repo, version} = pkgDetails;
-
-		if (repo) {
-			// pkg name conflict with an installed mops pkg
-			if (existingPkg && !existingPkg.repo) {
-				console.log(chalk.red('Error: ') + `Conflicting Package Name '${name}`);
-				console.log('Consider entering the repo url and assigning a new name in the \'mops.toml\' file');
-				return;
-			}
-
-			await installFromGithub(name, repo, {verbose: options.verbose});
+		if (pkg) {
+			console.log(chalk.yellow('Consider using the \'mops add\' command to install a specific package.'));
+			await add(pkg, options);
 		}
 		else {
-			let ok = await install(name, version, {verbose: options.verbose});
-			if (!ok) {
-				return;
-			}
+			await installAll(options);
 		}
-
-		config.dependencies[name] = pkgDetails;
-		writeConfig(config);
-
-		logUpdate.clear();
-		console.log(
-			chalk.green('Package installed ') + `${name} = "${repo || version}"`
-		);
 	});
 
 // publish
@@ -174,7 +108,7 @@ program
 program
 	.command('sources')
 	.description('for dfx packtool')
-	.option('--verbose', '')
+	.option('--verbose')
 	.action(async (options) => {
 		await sources(options);
 	});

package/commands/add.js

@@ -0,0 +1,77 @@
+import chalk from 'chalk';
+import logUpdate from 'log-update';
+import {getHighestVersion, parseGithubURL, readConfig, writeConfig} from '../mops.js';
+import {installFromGithub} from '../vessel.js';
+import {install} from './install.js';
+
+export async function add(pkg, {verbose, silent} = {}) {
+	let config = readConfig();
+	if (!config.dependencies) {
+		config.dependencies = {};
+	}
+
+	let pkgDetails;
+	let existingPkg = config.dependencies[pkg];
+
+	if (pkg.startsWith('https://github.com') || pkg.split('/') > 1) {
+		const {org, gitName, branch} = parseGithubURL(pkg);
+
+		pkgDetails = {
+			name: parseGithubURL(pkg).gitName,
+			repo: `https://github.com/${org}/${gitName}#${branch}`,
+			version: ''
+		};
+
+		existingPkg = config.dependencies[pkgDetails.name];
+	}
+	else if (!existingPkg || !existingPkg.repo) {
+		let ver;
+		if (pkg.includes('@')) {
+			[pkg, ver] = pkg.split('@');
+		}
+		else {
+			let versionRes = await getHighestVersion(pkg);
+			if (versionRes.err) {
+				console.log(chalk.red('Error: ') + versionRes.err);
+				return;
+			}
+			ver = versionRes.ok;
+		}
+
+		pkgDetails = {
+			name: pkg,
+			repo: '',
+			version: ver,
+		};
+
+	}
+	else {
+		silent || logUpdate(`Installing ${existingPkg.name}@${existingPkg.version} (cache) from Github`);
+		return;
+	}
+
+	const {name, repo, version} = pkgDetails;
+
+	if (repo) {
+		// pkg name conflict with an installed mops pkg
+		if (existingPkg && !existingPkg.repo) {
+			console.log(chalk.red('Error: ') + `Conflicting Package Name '${name}`);
+			console.log('Consider entering the repo url and assigning a new name in the \'mops.toml\' file');
+			return;
+		}
+
+		await installFromGithub(name, repo, {verbose: verbose});
+	}
+	else {
+		let ok = await install(name, version, {verbose: verbose});
+		if (!ok) {
+			return;
+		}
+	}
+
+	config.dependencies[name] = pkgDetails;
+	writeConfig(config);
+
+	logUpdate.clear();
+	console.log(chalk.green('Package installed ') + `${name} = "${repo || version}"`);
+}

package/commands/install-all.js

@@ -17,7 +17,10 @@ export async function installAll({verbose} = {}) {
 			await installFromGithub(name, repo, {verbose});
 		}
 		else {
-			await install(name, version, {verbose});
+			let ok = await install(name, version, {verbose});
+			if (!ok) {
+				return;
+			}
 		}
 	}
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "ic-mops",
-	"version": "0.3.3",
+	"version": "0.3.4",
 	"type": "module",
 	"bin": {
 		"mops": "cli.js"