Add API Documenter and generate API documentation for shared libs (#1216

)

.github/bin/generate-docs/api-documenter.mjs

@@ -2,55 +2,53 @@ import { spawn } from 'child_process';
 import { platform } from 'process';
 import path from 'path';
 import fs from 'fs';
+import { getFiles } from '../util/get-files.mjs';
 
-import { listWorkspaces } from "../list-workspaces/list-workspaces.mjs";
+const packageJSONInfo = JSON.parse(fs.readFileSync('./package.json', 'utf8'));
+if (packageJSONInfo.private) {
+	process.exit(0);
+}
 
-const workspaces = await listWorkspaces();
+const unscopedName = packageJSONInfo.name.replace(/^@[^/]+\//, '');
 
-for (const workspace of workspaces) {
-	await runApiDocumenter(workspace);
+const docsExist = fs.existsSync(path.join('docs', unscopedName + '.api.json'));
+if (!docsExist) {
+	process.exit(0);
 }
 
-async function runApiDocumenter(workspace) {
-	await new Promise((resolve, reject) => {
-		if (workspace.private) {
-			resolve(true);
-
-			return;
+const docsContents = fs.readFileSync(path.join('docs', unscopedName + '.api.json'), 'utf8');
+
+await new Promise((resolve, reject) => {
+	const publishCmd = spawn(
+		'npm',
+		[
+			'exec',
+			'--',
+			'api-documenter',
+			'markdown',
+			'--input-folder',
+			'docs',
+			'--output-folder',
+			'docs',
+		],
+		{
+			stdio: 'inherit',
+			shell: platform === 'win32'
 		}
+	);
 
-		const docsExist = fs.existsSync(path.join(workspace.path, 'docs', workspace.unscopedName + '.api.json'));
-		if (!docsExist) {
-			resolve(true);
-
-			return;
+	publishCmd.on('close', (code) => {
+		if (0 !== code) {
+			reject(new Error(`'api-documenter' exited with code ${code}`));
 		}
 
-		const publishCmd = spawn(
-			'npm',
-			[
-				'exec',
-				'--',
-				'api-documenter',
-				'markdown',
-				'--input-folder',
-				path.join(workspace.path, 'docs'),
-				'--output-folder',
-				path.join(workspace.path, 'api-reference'),
-			],
-			{
-				stdio: 'inherit',
-				shell: platform === 'win32'
-			}
-		);
-
-		publishCmd.on('close', (code) => {
-			if (0 !== code) {
-				reject(new Error(`'npm publish' exited with code ${code} for ${packageName}`));
-				return;
-			}
-
-			resolve(true);
-		});
+		fs.writeFileSync(path.join('docs', unscopedName + '.api.json'), docsContents);
+		resolve();
 	});
+});
+
+for (const file of await getFiles('docs', true)) {
+	const fileContents = fs.readFileSync(file, 'utf8').toString();
+	const cleanFileContents = fileContents.replace(/\r\n/g, "\n");
+	fs.writeFileSync(file, cleanFileContents);
 }

api-extractor.json

@@ -407,6 +407,10 @@
 
 			"ae-forgotten-export": {
 				"logLevel": "error"
+			},
+
+			"ae-internal-missing-underscore": {
+				"logLevel": "none"
 			}
 			//
 			// . . .

knip.json

@@ -122,6 +122,7 @@
 	"ignoreDependencies": [
 		"@babel/core",
 		"@babel/preset-env",
+		"@microsoft/api-documenter",
 		"@stryker-mutator/command-runner",
 		"tslib"
 	]