ic-mops 0.9.0 → 0.10.0

package/cli.js

@@ -18,6 +18,7 @@ import {test} from './commands/test.js';
 import {template} from './commands/template.js';
 import {selfUpdate} from './commands/self-update.js';
 import {remove} from './commands/remove.js';
+// import {docs} from './commands/docs.js';
 
 program.name('mops');
 
@@ -90,13 +91,14 @@ program
 program
 	.command('publish')
 	.description('Publish package to the mops registry')
-	.action(async () => {
+	.option('--no-docs', 'Do not generate docs')
+	.action(async (options) => {
 		if (!checkConfigFile()) {
 			process.exit(1);
 		}
 		let compatible = await checkApiCompatibility();
 		if (compatible) {
-			await publish();
+			await publish(options);
 		}
 	});
 
@@ -196,6 +198,17 @@ program
 		await template(options);
 	});
 
+// docs
+// program
+// 	.command('docs')
+// 	.description('Generate documentation (experimental)')
+// 	.action(async () => {
+// 		if (!checkConfigFile()) {
+// 			process.exit(1);
+// 		}
+// 		await docs();
+// 	});
+
 // self update
 program
 	.command('self-update')

package/commands/docs.js

@@ -0,0 +1,84 @@
+import {spawn, execSync} from 'child_process';
+import fs from 'fs';
+import path from 'path';
+import chalk from 'chalk';
+import glob from 'glob';
+import del from 'del';
+import tar from 'tar';
+import streamToPromise from 'stream-to-promise';
+
+import {getRootDir} from '../mops.js';
+
+let moDoc;
+
+export async function docs({silent} = {}) {
+	let rootDir = getRootDir();
+	let docsDir = path.join(rootDir, '.mops/_docs');
+	let docsDirRelative = path.relative(process.cwd(), path.join(rootDir, '.mops/_docs'));
+
+	del.sync([docsDir], {force: true});
+
+	// detect mocv
+	if (process.env.DFX_MOC_PATH && process.env.DFX_MOC_PATH.includes('mocv/versions')) {
+		moDoc = process.env.DFX_MOC_PATH.replace(/\/moc$/, '/mo-doc');
+	}
+	else {
+		moDoc = execSync('dfx cache show').toString().trim() + '/mo-doc';
+	}
+
+	// generate docs
+	await new Promise((resolve) => {
+		let proc = spawn(moDoc, [`--source=${path.join(rootDir, 'src')}`, `--output=${docsDirRelative}`, '--format=adoc']);
+
+		// stdout
+		proc.stdout.on('data', (data) => {
+			let text = data.toString().trim();
+			silent || console.log('stdout', text);
+		});
+
+		// stderr
+		let stderr = '';
+		proc.stderr.on('data', (data) => {
+			let text = data.toString().trim();
+			if (text.includes('syntax error')) {
+				console.log(chalk.red('Error:'), text);
+				process.exit(1);
+			}
+			if (text.includes('No such file or directory') || text.includes('Couldn\'t find a module expression')) {
+				silent || console.log(text);
+				return;
+			}
+			stderr += text;
+		});
+
+		// exit
+		proc.on('exit', (code) => {
+			// if no source files found
+			if (code === 2 && !stderr) {
+				resolve();
+				return;
+			}
+			if (code !== 0) {
+				console.log(chalk.red('Error:'), code, stderr);
+				process.exit(1);
+			}
+			resolve();
+		});
+	});
+
+	// create archive
+	let files = glob.sync(`${docsDir}/**/*.adoc`).map(f => path.relative(docsDir, f));
+	if (files.length) {
+		let stream = tar.create(
+			{
+				cwd: docsDir,
+				gzip: true,
+				portable: true,
+			},
+			files
+		).pipe(fs.createWriteStream(path.join(docsDir, 'docs.tgz')));
+		await streamToPromise(stream);
+	}
+
+	silent || console.log(`${chalk.green('Documentation generated')} at ${docsDirRelative}`);
+}

package/commands/mmf1.js

