ic-mops 0.3.7 → 0.5.0

package/README.md

@@ -32,16 +32,27 @@ 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
 ```
 
 ### 3. Install Motoko Packages
-Use `mops add` to install a specific package and save it to `mops.toml`
+Use `mops add <package_name>` to install a specific package and save it to `mops.toml`
 
 ```
-mops add <package_name>
+mops add base
+```
+
+You can also add packages from GitHub like this
+```
+mops add https://github.com/dfinity/motoko-base
+```
+
+You can also add local packages like this (put source files inside `src` directory)
+```
+mops add ./shared
 ```
 
 Use `mops install` to install all packages specified in `mops.toml`

package/cli.js

@@ -14,6 +14,7 @@ import {whoami} from './commands/whoami.js';
 import {installAll} from './commands/install-all.js';
 import {search} from './commands/search.js';
 import {add} from './commands/add.js';
+import {upgrade} from './commands/upgrade.js';
 
 let cwd = process.cwd();
 let configFile = path.join(cwd, 'mops.toml');
@@ -124,10 +125,17 @@ program
 // search
 program
 	.command('search <text>')
-	.alias('find')
 	.description('Search for packages')
 	.action(async (text) => {
 		await search(text);
 	});
 
+// search
+program
+	.command('upgrade')
+	.description('Upgrade mops CLI to the latest version')
+	.action(async () => {
+		upgrade();
+	});
+
 program.parse();

package/commands/add.js

@@ -1,10 +1,11 @@
+import path from 'path';
 import chalk from 'chalk';
 import logUpdate from 'log-update';
 import {checkConfigFile, getHighestVersion, parseGithubURL, readConfig, writeConfig} from '../mops.js';
 import {installFromGithub} from '../vessel.js';
 import {install} from './install.js';
 
-export async function add(pkg, {verbose, silent} = {}) {
+export async function add(name, {verbose, silent} = {}) {
 	if (!checkConfigFile()) {
 		return false;
 	}
@@ -15,26 +16,37 @@ export async function add(pkg, {verbose, silent} = {}) {
 	}
 
 	let pkgDetails;
-	let existingPkg = config.dependencies[pkg];
+	let existingPkg = config.dependencies[name];
 
-	if (pkg.startsWith('https://github.com') || pkg.split('/') > 1) {
-		const {org, gitName, branch} = parseGithubURL(pkg);
+	// local package
+	if (name.startsWith('./') || name.startsWith('../') || name.startsWith('/')) {
+		pkgDetails = {
+			name: path.parse(name).name === '.' ? '_' : path.parse(name).name,
+			path: name,
+			repo: '',
+			version: '',
+		};
+	}
+	// github package
+	else if (name.startsWith('https://github.com') || name.split('/') > 1) {
+		const {org, gitName, branch} = parseGithubURL(name);
 
 		pkgDetails = {
-			name: parseGithubURL(pkg).gitName,
+			name: parseGithubURL(name).gitName,
 			repo: `https://github.com/${org}/${gitName}#${branch}`,
-			version: ''
+			version: '',
 		};
 
 		existingPkg = config.dependencies[pkgDetails.name];
 	}
