outfitter/dist/commands/fieldguides/list.js

Command-line tool for equipping your development journey with configurations and fieldguides

import chalk from 'chalk';
import fsExtra from 'fs-extra';
const { readJSON, pathExists } = fsExtra;
import { join } from 'path';
// TODO: This would come from a registry or the fieldguides package
const availableFieldguides = {
    'typescript-standards': 'Core TypeScript patterns and conventions',
    'react-patterns': 'React component and hook patterns',
    'nextjs-patterns': 'Next.js specific patterns and best practices',
    'testing-standards': 'Comprehensive testing methodology',
    'security-standards': 'Security baseline and best practices',
    'react-hook-form': 'Form handling with React Hook Form',
    'react-query': 'Data fetching with React Query',
    'zustand-guide': 'State management with Zustand',
    'vitest-guide': 'Testing with Vitest',
    'playwright-guide': 'E2E testing with Playwright',
};
/**
 * Lists fieldguides that are either installed locally or available for installation.
 *
 * Depending on the {@link options.installed} flag, displays either the installed fieldguides or all available fieldguides with their descriptions, highlighting which are installed.
 *
 * @param options - If `installed` is true, only lists installed fieldguides; otherwise, lists all available fieldguides and their installation status.
 */
export async function listFieldguides(options) {
    const cwd = process.cwd();
    const configPath = join(cwd, '.outfitter', 'config.json');
    let installedFieldguides = [];
    try {
        if (await pathExists(configPath)) {
            const config = (await readJSON(configPath));
            installedFieldguides = config.fieldguides || config.supplies || []; // Support old 'supplies' key for backwards compatibility
        }
    }
    catch (e) {
        console.error(chalk.red('Failed to read .outfitter/config.json:'), e.message);
        return;
    }
    if (options.installed) {
        if (installedFieldguides.length === 0) {
            console.log(chalk.yellow('No fieldguides installed yet.'));
            return;
        }
        console.log(chalk.cyan('Installed fieldguides:\n'));
        installedFieldguides.forEach(fieldguide => {
            console.log('  ' + chalk.green('✓') + ' ' + fieldguide);
        });
    }
    else {
        console.log(chalk.cyan('Available fieldguides:\n'));
        Object.entries(availableFieldguides).forEach(([fieldguide, description]) => {
            const isInstalled = installedFieldguides.includes(fieldguide);
            const status = isInstalled ? chalk.green('✓') : chalk.gray('○');
            const name = isInstalled ? chalk.green(fieldguide) : fieldguide;
            console.log(`  ${status} ${name}`);
            console.log(`    ${chalk.gray(description)}\n`);
        });
        if (installedFieldguides.length === 0) {
            console.log(chalk.yellow('\nNo fieldguides installed yet. Run "outfitter fg add <fieldguide>" to get started.'));
        }
    }
}
//# sourceMappingURL=list.js.map