@poetora/cli 0.1.9 → 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;
@@ -27,7 +26,7 @@ export class CliBuilder {
         const updateCommand = new UpdateCommand(this.logger, updateService, this.packageName);
         return (yargs(hideBin(process.argv))
             .scriptName(this.packageName)
-            .version()
+            .version(versionService.getCliVersion())
             .middleware(checkNodeVersion)
             .middleware(suppressConsoleWarnings)
             .command('dev', 'initialize a local preview environment', (yargs) => yargs
@@ -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/services/version.service.d.ts

@@ -4,7 +4,7 @@ export declare class VersionService {
     constructor(packageName?: string);
     parseNodeVersion(): NodeVersion;
     checkNodeVersion(): ValidationResult;
-    getCliVersion(): string | undefined;
+    getCliVersion(): string;
     getClientVersion(): string;
     getVersions(): {
         cli: string | undefined;

package/bin/services/version.service.js

@@ -1,6 +1,8 @@
 import { getClientVersion, LOCAL_LINKED_CLI_VERSION } from '@poetora/previewing';
 import { execSync } from 'child_process';
-import yargs from 'yargs';
+import { readFileSync } from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
 import { InvalidEnvironmentError } from '../errors/index.js';
 import { CLI_CONSTANTS } from '../types/index.js';
 export class VersionService {
@@ -55,19 +57,19 @@ export class VersionService {
         };
     }
     getCliVersion() {
-        const y = yargs();
-        let version;
-        y.showVersion((v) => {
-            version = v;
-            return false;
-        });
         if (process.env.CLI_TEST_MODE === 'true') {
             return 'test-cli';
         }
-        if (version === 'unknown') {
-            version = LOCAL_LINKED_CLI_VERSION;
+        try {
+            const __filename = fileURLToPath(import.meta.url);
+            const __dirname = path.dirname(__filename);
+            const packageJsonPath = path.join(__dirname, '../../package.json');
+            const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf-8'));
+            return packageJson.version;
+        }
+        catch {
+            return LOCAL_LINKED_CLI_VERSION;
         }
-        return version;
     }
     getClientVersion() {
         return getClientVersion().trim();

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.9",
+  "version": "0.1.11",
   "description": "The CLI for Poetora documentation Engine",
   "engines": {
     "node": ">=18.0.0"
@@ -22,6 +22,10 @@
   },
   "main": "./bin/index.js",
   "exports": "./bin/index.js",
+  "files": [
+    "bin",
+    "LICENSE"
+  ],
   "bin": {
     "poet": "bin/index.js",
     "poetora": "bin/index.js"

package/.turbo/turbo-build.log

@@ -1,4 +0,0 @@
-
-> @poetora/cli@0.1.8 build /home/runner/work/poetora/poetora/packages/cli
-> tsc --project tsconfig.build.json
-

package/src/accessibility.ts

@@ -1,180 +0,0 @@
-import Color from 'color';
-
-export const WCAG_STANDARDS = {
-  AA_NORMAL: 4.5,
-  AA_LARGE: 3,
-  AAA_NORMAL: 7,
-  AAA_LARGE: 4.5,
-} as const;
-
-export type ContrastResult = {
-  ratio: number;
-  meetsAA: boolean;
-  meetsAAA: boolean;
-  recommendation: 'pass' | 'warning' | 'fail';
-  message: string;
-};
-
-export function checkColorContrast(
-  foreground: string,
-  background: string,
-  minThreshold: number = WCAG_STANDARDS.AA_NORMAL
-): ContrastResult | null {
-  try {
-    const fg = Color(foreground);
-    const bg = Color(background);
-
-    const ratio = fg.contrast(bg);
-    const level = fg.level(bg);
-
-    const meetsAA = level === 'AA' || level === 'AAA';
-    const meetsAAA = level === 'AAA';
-
-    let recommendation: 'pass' | 'warning' | 'fail';
-    let message: string;
-
-    if (minThreshold !== WCAG_STANDARDS.AA_NORMAL) {
-      if (ratio >= minThreshold) {
-        recommendation = 'pass';
-        message = `Contrast ratio: ${ratio.toFixed(
-          2
-        )}:1 (meets minimum threshold of ${minThreshold}:1)`;
-      } else {
-        recommendation = 'fail';
-        message = `Poor contrast ratio: ${ratio.toFixed(
-          2
-        )}:1 (fails minimum threshold, required: ${minThreshold}:1)`;
-      }
-    } else {
-      if (meetsAAA) {
-        recommendation = 'pass';
-        message = `Excellent contrast ratio: ${ratio.toFixed(2)}:1 (meets WCAG AAA)`;
-      } else if (meetsAA) {
-        recommendation = 'warning';
-        message = `Good contrast ratio: ${ratio.toFixed(
-          2
-        )}:1 (meets WCAG AA, consider AAA for better accessibility)`;
-      } else {
-        recommendation = 'fail';
-        message = `Poor contrast ratio: ${ratio.toFixed(2)}:1 (fails WCAG AA, minimum required: ${
-          WCAG_STANDARDS.AA_NORMAL
-        }:1)`;
-      }
-    }
-
-    return {
-      ratio,
-      meetsAA,
-      meetsAAA,
-      recommendation,
-      message,
-    };
-  } catch {
-    return null;
-  }
-}
-
-export interface AccessibilityCheckResult {
-  primaryContrast: ContrastResult | null;
-  lightContrast: ContrastResult | null;
-  darkContrast: ContrastResult | null;
-  darkOnLightContrast: ContrastResult | null;
-  anchorResults: Array<{
-    name: string;
-    lightContrast: ContrastResult | null;
-    darkContrast: ContrastResult | null;
-  }>;
-  overallScore: 'pass' | 'warning' | 'fail';
-}
-
-export function checkDocsColors(
-  colors: {
-    primary?: string;
-    light?: string;
-    dark?: string;
-  },
-  background: {
-    lightHex: string;
-    darkHex: string;
-  },
-  navigation?: {
-    global?: {
-      anchors?: Array<{
-        anchor: string;
-        color?: {
-          light?: string;
-          dark?: string;
-        };
-      }>;
-    };
-  }
-): AccessibilityCheckResult {
-  const lightBackground = background.lightHex;
-  const darkBackground = background.darkHex;
-
-  const primaryContrast = colors.primary
-    ? checkColorContrast(colors.primary, lightBackground)
-    : null;
-
-  const lightContrast = colors.light ? checkColorContrast(colors.light, darkBackground) : null;
-
-  const darkContrast = colors.dark ? checkColorContrast(colors.dark, darkBackground, 3) : null;
-
-  const darkOnLightContrast = colors.dark
-    ? checkColorContrast(colors.dark, lightBackground, 3)
-    : null;
-
-  const anchorResults: Array<{
-    name: string;
-    lightContrast: ContrastResult | null;
-    darkContrast: ContrastResult | null;
-  }> = [];
-
-  if (navigation?.global?.anchors) {
-    for (const anchor of navigation.global.anchors) {
-      if (anchor.color) {
-        const lightContrast = anchor.color.light
-          ? checkColorContrast(anchor.color.light, lightBackground)
-          : null;
-        const darkContrast = anchor.color.dark
-          ? checkColorContrast(anchor.color.dark, darkBackground)
-          : null;
-
-        anchorResults.push({
-          name: anchor.anchor,
-          lightContrast,
-          darkContrast,
-        });
-      }
-    }
-  }
-
-  const results = [
-    primaryContrast,
-    lightContrast,
-    darkContrast,
-    darkOnLightContrast,
-    ...anchorResults.flatMap((anchor) => [anchor.lightContrast, anchor.darkContrast]),
-  ].filter(Boolean);
-
-  const hasFailure = results.some((result) => result?.recommendation === 'fail');
-  const hasWarning = results.some((result) => result?.recommendation === 'warning');
-
-  let overallScore: 'pass' | 'warning' | 'fail';
-  if (hasFailure) {
-    overallScore = 'fail';
-  } else if (hasWarning) {
-    overallScore = 'warning';
-  } else {
-    overallScore = 'pass';
-  }
-
-  return {
-    primaryContrast,
-    lightContrast,
-    darkContrast,
-    darkOnLightContrast,
-    anchorResults,
-    overallScore,
-  };
-}