@poetora/cli 0.0.1 → 0.1.2

package/src/accessibilityCheck.tsx

@@ -1,145 +0,0 @@
-import { getConfigObj, getConfigPath } from '@poetora/prebuild';
-import { addLog, ErrorLog, WarningLog } from '@poetora/previewing';
-import { getBackgroundColors } from '@poetora/shared';
-import { Text } from 'ink';
-
-import { checkDocsColors, type AccessibilityCheckResult } from './accessibility.js';
-import { ContrastResult } from './accessibility.js';
-import { CMD_EXEC_PATH } from './constants.js';
-
-export type TerminateCode = 0 | 1;
-
-export const accessibilityCheck = async (): Promise<TerminateCode> => {
-  try {
-    const docsConfigPath = await getConfigPath(CMD_EXEC_PATH);
-
-    if (!docsConfigPath) {
-      addLog(
-        <ErrorLog message="No configuration file found. Please run this command from a directory with a docs.json file." />
-      );
-      return 1;
-    }
-
-    const config = await getConfigObj(CMD_EXEC_PATH);
-
-    if (!config.colors) {
-      addLog(<WarningLog message="No colors section found in configuration file" />);
-      return 0;
-    }
-
-    const { colors, navigation } = config;
-
-    const { lightHex, darkHex } = getBackgroundColors(config);
-
-    const results: AccessibilityCheckResult = checkDocsColors(
-      colors,
-      { lightHex, darkHex },
-      navigation
-    );
-
-    const displayContrastResult = (
-      result: ContrastResult | null,
-      label: string,
-      prefix: string = ''
-    ) => {
-      if (!result) return;
-
-      const { recommendation, message } = result;
-      const icon =
-        recommendation === 'pass' ? 'PASS' : recommendation === 'warning' ? 'WARN' : 'FAIL';
-      const color =
-        recommendation === 'pass' ? 'green' : recommendation === 'warning' ? 'yellow' : 'red';
-
-      addLog(
-        <Text>
-          <Text bold={prefix === ''}>
-            {prefix}
-            {label}:{' '}
-          </Text>
-          <Text color={color}>
-            {icon} {message}
-          </Text>
-        </Text>
-      );
-    };
-
-    addLog(
-      <Text bold color="cyan">
-        Checking color accessibility...
-      </Text>
-    );
-    addLog(<Text></Text>);
-
-    displayContrastResult(
-      results.primaryContrast,
-      `Primary Color (${colors.primary}) vs Light Background`
-    );
-    displayContrastResult(
-      results.lightContrast,
-      `Light Color (${colors.light}) vs Dark Background`
-    );
-    displayContrastResult(results.darkContrast, `Dark Color (${colors.dark}) vs Dark Background`);
-    displayContrastResult(
-      results.darkOnLightContrast,
-      `Dark Color (${colors.dark}) vs Light Background`
-    );
-
-    const anchorsWithResults = results.anchorResults.filter(
-      (anchor) => anchor.lightContrast || anchor.darkContrast
-    );
-
-    if (anchorsWithResults.length > 0) {
-      addLog(<Text></Text>);
-      addLog(
-        <Text bold color="cyan">
-          Navigation Anchors:
-        </Text>
-      );
-
-      for (const anchor of anchorsWithResults) {
-        addLog(<Text bold> {anchor.name}:</Text>);
-        displayContrastResult(anchor.lightContrast, 'Light variant vs Light Background', '    ');
-        displayContrastResult(anchor.darkContrast, 'Dark variant vs Dark Background', '    ');
-      }
-    }
-
-    addLog(<Text></Text>);
-    const overallIcon =
-      results.overallScore === 'pass'
-        ? 'PASS'
-        : results.overallScore === 'warning'
-          ? 'WARN'
-          : 'FAIL';
-    const overallColor =
-      results.overallScore === 'pass'
-        ? 'green'
-        : results.overallScore === 'warning'
-          ? 'yellow'
-          : 'red';
-    const overallMessage =
-      results.overallScore === 'pass'
-        ? 'All colors meet accessibility standards!'
-        : results.overallScore === 'warning'
-          ? 'Some colors could be improved for better accessibility'
-          : 'Some colors fail accessibility standards and should be updated';
-
-    addLog(
-      <Text>
-        <Text bold color={overallColor}>
-          Overall Assessment: {overallIcon} {overallMessage}
-        </Text>
-      </Text>
-    );
-
-    return results.overallScore === 'fail' ? 1 : 0;
-  } catch (error) {
-    addLog(
-      <ErrorLog
-        message={`Accessibility check failed: ${
-          error instanceof Error ? error.message : 'Unknown error'
-        }`}
-      />
-    );
-    return 1;
-  }
-};

