ic-mops 1.8.1 → 1.9.0

package/bundle/declarations/main/main.did

@@ -218,6 +218,7 @@ type PackageSummary =
 type PackageQuality = 
  record {
    depsStatus: DepsStatus;
+   docsCoverage: float64;
    hasDescription: bool;
    hasDocumentation: bool;
    hasKeywords: bool;
@@ -249,6 +250,7 @@ type PackageDetails =
    dependents: vec PackageSummary__1;
    deps: vec PackageSummary__1;
    devDeps: vec PackageSummary__1;
+   docsCoverage: float64;
    downloadTrend: vec DownloadsSnapshot;
    downloadsInLast30Days: nat;
    downloadsInLast7Days: nat;
@@ -308,10 +310,12 @@ type PackageConfigV3 =
 type PackageChanges = 
  record {
    curBenchmarks: Benchmarks__1;
+   curDocsCoverage: float64;
    deps: vec DepChange;
    devDeps: vec DepChange;
    notes: text;
    prevBenchmarks: Benchmarks__1;
+   prevDocsCoverage: float64;
    tests: TestsChanges;
  };
 type Main = 
@@ -379,11 +383,13 @@ type Main =
    removeOwner: (PackageName__1, principal) -> (Result_3);
    restore: (nat) -> ();
    search: (Text, opt nat, opt nat) -> (vec PackageSummary, PageCount) query;
+   setStorageControllers: () -> ();
    setUserProp: (text, text) -> (Result_3);
    startFileUpload: (PublishingId, Text, nat, blob) -> (Result_2);
    startPublish: (PackageConfigV3_Publishing) -> (Result_1);
    transformRequest: (HttpTransformArg) -> (HttpResponse) query;
    uploadBenchmarks: (PublishingId, Benchmarks) -> (Result);
+   uploadDocsCoverage: (PublishingId, float64) -> (Result);
    uploadFileChunk: (PublishingId, FileId, nat, blob) -> (Result);
    uploadNotes: (PublishingId, text) -> (Result);
    uploadTestStats: (PublishingId, TestStats) -> (Result);

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

@@ -124,6 +124,7 @@ export interface Main {
     [Text, [] | [bigint], [] | [bigint]],
     [Array<PackageSummary>, PageCount]
   >,
+  'setStorageControllers' : ActorMethod<[], undefined>,
   'setUserProp' : ActorMethod<[string, string], Result_3>,
   'startFileUpload' : ActorMethod<
     [PublishingId, Text, bigint, Uint8Array | number[]],
@@ -132,6 +133,7 @@ export interface Main {
   'startPublish' : ActorMethod<[PackageConfigV3_Publishing], Result_1>,
   'transformRequest' : ActorMethod<[HttpTransformArg], HttpResponse>,
   'uploadBenchmarks' : ActorMethod<[PublishingId, Benchmarks], Result>,
+  'uploadDocsCoverage' : ActorMethod<[PublishingId, number], Result>,
   'uploadFileChunk' : ActorMethod<
     [PublishingId, FileId, bigint, Uint8Array | number[]],
     Result
@@ -143,8 +145,10 @@ export interface PackageChanges {
   'tests' : TestsChanges,
   'deps' : Array<DepChange>,
   'curBenchmarks' : Benchmarks__1,
+  'prevDocsCoverage' : number,
   'prevBenchmarks' : Benchmarks__1,
   'notes' : string,
+  'curDocsCoverage' : number,
   'devDeps' : Array<DepChange>,
 }
 export interface PackageConfigV3 {
@@ -196,6 +200,7 @@ export interface PackageDetails {
   'quality' : PackageQuality,
   'publisher' : User,
   'testStats' : TestStats__1,
+  'docsCoverage' : number,
   'highestVersion' : PackageVersion,
   'downloadsTotal' : bigint,
   'downloadsInLast30Days' : bigint,
@@ -223,6 +228,7 @@ export interface PackagePublication {
 }
 export interface PackageQuality {
   'depsStatus' : DepsStatus,
+  'docsCoverage' : number,
   'hasDescription' : boolean,
   'hasKeywords' : boolean,
   'hasLicense' : boolean,

package/bundle/declarations/main/main.did.js

@@ -48,6 +48,7 @@ export const idlFactory = ({ IDL }) => {
   });
   const PackageQuality = IDL.Record({
     'depsStatus' : DepsStatus,
+    'docsCoverage' : IDL.Float64,
     'hasDescription' : IDL.Bool,
     'hasKeywords' : IDL.Bool,
     'hasLicense' : IDL.Bool,
@@ -161,8 +162,10 @@ export const idlFactory = ({ IDL }) => {
     'tests' : TestsChanges,
     'deps' : IDL.Vec(DepChange),
     'curBenchmarks' : Benchmarks__1,
+    'prevDocsCoverage' : IDL.Float64,
     'prevBenchmarks' : Benchmarks__1,
     'notes' : IDL.Text,
+    'curDocsCoverage' : IDL.Float64,
     'devDeps' : IDL.Vec(DepChange),
   });
   const PackageSummaryWithChanges__1 = IDL.Record({
@@ -192,6 +195,7 @@ export const idlFactory = ({ IDL }) => {
     'quality' : PackageQuality,
     'publisher' : User,
     'testStats' : TestStats__1,
+    'docsCoverage' : IDL.Float64,
     'highestVersion' : PackageVersion,
     'downloadsTotal' : IDL.Nat,
     'downloadsInLast30Days' : IDL.Nat,
@@ -428,6 +432,7 @@ export const idlFactory = ({ IDL }) => {
         [IDL.Vec(PackageSummary), PageCount],
         ['query'],
       ),
+    'setStorageControllers' : IDL.Func([], [], []),
     'setUserProp' : IDL.Func([IDL.Text, IDL.Text], [Result_3], []),
     'startFileUpload' : IDL.Func(
         [PublishingId, Text, IDL.Nat, IDL.Vec(IDL.Nat8)],
@@ -441,6 +446,7 @@ export const idlFactory = ({ IDL }) => {
         ['query'],
       ),
     'uploadBenchmarks' : IDL.Func([PublishingId, Benchmarks], [Result], []),
+    'uploadDocsCoverage' : IDL.Func([PublishingId, IDL.Float64], [Result], []),
     'uploadFileChunk' : IDL.Func(
         [PublishingId, FileId, IDL.Nat, IDL.Vec(IDL.Nat8)],
         [Result],

package/bundle/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ic-mops",
-  "version": "1.7.2",
+  "version": "1.9.0",
   "type": "module",
   "bin": {
     "mops": "bin/mops.js",

package/bundle/templates/src/lib.mo

@@ -1,15 +1,15 @@
 module {
-	// This comment will not be included in the documentation
-	// Use triple slash for documentation
+  // This comment will not be included in the documentation
+  // Use triple slash for documentation
 
-	/// Add two natural numbers
-	///
-	/// Example:
-	/// ```motoko
-	/// assert add(1, 2) == 3;
-	/// assert add(7, 3) == 10;
-	/// ```
-	public func add(x : Nat, y : Nat) : Nat {
-		return x + y;
-	};
-};
+  /// Add two natural numbers
+  ///
+  /// Example:
+  /// ```motoko
+  /// assert add(1, 2) == 3;
+  /// assert add(7, 3) == 10;
+  /// ```
+  public func add(x : Nat, y : Nat) : Nat {
+    return x + y;
+  };
+};

package/bundle/templates/test/lib.test.mo

@@ -1,4 +1,4 @@
-import {add} "../src";
+import { add } "../src";
 
 assert add(1, 2) == 3;
-assert add(3, 22) == 25;
+assert add(3, 22) == 25;

package/bundle/xhr-sync-worker.js

@@ -0,0 +1,59 @@
+"use strict";
+const util = require("util");
+const { JSDOM } = require("../../../..");
+const { READY_STATES } = require("./xhr-utils");
+const idlUtils = require("../generated/utils");
+const tough = require("tough-cookie");
+
+const dom = new JSDOM();
+const xhr = new dom.window.XMLHttpRequest();
+const xhrImpl = idlUtils.implForWrapper(xhr);
+
+const chunks = [];
+
+process.stdin.on("data", chunk => {
+  chunks.push(chunk);
+});
+
+process.stdin.on("end", () => {
+  const buffer = Buffer.concat(chunks);
+
+  const flag = JSON.parse(buffer.toString());
+  if (flag.body && flag.body.type === "Buffer" && flag.body.data) {
+    flag.body = Buffer.from(flag.body.data);
+  }
+  if (flag.cookieJar) {
+    flag.cookieJar = tough.CookieJar.fromJSON(flag.cookieJar);
+  }
+
+  flag.synchronous = false;
+  Object.assign(xhrImpl.flag, flag);
+  const { properties } = xhrImpl;
+  xhrImpl.readyState = READY_STATES.OPENED;
+  try {
+    xhr.addEventListener("loadend", () => {
+      if (properties.error) {
+        properties.error = properties.error.stack || util.inspect(properties.error);
+      }
+      process.stdout.write(JSON.stringify({
+        responseURL: xhrImpl.responseURL,
+        status: xhrImpl.status,
+        statusText: xhrImpl.statusText,
+        properties
+      }), () => {
+        process.exit(0);
+      });
+    }, false);
+    xhr.send(flag.body);
+  } catch (error) {
+    properties.error += error.stack || util.inspect(error);
+    process.stdout.write(JSON.stringify({
+      responseURL: xhrImpl.responseURL,
+      status: xhrImpl.status,
+      statusText: xhrImpl.statusText,
+      properties
+    }), () => {
+      process.exit(0);
+    });
+  }
+});

package/cli.ts

@@ -30,6 +30,8 @@ import {watch} from './commands/watch/watch.js';
 import {addOwner, printOwners, removeOwner} from './commands/owner.js';
 import {addMaintainer, printMaintainers, removeMaintainer} from './commands/maintainer.js';
 import {format} from './commands/format.js';
+import {docs} from './commands/docs.js';
+import {docsCoverage} from './commands/docs-coverage.js';
 
 declare global {
 	// eslint-disable-next-line no-var
@@ -494,4 +496,30 @@ program
 		}
 	});
 
+// docs
+const docsCommand = new Command('docs').description('Documentation management');
+
+docsCommand
+	.command('generate')
+	.description('Generate documentation for Motoko code')
+	.addOption(new Option('--source <source>', 'Source directory').default('src'))
+	.addOption(new Option('--output <output>', 'Output directory').default('docs'))
+	.addOption(new Option('--format <format>', 'Output format').default('md').choices(['md', 'adoc', 'html']))
+	.action(async (options) => {
+		checkConfigFile(true);
+		await docs(options);
+	});
+
+docsCommand
+	.command('coverage')
+	.description('Documentation coverage report')
+	.addOption(new Option('-s, --source <source>', 'Source directory (with .mo files)').default('src'))
+	.addOption(new Option('-r, --reporter <reporter>', 'Coverage reporter').choices(['files', 'compact', 'missing', 'verbose']).default('files'))
+	.addOption(new Option('-t, --threshold <threshold>', 'Coverage threshold (0-100). If total coverage is below threshold, exit with error code 1').default(70))
+	.action(async (options) => {
+		checkConfigFile(true);
+		await docsCoverage(options);
+	});
+program.addCommand(docsCommand);
+
 program.parse();

package/commands/docs-coverage.ts

@@ -0,0 +1,110 @@
+import {readFileSync} from 'node:fs';
+import chalk from 'chalk';
+import {globSync} from 'glob';
+import {JSDOM} from 'jsdom';
+import {docs} from './docs.js';
+
+export type DocsCoverageReporter = 'compact' | 'files' | 'missing' | 'verbose' | 'silent';
+
+type DocsCoverageOptions = {
+	source : string,
+	reporter : DocsCoverageReporter,
+	threshold : number,
+};
+
+export async function docsCoverage(options : Partial<DocsCoverageOptions> = {}) {
+	let docsDir = '.mops/.docs';
+
+	let {source, reporter, threshold} = {
+		source: 'src',
+		reporter: 'files',
+		threshold: 0,
+		...options,
+	};
+
+	await docs({
+		source,
+		output: docsDir,
+		format: 'html',
+		silent: true,
+	});
+
+	let files = globSync(`${docsDir}/**/*.html`, {ignore: [`${docsDir}/**/index.html`]});
+	let coverages = [];
+
+	for (let file of files) {
+		let coverage = docFileCoverage(file);
+		coverages.push(coverage);
+
+		if (reporter === 'silent') {
+			continue;
+		}
+		if (reporter !== 'compact' && (reporter !== 'missing' || coverage.coverage < 100)) {
+			console.log(`• ${coverage.file} ${colorizeCoverage(coverage.coverage)}`);
+		}
+		if (reporter === 'missing' && coverage.coverage < 100) {
+			for (let item of coverage.items) {
+				if (!item.covered) {
+					console.log(`  ${item.covered ? chalk.green('✓') : chalk.red('✖')} ${item.id} ${chalk.gray(item.type)}`);
+				}
+			}
+		}
+		else if (reporter === 'verbose') {
+			for (let item of coverage.items) {
+				console.log(`  ${item.covered ? chalk.green('✓') : chalk.red('✖')} ${item.id} ${chalk.gray(item.type)}`);
+			}
+		}
+	}
+
+	if (reporter !== 'compact' && reporter !== 'silent') {
+		console.log('-'.repeat(50));
+	}
+
+	let totalCoverage = coverages.reduce((acc, coverage) => acc + coverage.coverage, 0) / (coverages.length || 1);
+	if (reporter !== 'silent') {
+		console.log(`Documentation coverage: ${colorizeCoverage(totalCoverage)}`);
+	}
+
+	if (threshold > 0 && totalCoverage < threshold) {
+		process.exit(1);
+	}
+
+	return totalCoverage;
+}
+
+function docFileCoverage(file : string) {
+	let dom = new JSDOM(readFileSync(file, 'utf-8'));
+
+	let module = dom.window.document.querySelector('h1')?.textContent || '';
+	let moduleFile = `${module}.mo`;
+
+	let items = [...dom.window.document.querySelectorAll('h4')].map(h4 => {
+		let id = h4.getAttribute('id')?.replace('type.', '');
+		let type = h4.className.replace('-declaration', '').replace('function', 'func');
+		let definition = h4.textContent;
+		let comment = h4.parentElement?.querySelector('p + p')?.textContent;
+		return {file: moduleFile, id, type, definition, comment, covered: (comment || '').length >= 5};
+	});
+
+	let coverage = 0;
+	if (!items.length) {
+		coverage = 100;
+	}
+	else {
+		coverage = items.filter(item => item.covered).length / items.length * 100;
+	}
+
+	return {file: moduleFile, coverage, items};
+}
+
+function colorizeCoverage(coverage : number) {
+	if (coverage >= 90) {
+		return chalk.green(coverage.toFixed(2) + '%');
+	}
+	else if (coverage >= 50) {
+		return chalk.yellow(coverage.toFixed(2) + '%');
+	}
+	else {
+		return chalk.red(coverage.toFixed(2) + '%');
+	}
+}

package/commands/docs.ts

@@ -13,9 +13,30 @@ import {toolchain} from './toolchain/index.js';
 
 let moDocPath : string;
 
-export async function docs({silent = false} = {}) {
+type DocsOptions = {
+	source : string,
+	output : string,
+	format : 'md' | 'adoc' | 'html',
+	silent : boolean,
+	archive : boolean,
+};
+
+export async function docs(options : Partial<DocsOptions> = {}) {
+	let {source, output, format, silent, archive} = {
+		source: 'src',
+		output: '.mops/.docs',
+		format: 'adoc',
+		silent: false,
+		archive: false,
+		...options,
+	};
+
+	if (format === 'md') {
+		format = 'plain';
+	}
+
 	let rootDir = getRootDir();
-	let docsDir = path.join(rootDir, '.mops/.docs');
+	let docsDir = path.join(rootDir, output);
 	let docsDirRelative = path.relative(process.cwd(), docsDir);
 
 	deleteSync([docsDir], {force: true});
@@ -32,14 +53,18 @@ export async function docs({silent = false} = {}) {
 
 	// generate docs
 	await new Promise<void>((resolve) => {
-		let proc = spawn(moDocPath, [`--source=${path.join(rootDir, 'src')}`, `--output=${docsDirRelative}`, '--format=adoc']);
+		let proc = spawn(moDocPath, [
+			`--source=${path.join(rootDir, source)}`,
+			`--output=${docsDirRelative}`,
+			`--format=${format}`,
+		]);
 
 		// stdout
 		proc.stdout.on('data', (data) => {
 			let text = data.toString().trim();
 			let failedText = 'Failed to extract documentation';
 			if (text.includes(failedText)) {
-				console.log(text.replaceAll(failedText, chalk.yellow('Warning: ') + failedText));
+				silent ||console.log(text.replaceAll(failedText, chalk.yellow('Warning: ') + failedText));
 			}
 			silent || console.log('stdout', text);
 		});
@@ -75,22 +100,24 @@ export async function docs({silent = false} = {}) {
 	});
 
 	// create archive
-	let ignore = [
-		`${docsDir}/**/*.test.adoc`,
-		`${docsDir}/test/**/*`,
-	];
-	let files = globSync(`${docsDir}/**/*.adoc`, {ignore}).map(f => path.relative(docsDir, f));
-	files.sort();
-	if (files.length) {
-		let stream = createTar(
-			{
-				cwd: docsDir,
-				gzip: true,
-				portable: true,
-			},
-			files
-		).pipe(fs.createWriteStream(path.join(docsDir, 'docs.tgz')));
-		await streamToPromise(stream);
+	if (archive) {
+		let ignore = [
+			`${docsDir}/**/*.test.adoc`,
+			`${docsDir}/test/**/*`,
+		];
+		let files = globSync(`${docsDir}/**/*.adoc`, {ignore}).map(f => path.relative(docsDir, f));
+		files.sort();
+		if (files.length) {
+			let stream = createTar(
+				{
+					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/publish.ts

@@ -17,6 +17,7 @@ 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 : {docs ?: boolean, test ?: boolean, bench ?: boolean, verbose ?: boolean} = {}) {
 	if (!checkConfigFile()) {
@@ -230,9 +231,13 @@ export async function publish(options : {docs ?: boolean, test ?: boolean, bench
 
 	// generate docs
 	let docsFile = path.join(rootDir, '.mops/.docs/docs.tgz');
+	let docsCov = 0;
 	if (options.docs) {
 		console.log('Generating documentation...');
-		await docs({silent: true});
+		docsCov = await docsCoverage({
+			reporter: 'silent',
+		});
+		await docs({silent: true, archive: true});
 		if (fs.existsSync(docsFile)) {
 			files.unshift(docsFile);
 		}
@@ -336,6 +341,11 @@ export async function publish(options : {docs ?: boolean, test ?: boolean, bench
 		await actor.uploadNotes(puiblishingId, changelog);
 	}
 
+	// upload docs coverage
+	if (options.docs) {
+		await actor.uploadDocsCoverage(puiblishingId, docsCov);
+	}
+
 	// upload files
 	await parallel(8, files, async (file : string) => {
 		progress();

package/declarations/main/main.did

@@ -218,6 +218,7 @@ type PackageSummary =
 type PackageQuality = 
  record {
    depsStatus: DepsStatus;
+   docsCoverage: float64;
    hasDescription: bool;
    hasDocumentation: bool;
    hasKeywords: bool;
@@ -249,6 +250,7 @@ type PackageDetails =
    dependents: vec PackageSummary__1;
    deps: vec PackageSummary__1;
    devDeps: vec PackageSummary__1;
+   docsCoverage: float64;
    downloadTrend: vec DownloadsSnapshot;
    downloadsInLast30Days: nat;
    downloadsInLast7Days: nat;
@@ -308,10 +310,12 @@ type PackageConfigV3 =
 type PackageChanges = 
  record {
    curBenchmarks: Benchmarks__1;
+   curDocsCoverage: float64;
    deps: vec DepChange;
    devDeps: vec DepChange;
    notes: text;
    prevBenchmarks: Benchmarks__1;
+   prevDocsCoverage: float64;
    tests: TestsChanges;
  };
 type Main = 
@@ -379,11 +383,13 @@ type Main =
    removeOwner: (PackageName__1, principal) -> (Result_3);
    restore: (nat) -> ();
    search: (Text, opt nat, opt nat) -> (vec PackageSummary, PageCount) query;
+   setStorageControllers: () -> ();
    setUserProp: (text, text) -> (Result_3);
    startFileUpload: (PublishingId, Text, nat, blob) -> (Result_2);
    startPublish: (PackageConfigV3_Publishing) -> (Result_1);
    transformRequest: (HttpTransformArg) -> (HttpResponse) query;
    uploadBenchmarks: (PublishingId, Benchmarks) -> (Result);
+   uploadDocsCoverage: (PublishingId, float64) -> (Result);
    uploadFileChunk: (PublishingId, FileId, nat, blob) -> (Result);
    uploadNotes: (PublishingId, text) -> (Result);
    uploadTestStats: (PublishingId, TestStats) -> (Result);

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

@@ -124,6 +124,7 @@ export interface Main {
     [Text, [] | [bigint], [] | [bigint]],
     [Array<PackageSummary>, PageCount]
   >,
+  'setStorageControllers' : ActorMethod<[], undefined>,
   'setUserProp' : ActorMethod<[string, string], Result_3>,
   'startFileUpload' : ActorMethod<
     [PublishingId, Text, bigint, Uint8Array | number[]],
@@ -132,6 +133,7 @@ export interface Main {
   'startPublish' : ActorMethod<[PackageConfigV3_Publishing], Result_1>,
   'transformRequest' : ActorMethod<[HttpTransformArg], HttpResponse>,
   'uploadBenchmarks' : ActorMethod<[PublishingId, Benchmarks], Result>,
+  'uploadDocsCoverage' : ActorMethod<[PublishingId, number], Result>,
   'uploadFileChunk' : ActorMethod<
     [PublishingId, FileId, bigint, Uint8Array | number[]],
     Result
@@ -143,8 +145,10 @@ export interface PackageChanges {
   'tests' : TestsChanges,
   'deps' : Array<DepChange>,
   'curBenchmarks' : Benchmarks__1,
+  'prevDocsCoverage' : number,
   'prevBenchmarks' : Benchmarks__1,
   'notes' : string,
+  'curDocsCoverage' : number,
   'devDeps' : Array<DepChange>,
 }
 export interface PackageConfigV3 {
@@ -196,6 +200,7 @@ export interface PackageDetails {
   'quality' : PackageQuality,
   'publisher' : User,
   'testStats' : TestStats__1,
+  'docsCoverage' : number,
   'highestVersion' : PackageVersion,
   'downloadsTotal' : bigint,
   'downloadsInLast30Days' : bigint,
@@ -223,6 +228,7 @@ export interface PackagePublication {
 }
 export interface PackageQuality {
   'depsStatus' : DepsStatus,
+  'docsCoverage' : number,
   'hasDescription' : boolean,
   'hasKeywords' : boolean,
   'hasLicense' : boolean,

package/declarations/main/main.did.js

@@ -48,6 +48,7 @@ export const idlFactory = ({ IDL }) => {
   });
   const PackageQuality = IDL.Record({
     'depsStatus' : DepsStatus,
+    'docsCoverage' : IDL.Float64,
     'hasDescription' : IDL.Bool,
     'hasKeywords' : IDL.Bool,
     'hasLicense' : IDL.Bool,
@@ -161,8 +162,10 @@ export const idlFactory = ({ IDL }) => {
     'tests' : TestsChanges,
     'deps' : IDL.Vec(DepChange),
     'curBenchmarks' : Benchmarks__1,
+    'prevDocsCoverage' : IDL.Float64,
     'prevBenchmarks' : Benchmarks__1,
     'notes' : IDL.Text,
+    'curDocsCoverage' : IDL.Float64,
     'devDeps' : IDL.Vec(DepChange),
   });
   const PackageSummaryWithChanges__1 = IDL.Record({
@@ -192,6 +195,7 @@ export const idlFactory = ({ IDL }) => {
     'quality' : PackageQuality,
     'publisher' : User,
     'testStats' : TestStats__1,
+    'docsCoverage' : IDL.Float64,
     'highestVersion' : PackageVersion,
     'downloadsTotal' : IDL.Nat,
     'downloadsInLast30Days' : IDL.Nat,
@@ -428,6 +432,7 @@ export const idlFactory = ({ IDL }) => {
         [IDL.Vec(PackageSummary), PageCount],
         ['query'],
       ),
+    'setStorageControllers' : IDL.Func([], [], []),
     'setUserProp' : IDL.Func([IDL.Text, IDL.Text], [Result_3], []),
     'startFileUpload' : IDL.Func(
         [PublishingId, Text, IDL.Nat, IDL.Vec(IDL.Nat8)],
@@ -441,6 +446,7 @@ export const idlFactory = ({ IDL }) => {
         ['query'],
       ),
     'uploadBenchmarks' : IDL.Func([PublishingId, Benchmarks], [Result], []),
+    'uploadDocsCoverage' : IDL.Func([PublishingId, IDL.Float64], [Result], []),
     'uploadFileChunk' : IDL.Func(
         [PublishingId, FileId, IDL.Nat, IDL.Vec(IDL.Nat8)],
         [Result],

package/dist/cli.js

@@ -28,6 +28,8 @@ import { watch } from './commands/watch/watch.js';
 import { addOwner, printOwners, removeOwner } from './commands/owner.js';
 import { addMaintainer, printMaintainers, removeMaintainer } from './commands/maintainer.js';
 import { format } from './commands/format.js';
+import { docs } from './commands/docs.js';
+import { docsCoverage } from './commands/docs-coverage.js';
 events.setMaxListeners(20);
 let networkFile = getNetworkFile();
 if (fs.existsSync(networkFile)) {
@@ -426,4 +428,27 @@ program
         process.exit(1);
     }
 });
+// docs
+const docsCommand = new Command('docs').description('Documentation management');
+docsCommand
+    .command('generate')
+    .description('Generate documentation for Motoko code')
+    .addOption(new Option('--source <source>', 'Source directory').default('src'))
+    .addOption(new Option('--output <output>', 'Output directory').default('docs'))
+    .addOption(new Option('--format <format>', 'Output format').default('md').choices(['md', 'adoc', 'html']))
+    .action(async (options) => {
+    checkConfigFile(true);
+    await docs(options);
+});
+docsCommand
+    .command('coverage')
+    .description('Documentation coverage report')
+    .addOption(new Option('-s, --source <source>', 'Source directory (with .mo files)').default('src'))
+    .addOption(new Option('-r, --reporter <reporter>', 'Coverage reporter').choices(['files', 'compact', 'missing', 'verbose']).default('files'))
+    .addOption(new Option('-t, --threshold <threshold>', 'Coverage threshold (0-100). If total coverage is below threshold, exit with error code 1').default(70))
+    .action(async (options) => {
+    checkConfigFile(true);
+    await docsCoverage(options);
+});
+program.addCommand(docsCommand);
 program.parse();