+	// mops package
 	else if (!existingPkg || !existingPkg.repo) {
 		let ver;
-		if (pkg.includes('@')) {
-			[pkg, ver] = pkg.split('@');
+		if (name.includes('@')) {
+			[name, ver] = name.split('@');
 		}
 		else {
-			let versionRes = await getHighestVersion(pkg);
+			let versionRes = await getHighestVersion(name);
 			if (versionRes.err) {
 				console.log(chalk.red('Error: ') + versionRes.err);
 				return;
@@ -43,7 +55,7 @@ export async function add(pkg, {verbose, silent} = {}) {
 		}
 
 		pkgDetails = {
-			name: pkg,
+			name: name,
 			repo: '',
 			version: ver,
 		};
@@ -54,28 +66,27 @@ export async function add(pkg, {verbose, silent} = {}) {
 		return;
 	}
 
-	const {name, repo, version} = pkgDetails;
-
-	if (repo) {
+	if (pkgDetails.repo || pkgDetails.path) {
 		// pkg name conflict with an installed mops pkg
 		if (existingPkg && !existingPkg.repo) {
-			console.log(chalk.red('Error: ') + `Conflicting Package Name '${name}`);
+			console.log(chalk.red('Error: ') + `Conflicting Package Name '${pkgDetails.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});
+		if (pkgDetails.repo) {
+			await installFromGithub(pkgDetails.name, pkgDetails.repo, {verbose: verbose});
+		}
 	}
 	else {
-		let ok = await install(name, version, {verbose: verbose});
+		let ok = await install(pkgDetails.name, pkgDetails.version, {verbose: verbose});
 		if (!ok) {
 			return;
 		}
 	}
 
-	config.dependencies[name] = pkgDetails;
+	config.dependencies[pkgDetails.name] = pkgDetails;
 	writeConfig(config);
 
 	logUpdate.clear();
-	console.log(chalk.green('Package installed ') + `${name} = "${repo || version}"`);
+	console.log(chalk.green('Package installed ') + `${pkgDetails.name} = "${pkgDetails.repo || pkgDetails.path || pkgDetails.version}"`);
 }

package/commands/install-all.js

@@ -12,11 +12,11 @@ export async function installAll({verbose} = {}) {
 	let config = readConfig();
 	const deps = Object.values(config.dependencies || {});
 
-	for (let {name, repo, version} of deps) {
+	for (let {name, repo, path, version} of deps) {
 		if (repo) {
 			await installFromGithub(name, repo, {verbose});
 		}
-		else {
+		else if (!path) {
 			let ok = await install(name, version, {verbose});
 			if (!ok) {
 				return;

package/commands/publish.js

@@ -97,9 +97,19 @@ export async function publish() {
 		}
 	}
 
-	if (config.package.dependencies && Object.keys(config.package.dependencies).length > 100) {
-		console.log(chalk.red('Error: ') + 'max dependencies is 100');
-		return;
+	if (config.dependencies) {
+		if (Object.keys(config.dependencies).length > 100) {
+			console.log(chalk.red('Error: ') + 'max dependencies is 100');
+			return;
+		}
+
+		for (let dep of Object.values(config.dependencies)) {
+			if (dep.path) {
+				console.log(chalk.red('Error: ') + 'you can\'t publish packages with local dependencies');
+				return;
+			}
+			delete dep.path;
+		}
 	}
 
 	if (config.package.keywords) {

package/commands/sources.js

@@ -81,12 +81,14 @@ export async function sources({verbose} = {}) {
 				const dir = formatGithubDir(name, repo);
 				nestedConfig = await readVesselConfig(dir) || {};
 			}
-			else {
+			else if (!pkgDetails.path) {
 				const dir = formatDir(name, version) + '/mops.toml';
 				nestedConfig = readConfig(dir);
 			}
 
-			await collectDeps(nestedConfig);
+			if (!pkgDetails.path) {
+				await collectDeps(nestedConfig);
+			}
 
 			if (!versions[name]) {
 				versions[name] = [];
@@ -115,15 +117,28 @@ export async function sources({verbose} = {}) {
 	}
 
 	// sources
-	for (let [name, {repo, version}] of Object.entries(packages)) {
+	for (let [name, pkg] of Object.entries(packages)) {
 		let pkgDir;
-		if (repo) {
-			pkgDir =  path.relative(process.cwd(), formatGithubDir(name, repo)) + '/src';
+		if (pkg.path) {
+			pkgDir = path.relative(process.cwd(), path.resolve(pkg.path));
+		}
+		else if (pkg.repo) {
+			pkgDir = path.relative(process.cwd(), formatGithubDir(name, pkg.repo));
+		}
+		else {
+			pkgDir = path.relative(process.cwd(), formatDir(name, pkg.version));
+		}
+
+		// append baseDir
+		let pkgBaseDir;
+		if (fs.existsSync(path.join(pkgDir, 'mops.toml'))) {
+			let config = readConfig(path.join(pkgDir, 'mops.toml'));
+			pkgBaseDir = path.join(pkgDir, config.package?.baseDir || 'src');
 		}
 		else {
-			pkgDir = path.relative(process.cwd(), formatDir(name, version)) + '/src';
+			pkgBaseDir = path.join(pkgDir, 'src');
 		}
 
-		console.log(`--package ${name} ${pkgDir}`);
+		console.log(`--package ${name} ${pkgBaseDir}`);
 	}
 }

package/commands/upgrade.js

@@ -0,0 +1,6 @@
+import child_process from 'child_process';
+
+export function upgrade() {
+	console.log('Upgrading mops CLI...');
+	child_process.execSync('npm i ic-mops -g', {stdio: 'inherit'});
+}

package/mops.js

@@ -133,6 +133,9 @@ export function readConfig(configFile = path.join(process.cwd(), 'mops.toml')) {
 		if (data.startsWith('https://github.com/')) {
 			deps[name] = {name, repo: data, version: ''};
 		}
+		else if (data.match(/^(\.?\.)?\//)) {
+			deps[name] = {name, repo: '', path: data, version: ''};
+		}
 		else {
 			deps[name] = {name, repo: '', version: data};
 		}
@@ -144,13 +147,8 @@ export function readConfig(configFile = path.join(process.cwd(), 'mops.toml')) {
 export function writeConfig(config, configFile = path.join(process.cwd(), 'mops.toml')) {
 	const deps = config.dependencies || {};
 
-	Object.entries(deps).forEach(([name, {repo, version}]) => {
-		if (repo) {
-			deps[name] = repo;
-		}
-		else {
-			deps[name] = version;
-		}
+	Object.entries(deps).forEach(([name, {repo, path, version}]) => {
+		deps[name] = repo || path || version;
 	});
 
 	fs.writeFileSync(configFile, TOML.stringify(config).trim());

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "ic-mops",
-	"version": "0.3.7",
+	"version": "0.5.0",
 	"type": "module",
 	"bin": {
 		"mops": "cli.js"
@@ -10,6 +10,7 @@
 		"type": "git",
 		"url": "https://github.com/ZenVoich/mops.git"
 	},
+	"author": "Zen Voich <zen.voich@gmail.com>",
 	"dependencies": {
 		"@dfinity/agent": "^0.11.0",
 		"@dfinity/candid": "^0.11.0",