package/src/cli.tsx

@@ -1,302 +0,0 @@
-import { getBrokenInternalLinks, renameFilesAndUpdateLinksInContent } from '@poetora/link-rot';
-import {
-  addLog,
-  dev,
-  ErrorLog,
-  SpinnerLog,
-  SuccessLog,
-  Logs,
-  clearLogs,
-  BrokenLinksLog,
-  WarningLog,
-} from '@poetora/previewing';
-import { validate, getOpenApiDocumentFromUrl, isAllowedLocalSchemaUrl } from '@poetora/shared';
-import { render, Text } from 'ink';
-import path from 'path';
-import yargs from 'yargs';
-import { hideBin } from 'yargs/helpers';
-
-import { accessibilityCheck } from './accessibilityCheck.js';
-import {
-  checkPort,
-  checkNodeVersion,
-  getVersions,
-  suppressConsoleWarnings,
-  terminate,
-  readLocalOpenApiFile,
-} from './helpers.js';
-import { init } from './init.js';
-import { mdxLinter } from './mdxLinter.js';
-import { update } from './update.js';
-
-export const cli = ({ packageName = 'poet' }: { packageName?: string }) => {
-  render(<Logs />);
-
-  return (
-    yargs(hideBin(process.argv))
-      .scriptName(packageName)
-      .middleware(checkNodeVersion)
-      .middleware(suppressConsoleWarnings)
-      .command(
-        'dev',
-        'initialize a local preview environment',
-        (yargs) =>
-          yargs
-            .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',
-            })
-            .usage('usage: poetora dev [options]')
-            .example('poetora dev', 'run with default settings (opens in browser)')
-            .example('poetora dev --no-open', 'run without opening in browser'),
-        async (argv) => {
-          let nodeVersionString = process.version;
-          if (nodeVersionString.charAt(0) === 'v') {
-            nodeVersionString = nodeVersionString.slice(1);
-          }
-          const versionArr = nodeVersionString.split('.');
-          const majorVersion = parseInt(versionArr[0]!, 10);
-          const minorVersion = parseInt(versionArr[1]!, 10);
-
-          if (majorVersion >= 25) {
-            addLog(
-              <ErrorLog message="poet dev is not supported on node versions 25+. Please downgrade to an LTS node version." />
-            );
-            await terminate(1);
-          }
-
-          if (majorVersion < 20 || (majorVersion === 20 && minorVersion < 17)) {
-            addLog(
-              <ErrorLog message="poet dev is not supported on node versions below 20.17 Please upgrade to an LTS node version." />
-            );
-            await terminate(1);
-          }
-
-          const port = await checkPort(argv);
-          const { cli: cliVersion } = getVersions();
-          if (port != undefined) {
-            await dev({
-              ...argv,
-              port,
-              packageName,
-              cliVersion,
-            });
-          } else {
-            addLog(<ErrorLog message="no available port found" />);
-            await terminate(1);
-          }
-        }
-      )
-      .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 (e.g. https://petstore3.swagger.io/api/v3/openapi.json)',
-              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 ({ filename, 'local-schema': localSchema }) => {
-          try {
-            if (isAllowedLocalSchemaUrl(filename, localSchema)) {
-              await getOpenApiDocumentFromUrl(filename);
-              addLog(<SuccessLog message="OpenAPI definition is valid." />);
-              await terminate(0);
-            }
-
-            if (filename.startsWith('http://') && !localSchema) {
-              addLog(
-                <WarningLog message="include the --local-schema flag to check locally hosted OpenAPI files" />
-              );
-              addLog(<WarningLog message="only https protocol is supported in production" />);
-              await terminate(0);
-            }
-
-            const document = await readLocalOpenApiFile(filename);
-
-            if (!document) {
-              throw new Error(
-                'failed to parse OpenAPI spec: could not parse file correctly, please check for any syntax errors.'
-              );
-            }
-            await validate(document);
-            addLog(<SuccessLog message="OpenAPI definition is valid." />);
-          } catch (err) {
-            if (err && typeof err === 'object' && 'code' in err && err.code === 'ENOENT') {
-              addLog(
-                <ErrorLog message={`file not found, please check the path provided: ${filename}`} />
-              );
-            } else {
-              addLog(<ErrorLog message={err instanceof Error ? err.message : 'unknown error'} />);
-            }
-            await terminate(1);
-          }
-
-          await terminate(0);
-        }
-      )
-      .command(
-        'broken-links',
-        'check for invalid internal links',
-        () => undefined,
-        async () => {
-          addLog(<SpinnerLog message="checking for broken links..." />);
-          try {
-            const brokenLinks = await getBrokenInternalLinks();
-            if (brokenLinks.length === 0) {
-              clearLogs();
-              addLog(<SuccessLog message="no broken links found" />);
-              await terminate(0);
-            }
-
-            const brokenLinksByFile: Record<string, string[]> = {};
-            brokenLinks.forEach((mdxPath) => {
-              const filename = path.join(mdxPath.relativeDir, mdxPath.filename);
-              const brokenLinksForFile = brokenLinksByFile[filename];
-              if (brokenLinksForFile) {
-                brokenLinksForFile.push(mdxPath.originalPath);
-              } else {
-                brokenLinksByFile[filename] = [mdxPath.originalPath];
-              }
-            });
-            clearLogs();
-            addLog(<BrokenLinksLog brokenLinksByFile={brokenLinksByFile} />);
-          } catch (err) {
-            addLog(<ErrorLog message={err instanceof Error ? err.message : 'unknown error'} />);
-            await terminate(1);
-          }
-
-          await terminate(1);
-        }
-      )
-      .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: `poetora rename introduction.mdx overview.mdx`'),
-        async ({ from, to, force }) => {
-          await renameFilesAndUpdateLinksInContent(from, to, force);
-          await terminate(0);
-        }
-      )
-      .command(
-        'update',
-        'update the CLI to the latest version',
-        () => undefined,
-        async () => {
-          await update({ packageName });
-          await terminate(0);
-        }
-      )
-      .command(
-        ['a11y', 'accessibility-check', 'a11y-check', 'accessibility'],
-        'check for accessibility issues in documentation',
-        () => undefined,
-        async () => {
-          const accessibilityCheckTerminateCode = await accessibilityCheck();
-          const mdxLinterTerminateCode = await mdxLinter();
-          await terminate(accessibilityCheckTerminateCode || mdxLinterTerminateCode);
-        }
-      )
-      .command(
-        ['version', 'v'],
-        'display the current version of the CLI and client',
-        () => undefined,
-        async () => {
-          const { cli, client } = getVersions();
-          addLog(
-            <Text>
-              <Text bold color="green">
-                cli version
-              </Text>{' '}
-              {cli}
-            </Text>
-          );
-          addLog(
-            <Text>
-              <Text bold color="green">
-                client version
-              </Text>{' '}
-              {client}
-            </Text>
-          );
-        }
-      )
-      .command(
-        'new [directory]',
-        'Create a new Poetora documentation site',
-        (yargs) =>
-          yargs.positional('directory', {
-            describe: 'The directory to initialize your documentation',
-            type: 'string',
-            default: '.',
-          }),
-        async ({ directory }) => {
-          try {
-            await init(directory);
-            await terminate(0);
-          } catch (error) {
-            addLog(
-              <ErrorLog message={error instanceof Error ? error.message : 'error occurred'} />
-            );
-            await terminate(1);
-          }
-        }
-      )
-      // Print the help menu when the user enters an invalid command.
-      .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()
-  );
-};

