@poetora/cli 0.1.8 → 0.1.10

package/bin/cli-builder.js

@@ -27,7 +27,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

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@poetora/cli",
-  "version": "0.1.8",
+  "version": "0.1.10",
   "description": "The CLI for Poetora documentation Engine",
   "engines": {
     "node": ">=18.0.0"
@@ -20,7 +20,12 @@
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
+  "main": "./bin/index.js",
   "exports": "./bin/index.js",
+  "files": [
+    "bin",
+    "LICENSE"
+  ],
   "bin": {
     "poet": "bin/index.js",
     "poetora": "bin/index.js"
@@ -44,8 +49,8 @@
     "@poetora/link-rot": "0.0.7",
     "@poetora/prebuild": "0.1.6",
     "@poetora/previewing": "0.1.9",
-    "@poetora/shared": "0.1.6",
-    "@poetora/validation": "0.1.6"
+    "@poetora/validation": "0.1.6",
+    "@poetora/shared": "0.1.6"
   },
   "devDependencies": {
     "@tsconfig/recommended": "1.0.2",

package/.turbo/turbo-build.log

@@ -1,4 +0,0 @@
-
-> @poetora/cli@0.1.7 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,
-  };
-}

package/src/cli-builder.ts

@@ -1,274 +0,0 @@
-import chalk from 'chalk';
-import type { Argv } from 'yargs';
-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 type { DevOptions, OpenApiCheckOptions, RenameOptions } from './types/index.js';
-import type { ILogger } from './utils/index.js';
-import { ConsoleLogger } from './utils/index.js';
-
-/**
- * CLI Builder - Orchestrates all commands using yargs
- */
-export class CliBuilder {
-  private logger: ILogger;
-
-  constructor(private readonly packageName: string = 'poet') {
-    this.logger = new ConsoleLogger();
-  }
-
-  /**
-   * Build and configure the CLI
-   */
-  build(): Argv {
-    // Create services
-    const versionService = new VersionService(this.packageName);
-    const portService = new PortService(this.logger);
-    const templateService = new TemplateService();
-    const openApiCheckService = new OpenApiCheckService(this.logger);
-    const accessibilityCheckService = new AccessibilityCheckService();
-    const linkService = new LinkService(this.logger);
-    const updateService = new UpdateService(this.logger, versionService, this.packageName);
-
-    // Create commands
-    const devCommand = new DevCommand(this.logger, versionService, portService, this.packageName);
-    const initCommand = new InitCommand(this.logger, templateService, this.packageName);
-    const checkCommand = new CheckCommand(
-      this.logger,
-      openApiCheckService,
-      accessibilityCheckService,
-      this.packageName
-    );
-    const linkCommand = new LinkCommand(this.logger, linkService, this.packageName);
-    const updateCommand = new UpdateCommand(this.logger, updateService, this.packageName);
-
-    return (
-      yargs(hideBin(process.argv))
-        .scriptName(this.packageName)
-        .version()
-        .middleware(checkNodeVersion) // Check Node.js version before any command
-        .middleware(suppressConsoleWarnings) // Suppress known console warnings
-        // Dev command
-        .command(
-          'dev',
-          'initialize a local preview environment',
-          (yargs) =>
-            yargs
-              .option('port', {
-                type: 'number',
-                description: 'port to run the preview server on',
-                default: 3000,
-              })
-              .option('open', {
-                type: 'boolean',
-                default: true,
-                description: 'open a local preview in the browser',
-              })
-              .option('local-schema', {
-                type: 'boolean',
-                default: false,
-                hidden: true,
-                description:
-                  'use a locally hosted schema file (note: only https protocol is supported in production)',
-              })
-              .option('client-version', {
-                type: 'string',
-                hidden: true,
-                description: 'the version of the client to use for cli testing',
-              })
-              .option('groups', {
-                type: 'array',
-                description: 'Mock user groups for local development and testing',
-                example: '--groups admin user',
-              })
-              .option('disable-openapi', {
-                type: 'boolean',
-                default: false,
-                description: 'Disable OpenAPI file generation',
-              }),
-          async (argv) => {
-            try {
-              await devCommand.run(argv as DevOptions);
-            } catch (error) {
-              this.logger.error(error instanceof Error ? error.message : 'Unknown error');
-              process.exit(1);
-            }
-          }
-        )
-        // Init/New command
-        .command(
-          ['new [directory]', 'init [directory]'],
-          'Create a new Poetora documentation site',
-          (yargs) =>
-            yargs.positional('directory', {
-              describe: 'The directory to initialize your documentation',
-              type: 'string',
-              default: '.',
-            }),
-          async (argv) => {
-            try {
-              await initCommand.run({ directory: argv.directory as string });
-            } catch (error) {
-              this.logger.error(error instanceof Error ? error.message : 'Unknown error');
-              process.exit(1);
-            }
-          }
-        )
-        // OpenAPI check command
-        .command(
-          'openapi-check <filename>',
-          'check if an OpenAPI spec is valid',
-          (yargs) =>
-            yargs
-              .positional('filename', {
-                describe:
-                  'the filename of the OpenAPI spec (e.g. ./openapi.yaml) or the URL to the OpenAPI spec',
-                type: 'string',
-                demandOption: true,
-              })
-              .option('local-schema', {
-                type: 'boolean',
-                default: false,
-                description:
-                  'use a locally hosted schema file (note: only https protocol is supported in production)',
-              }),
-          async (argv) => {
-            try {
-              await checkCommand.checkOpenApi({
-                filename: argv.filename as string,
-                localSchema: argv.localSchema,
-              } as OpenApiCheckOptions);
-              process.exit(0);
-            } catch (error) {
-              this.logger.error(error instanceof Error ? error.message : 'Unknown error');
-              process.exit(1);
-            }
-          }
-        )
-        // Accessibility check command
-        .command(
-          ['a11y', 'accessibility-check', 'a11y-check', 'accessibility'],
-          'check for accessibility issues in documentation',
-          () => undefined,
-          async () => {
-            try {
-              const exitCode = await checkCommand.checkAccessibility();
-              process.exit(exitCode);
-            } catch (error) {
-              this.logger.error(error instanceof Error ? error.message : 'Unknown error');
-              process.exit(1);
-            }
-          }
-        )
-        // Broken links command
-        .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);
-            } catch (error) {
-              this.logger.error(error instanceof Error ? error.message : 'Unknown error');
-              process.exit(1);
-            }
-          }
-        )
-        // Rename command
-        .command(
-          'rename <from> <to>',
-          'rename a file and update all internal link references',
-          (yargs) =>
-            yargs
-              .positional('from', {
-                describe: 'the file to rename',
-                type: 'string',
-              })
-              .positional('to', {
-                describe: 'the new name for the file',
-                type: 'string',
-              })
-              .demandOption(['from', 'to'])
-              .option('force', {
-                type: 'boolean',
-                default: false,
-                description: 'rename files and skip errors',
-              })
-              .epilog(`example: \`${this.packageName} rename introduction.mdx overview.mdx\``),
-          async (argv) => {
-            try {
-              await linkCommand.renameFile({
-                from: argv.from as string,
-                to: argv.to as string,
-                force: argv.force,
-              } as RenameOptions);
-              process.exit(0);
-            } catch (error) {
-              this.logger.error(error instanceof Error ? error.message : 'Unknown error');
-              process.exit(1);
-            }
-          }
-        )
-        // Update command
-        .command(
-          'update',
-          'update the CLI to the latest version',
-          () => undefined,
-          async () => {
-            try {
-              await updateCommand.run({});
-              process.exit(0);
-            } catch (error) {
-              this.logger.error(error instanceof Error ? error.message : 'Unknown error');
-              process.exit(1);
-            }
-          }
-        )
-        // Version command
-        .command(
-          ['version', 'v'],
-          'display the current version of the CLI and client',
-          () => undefined,
-          async () => {
-            const versions = versionService.getVersions();
-            // Use chalk for consistent formatting
-            console.log(`${chalk.bold.green('cli version')} ${versions.cli}`);
-            console.log(`${chalk.bold.green('client version')} ${versions.client}`);
-            process.exit(0);
-          }
-        )
-        // Error handling
-        .strictCommands()
-        .demandCommand(1, 'unknown command. see above for the list of supported commands.')
-
-        // Alias option flags --help = -h, default --version = -v
-        .alias('h', 'help')
-        .alias('v', 'version')
-    );
-  }
-
-  /**
-   * Parse and execute CLI
-   */
-  async run(): Promise<void> {
-    await this.build().parseAsync();
-  }
-}

package/src/cli.ts

@@ -1,22 +0,0 @@
-#!/usr/bin/env node
-import { Logs } from '@poetora/previewing';
-import { render } from 'ink';
-import React from 'react';
-
-import { CliBuilder } from './cli-builder.js';
-
-export interface CliOptions {
-  packageName: string;
-}
-
-export const cli = (options: CliOptions): void => {
-  // Initialize ink rendering for logs
-  render(React.createElement(Logs));
-
-  const builder = new CliBuilder(options.packageName);
-
-  builder.run().catch((error) => {
-    console.error('Fatal error:', error);
-    process.exit(1);
-  });
-};