@poetora/cli 0.1.10 → 0.1.11

package/bin/cli-builder.js

@@ -1,10 +1,9 @@
-import chalk from 'chalk';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 import { CheckCommand, DevCommand, InitCommand, LinkCommand, UpdateCommand, } from './commands/index.js';
 import { checkNodeVersion, suppressConsoleWarnings } from './middlewares.js';
 import { AccessibilityCheckService, LinkService, OpenApiCheckService, PortService, TemplateService, UpdateService, VersionService, } from './services/index.js';
-import { ConsoleLogger } from './utils/index.js';
+import { ConsoleLogger, terminate } from './utils/index.js';
 export class CliBuilder {
     packageName;
     logger;
@@ -67,7 +66,7 @@ export class CliBuilder {
             }
             catch (error) {
                 this.logger.error(error instanceof Error ? error.message : 'Unknown error');
-                process.exit(1);
+                await terminate(1);
             }
         })
             .command(['new [directory]', 'init [directory]'], 'Create a new Poetora documentation site', (yargs) => yargs.positional('directory', {
@@ -80,7 +79,7 @@ export class CliBuilder {
             }
             catch (error) {
                 this.logger.error(error instanceof Error ? error.message : 'Unknown error');
-                process.exit(1);
+                await terminate(1);
             }
         })
             .command('openapi-check <filename>', 'check if an OpenAPI spec is valid', (yargs) => yargs
@@ -99,32 +98,47 @@ export class CliBuilder {
                     filename: argv.filename,
                     localSchema: argv.localSchema,
                 });
-                process.exit(0);
+                await terminate(0);
             }
             catch (error) {
                 this.logger.error(error instanceof Error ? error.message : 'Unknown error');
-                process.exit(1);
+                await terminate(1);
             }
         })
             .command(['a11y', 'accessibility-check', 'a11y-check', 'accessibility'], 'check for accessibility issues in documentation', () => undefined, async () => {
             try {
                 const exitCode = await checkCommand.checkAccessibility();
-                process.exit(exitCode);
+                await terminate(exitCode);
             }
             catch (error) {
                 this.logger.error(error instanceof Error ? error.message : 'Unknown error');
-                process.exit(1);
+                await terminate(1);
             }
         })
             .command('broken-links', 'check for invalid internal links', () => undefined, async () => {
             try {
                 const brokenLinks = await linkCommand.checkBrokenLinks();
                 const hasBrokenLinks = Object.keys(brokenLinks).length > 0;
-                process.exit(hasBrokenLinks ? 1 : 0);
+                if (!hasBrokenLinks) {
+                    this.logger.success('no broken links found');
+                    await terminate(0);
+                }
+                const linkCount = Object.values(brokenLinks).flat().length;
+                const fileCount = Object.keys(brokenLinks).length;
+                this.logger.log(`found ${this.logger.highlight?.(linkCount.toString()) ?? linkCount} broken link${linkCount === 1 ? '' : 's'} in ${this.logger.highlight?.(fileCount.toString()) ?? fileCount} file${fileCount === 1 ? '' : 's'}`);
+                this.logger.logNewLine();
+                for (const [filename, links] of Object.entries(brokenLinks)) {
+                    this.logger.logColor(filename, 'cyan');
+                    links.forEach((link) => {
+                        this.logger.logColor(` ⎿  ${link}`, 'gray');
+                    });
+                    this.logger.logNewLine();
+                }
+                await terminate(1);
             }
             catch (error) {
                 this.logger.error(error instanceof Error ? error.message : 'Unknown error');
-                process.exit(1);
+                await terminate(1);
             }
         })
             .command('rename <from> <to>', 'rename a file and update all internal link references', (yargs) => yargs
@@ -149,28 +163,28 @@ export class CliBuilder {
                     to: argv.to,
                     force: argv.force,
                 });
-                process.exit(0);
+                await terminate(0);
             }
             catch (error) {
                 this.logger.error(error instanceof Error ? error.message : 'Unknown error');
-                process.exit(1);
+                await terminate(1);
             }
         })
             .command('update', 'update the CLI to the latest version', () => undefined, async () => {
             try {
                 await updateCommand.run({});
-                process.exit(0);
+                await terminate(0);
             }
             catch (error) {
                 this.logger.error(error instanceof Error ? error.message : 'Unknown error');
-                process.exit(1);
+                await terminate(1);
             }
         })
             .command(['version', 'v'], 'display the current version of the CLI and client', () => undefined, async () => {
             const versions = versionService.getVersions();
-            console.log(`${chalk.bold.green('cli version')} ${versions.cli}`);
-            console.log(`${chalk.bold.green('client version')} ${versions.client}`);
-            process.exit(0);
+            this.logger.logBold(`cli version ${versions.cli}`, 'green');
+            this.logger.logBold(`client version ${versions.client}`, 'green');
+            await terminate(0);
         })
             .strictCommands()
             .demandCommand(1, 'unknown command. see above for the list of supported commands.')

package/bin/services/link.service.js

@@ -8,7 +8,6 @@ export class LinkService {
     async checkBrokenLinks() {
         const brokenLinks = await getBrokenInternalLinks();
         if (brokenLinks.length === 0) {
-            this.logger.success('no broken links found');
             return {};
         }
         const brokenLinksByFile = {};
@@ -22,16 +21,6 @@ export class LinkService {
                 brokenLinksByFile[filename] = [mdxPath.originalPath];
             }
         });
-        const fileCount = Object.keys(brokenLinksByFile).length;
-        this.logger.log(`found ${this.logger.highlight?.(brokenLinks.length.toString()) ?? brokenLinks.length} broken link${brokenLinks.length === 1 ? '' : 's'} in ${this.logger.highlight?.(fileCount.toString()) ?? fileCount} file${fileCount === 1 ? '' : 's'}`);
-        this.logger.logNewLine();
-        for (const [filename, links] of Object.entries(brokenLinksByFile)) {
-            this.logger.logColor(filename, 'cyan');
-            links.forEach((link) => {
-                this.logger.logColor(` ⎿  ${link}`, 'gray');
-            });
-            this.logger.logNewLine();
-        }
         return brokenLinksByFile;
     }
     async renameFile(from, to, force = false) {

package/bin/utils/index.d.ts

@@ -1,2 +1,3 @@
 export * from './console-logger.js';
 export * from './logger.interface.js';
+export * from './terminate.js';

package/bin/utils/index.js

@@ -1,2 +1,3 @@
 export * from './console-logger.js';
 export * from './logger.interface.js';
+export * from './terminate.js';

package/bin/utils/terminate.d.ts

@@ -0,0 +1 @@
+export declare const terminate: (code: number) => Promise<void>;

package/bin/utils/terminate.js

@@ -0,0 +1,4 @@
+export const terminate = async (code) => {
+    await new Promise((resolve) => setTimeout(resolve, 50));
+    process.exit(code);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@poetora/cli",
-  "version": "0.1.10",
+  "version": "0.1.11",
   "description": "The CLI for Poetora documentation Engine",
   "engines": {
     "node": ">=18.0.0"
@@ -49,8 +49,8 @@
     "@poetora/link-rot": "0.0.7",
     "@poetora/prebuild": "0.1.6",
     "@poetora/previewing": "0.1.9",
-    "@poetora/validation": "0.1.6",
-    "@poetora/shared": "0.1.6"
+    "@poetora/shared": "0.1.6",
+    "@poetora/validation": "0.1.6"
   },
   "devDependencies": {
     "@tsconfig/recommended": "1.0.2",