package/src/helpers.tsx

@@ -1,131 +0,0 @@
-import {
-  addLog,
-  ErrorLog,
-  getClientVersion,
-  InfoLog,
-  LOCAL_LINKED_CLI_VERSION,
-} from '@poetora/previewing';
-import detect from 'detect-port';
-import fs from 'fs/promises';
-import yaml from 'js-yaml';
-import { exec, execSync } from 'node:child_process';
-import { promisify } from 'node:util';
-import path from 'path';
-import type { ArgumentsCamelCase } from 'yargs';
-import yargs from 'yargs';
-
-export const checkPort = async (argv: ArgumentsCamelCase): Promise<number | undefined> => {
-  const initialPort = typeof argv.port === 'number' ? argv.port : 3000;
-  if (initialPort === (await detect(initialPort))) return initialPort;
-
-  for (let port = initialPort + 1; port < initialPort + 10; port++) {
-    addLog(<InfoLog message={`port ${port - 1} is already in use. trying ${port} instead`} />);
-    if (port === (await detect(port))) return port;
-  }
-};
-
-export const checkNodeVersion = async () => {
-  let nodeVersionString = process.version;
-  if (nodeVersionString.charAt(0) === 'v') {
-    nodeVersionString = nodeVersionString.slice(1);
-  }
-  const versionArr = nodeVersionString.split('.');
-  const majorVersion = parseInt(versionArr[0]!, 10);
-
-  if (majorVersion < 18) {
-    addLog(
-      <ErrorLog
-        message={`poetora requires a node version >= 18.0.0 (current version ${nodeVersionString}). try removing the poetora package, upgrading node, reinstalling poetora, and running again.`}
-      />
-    );
-  }
-};
-
-export const getCliVersion = (): string | undefined => {
-  const y = yargs();
-  let version = undefined;
-  y.showVersion((s) => {
-    version = s;
-    return false;
-  });
-  if (process.env.CLI_TEST_MODE === 'true') {
-    return 'test-cli';
-  }
-  // when running `npm link` the version is 'unknown'
-  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-  if (version === 'unknown') {
-    version = LOCAL_LINKED_CLI_VERSION;
-  }
-  return version;
-};
-
-export const getVersions = (): {
-  cli: string | undefined;
-  client: string | undefined;
-} => {
-  const cli = getCliVersion();
-  const client = getClientVersion().trim();
-  return { cli, client };
-};
-
-export const getLatestCliVersion = (packageName: string) => {
-  return execSync(`npm view ${packageName} version --silent`, {
-    encoding: 'utf-8',
-    stdio: ['pipe', 'pipe', 'pipe'],
-  }).trim();
-};
-
-export const suppressConsoleWarnings = (): void => {
-  // Ignore tailwind warnings and punycode deprecation warning
-  const ignoredMessages = [
-    'No utility classes were detected',
-    'https://tailwindcss.com/docs/content-configuration',
-    'DeprecationWarning',
-  ];
-  const originalConsoleError = console.error;
-  console.error = (...args) => {
-    const message = args.join(' ');
-    if (ignoredMessages.some((ignoredMessage) => message.includes(ignoredMessage))) {
-      return;
-    }
-    originalConsoleError.apply(console, args);
-  };
-  const originalConsoleWarn = console.warn;
-  console.warn = (...args) => {
-    const message = args.join(' ');
-    if (ignoredMessages.some((ignoredMessage) => message.includes(ignoredMessage))) {
-      return;
-    }
-    originalConsoleWarn.apply(console, args);
-  };
-};
-
-export const readLocalOpenApiFile = async (
-  filename: string
-): Promise<Record<string, unknown> | undefined> => {
-  const pathname = path.resolve(process.cwd(), filename);
-  const file = await fs.readFile(pathname, 'utf-8');
-  const document = yaml.load(file) as Record<string, unknown> | undefined;
-  return document;
-};
-
-export const terminate = async (code: number) => {
-  // Wait for the logs to be fully rendered before exiting
-  await new Promise((resolve) => setTimeout(resolve, 50));
-  process.exit(code);
-};
-
-export const execAsync = promisify(exec);
-
-export const detectPackageManager = async ({ packageName }: { packageName: string }) => {
-  try {
-    const { stdout: packagePath } = await execAsync(`which ${packageName}`);
-    if (packagePath.includes('pnpm')) {
-      return 'pnpm';
-    } else {
-      return 'npm';
-    }
-  } catch (error) {
-    return 'npm';
-  }
-};