@@ -28,10 +28,10 @@ export class MMF1 {
 
 	_testStart(name) {
 		if (this.stack.length) {
-			let suite = this.stack.at(-1);
+			let suite = this.stack[this.stack.length - 1];
 			if (this.currSuite !== suite) {
 				this.currSuite = suite;
-				console.log(' '.repeat((this.stack.length - 1) * 2), (chalk.gray('•')) + '', this.stack.at(-1));
+				console.log(' '.repeat((this.stack.length - 1) * 2), (chalk.gray('•')) + '', suite);
 			}
 		}
 		this.stack.push(name);

package/commands/publish.js

@@ -1,18 +1,21 @@
 import fs from 'fs';
+import path from 'path';
 import chalk from 'chalk';
 import logUpdate from 'log-update';
 import {Principal} from '@dfinity/principal';
 import {globbySync} from 'globby';
 import minimatch from 'minimatch';
 import prompts from 'prompts';
-import {checkConfigFile, getIdentity, mainActor, progressBar, readConfig} from '../mops.js';
+import {checkConfigFile, getIdentity, getRootDir, mainActor, progressBar, readConfig} from '../mops.js';
 import {parallel} from '../parallel.js';
+import {docs} from './docs.js';
 
-export async function publish() {
+export async function publish({noDocs} = {}) {
 	if (!checkConfigFile()) {
 		return;
 	}
 
+	let rootDir = getRootDir();
 	let config = readConfig();
 
 	// validate
@@ -178,6 +181,15 @@ export async function publish() {
 	files = [...files, ...defaultFiles];
 	files = globbySync([...files, ...defaultFiles]);
 
+	// generate docs
+	let docsFile = path.join(rootDir, '.mops/_docs/docs.tgz');
+	if (!noDocs) {
+		await docs({silent: true});
+		if (fs.existsSync(docsFile)) {
+			files.unshift(docsFile);
+		}
+	}
+
 	// check required files
 	if (!files.includes('mops.toml')) {
 		console.log(chalk.red('Error: ') + ' please add mops.toml file');
@@ -190,7 +202,7 @@ export async function publish() {
 
 	// check allowed exts
 	for (let file of files) {
-		if (!minimatch(file, '**/*.{mo,did,md,toml}') && !file.toLowerCase().endsWith('license')) {
+		if (!minimatch(file, '**/*.{mo,did,md,toml}') && !file.toLowerCase().endsWith('license') && file !== docsFile) {
 			console.log(chalk.red('Error: ') + `file ${file} has unsupported extension. Allowed: .mo, .did, .md, .toml`);
 			return;
 		}
@@ -223,6 +235,11 @@ export async function publish() {
 		let chunkCount = Math.ceil(content.length / chunkSize);
 		let firstChunk = Array.from(content.slice(0, chunkSize));
 
+		// remove path from docs file
+		if (file === docsFile) {
+			file = path.basename(file);
+		}
+
 		let res = await actor.startFileUpload(puiblishingId, file, chunkCount, firstChunk);
 		if (res.err) {
 			console.log(chalk.red('Error: ') + res.err);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "ic-mops",
-	"version": "0.9.0",
+	"version": "0.10.0",
 	"type": "module",
 	"bin": {
 		"mops": "cli.js"
@@ -46,6 +46,8 @@
 		"ncp": "^2.0.0",
 		"node-fetch": "^3.3.0",
 		"pem-file": "^1.0.1",
-		"prompts": "^2.4.2"
+		"prompts": "^2.4.2",
+		"stream-to-promise": "^3.0.0",
+		"tar": "^6.1.13"
 	}
 }

package/templates/mops-test.yml

@@ -18,7 +18,7 @@ jobs:
           node-version: 18
       - uses: aviate-labs/setup-dfx@v0.2.3
         with:
-          dfx-version: 0.13.0
+          dfx-version: 0.13.1
 
       - name: install dfx
         run: dfx cache install

package/commands/uninstall.js

@@ -1,55 +0,0 @@
-import {checkConfigFile, readConfig} from '../mops.js';
-import fs from 'fs';
-import del from 'del';
-import chalk from 'chalk';
-import {formatDir, formatGithubDir} from '../mops.js';
-
-export async function uninstall(pkg, version) {
-	if (!checkConfigFile()) {
-		return;
-	}
-
-	// TODO: check if deps relate on this package
-	const config = readConfig();
-
-	const pkgDetails = config.dependencies[pkg];
-
-	if (!pkgDetails) {
-		console.log(`No dependency to remove ${pkg} = "${version}"`);
-		return;
-	}
-
-	const {repo} = pkgDetails;
-	let pkgDir;
-
-	if (repo) {
-		pkgDir = formatGithubDir(pkg, repo);
-	}
-	else {
-		pkgDir = formatDir(pkg, version);
-	}
-
-	if (!fs.existsSync(pkgDir)) {
-		console.log(`No cache to remove ${pkg} = "${version}"`);
-		return;
-	}
-
-	// don't remove if there are dependents
-	// let dependents = getDependents(pkg, version);
-	// if (dependents.length) {
-	// 	console.log(`Cache left ${pkg} = "${version}" (dependents: ${dependents})`)
-	// 	return;
-	// }
-
-	del.sync([`${pkgDir}/**`]);
-
-	console.log(chalk.green('Package removed ') + `${pkg} = "${version}"`);
-
-	// remove dependencies
-	// let text = fs.readFileSync(path.join(pkgDir, 'mops.toml')).toString();
-	// let config = TOML.parse(text);
-
-	// for (let [name, version] of Object.entries(config.dependencies)) {
-	// 	remove(name, version);
-	// }
-}