package/src/init.tsx

@@ -1,93 +0,0 @@
-import { select, input } from '@inquirer/prompts';
-import { addLogs, addLog, SpinnerLog, removeLastLog } from '@poetora/previewing';
-import { docsConfigSchema } from '@poetora/validation';
-import AdmZip from 'adm-zip';
-import fse from 'fs-extra';
-import { Box, Text } from 'ink';
-
-const sendOnboardingMessage = (installDir: string) => {
-  addLogs(
-    <Text bold>Documentation Setup!</Text>,
-    <Text>To see your docs run</Text>,
-    <Box>
-      <Text color="blue">cd</Text>
-      <Text> {installDir}</Text>
-    </Box>,
-    <Text color="blue">poet dev</Text>
-  );
-};
-
-export async function init(installDir: string): Promise<void> {
-  await fse.ensureDir(installDir);
-  const dirContents = await fse.readdir(installDir).catch(() => []);
-  if (dirContents.length > 0) {
-    const choice = await select({
-      message: `Directory ${installDir} is not empty. What would you like to do?`,
-      choices: [
-        { name: 'Create in a subdirectory', value: 'subdir' },
-        { name: 'Overwrite current directory (may lose contents)', value: 'overwrite' },
-        { name: 'Cancel', value: 'cancel' },
-      ],
-    });
-
-    if (choice === 'cancel') {
-      return;
-    }
-
-    if (choice === 'subdir') {
-      const subdir = await input({
-        message: 'Subdirectory name:',
-        default: 'docs',
-      });
-      if (!subdir || subdir.trim() === '') {
-        throw new Error('Subdirectory name cannot be empty');
-      }
-      installDir = installDir === '.' ? subdir : `${installDir}/${subdir}`;
-      await fse.ensureDir(installDir);
-    }
-  }
-
-  const defaultProject = installDir == '.' ? 'Poetora' : installDir;
-  const projectName = await input({
-    message: 'Project Name',
-    default: defaultProject,
-  });
-
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  const themes = docsConfigSchema.options.map((option: any) => {
-    return option.shape.theme._def.value;
-  });
-
-  const theme = await select({
-    message: 'Theme',
-    choices: themes.map((t: string) => ({
-      name: t,
-      value: t,
-    })),
-  });
-
-  addLog(<SpinnerLog message="downloading starter template..." />);
-  const response = await fetch('https://github.com/poetora/starter/archive/refs/heads/main.zip');
-  const buffer = await response.arrayBuffer();
-  await fse.writeFile(installDir + '/starter.zip', Buffer.from(buffer));
-  removeLastLog();
-
-  addLog(<SpinnerLog message="extracting..." />);
-  new AdmZip(installDir + '/starter.zip').extractAllTo(installDir, true);
-  removeLastLog();
-
-  await fse.copy(installDir + '/starter-main', installDir, {
-    overwrite: true,
-    filter: (src: string) => !src.includes('starter-main/starter-main'),
-  });
-  await fse.remove(installDir + '/starter.zip');
-  await fse.remove(installDir + '/starter-main');
-
-  const docsJsonPath = installDir + '/docs.json';
-  const docsConfig = await fse.readJson(docsJsonPath);
-  docsConfig.theme = theme;
-  docsConfig.name = projectName;
-  await fse.writeJson(docsJsonPath, docsConfig, { spaces: 2 });
-
-  sendOnboardingMessage(installDir);
-}