vyriy 0.3.2 → 0.3.4

package/doctor/checkYarn.js

@@ -0,0 +1,45 @@
+import { execCommand as execCommandDefault, getMajorVersion } from '../shared/index.js';
+export const yarnStableFix = {
+    label: 'Enable Yarn using Corepack',
+    command: 'corepack enable\ncorepack prepare yarn@stable --activate',
+    safeToRun: true,
+};
+export const checkYarn = async ({ execCommand = execCommandDefault, minimumMajor = 4, version, } = {}) => {
+    let currentVersion = version;
+    try {
+        currentVersion ??= await execCommand('yarn', ['--version']);
+    }
+    catch {
+        return {
+            name: 'yarn',
+            label: 'Yarn',
+            group: 'Package manager',
+            level: 'warning',
+            message: 'Yarn was not found',
+            detail: 'Vyriy uses Yarn 4 for generated projects.',
+            fix: yarnStableFix,
+        };
+    }
+    const normalizedVersion = currentVersion.trim();
+    const majorVersion = getMajorVersion(normalizedVersion);
+    if (majorVersion !== undefined && majorVersion >= minimumMajor) {
+        return {
+            name: 'yarn',
+            label: 'Yarn',
+            group: 'Package manager',
+            level: 'ok',
+            version: normalizedVersion,
+            message: `Yarn ${normalizedVersion}`,
+        };
+    }
+    return {
+        name: 'yarn',
+        label: 'Yarn',
+        group: 'Package manager',
+        level: 'warning',
+        version: normalizedVersion,
+        message: `Yarn ${normalizedVersion} detected`,
+        detail: `Vyriy recommends Yarn ${minimumMajor}.`,
+        fix: yarnStableFix,
+    };
+};

package/doctor/createDoctorReport.d.ts

@@ -0,0 +1,2 @@
+import { DoctorCheckOptions, DoctorReport } from './types.js';
+export declare const createDoctorReport: (options?: DoctorCheckOptions) => Promise<DoctorReport>;

package/doctor/createDoctorReport.js

@@ -0,0 +1,17 @@
+import { checkCorepack } from './checkCorepack.js';
+import { checkGit } from './checkGit.js';
+import { checkNodeVersion } from './checkNodeVersion.js';
+import { checkYarn } from './checkYarn.js';
+export const createDoctorReport = async (options = {}) => {
+    const checks = [
+        checkNodeVersion(),
+        await checkCorepack(options),
+        await checkYarn(options),
+        await checkGit(options),
+    ];
+    return {
+        checks,
+        hasErrors: checks.some((check) => check.level === 'error'),
+        hasWarnings: checks.some((check) => check.level === 'warning'),
+    };
+};

package/doctor/index.d.ts

@@ -0,0 +1,7 @@
+export * from './checkCorepack.js';
+export * from './checkGit.js';
+export * from './checkNodeVersion.js';
+export * from './checkYarn.js';
+export * from './createDoctorReport.js';
+export * from './printDoctorReport.js';
+export type * from './types.js';

package/doctor/index.js

@@ -0,0 +1,6 @@
+export * from './checkCorepack.js';
+export * from './checkGit.js';
+export * from './checkNodeVersion.js';
+export * from './checkYarn.js';
+export * from './createDoctorReport.js';
+export * from './printDoctorReport.js';

package/doctor/printDoctorReport.d.ts

@@ -0,0 +1,2 @@
+import { DoctorReport } from './types.js';
+export declare const printDoctorReport: (report: DoctorReport) => string;

package/doctor/printDoctorReport.js

@@ -0,0 +1,42 @@
+const statusMark = {
+    ok: '✓',
+    warning: '!',
+    error: '✘',
+};
+const groups = ['Runtime', 'Package manager', 'Git'];
+export const printDoctorReport = (report) => {
+    const lines = ['Vyriy Doctor', ''];
+    for (const group of groups) {
+        const checks = report.checks.filter((check) => check.group === group);
+        if (checks.length === 0) {
+            continue;
+        }
+        lines.push(`${group}:`);
+        for (const check of checks) {
+            lines.push(`  ${statusMark[check.level]} ${check.message}`);
+            if (check.detail) {
+                lines.push(`    ${check.detail}`);
+            }
+        }
+        lines.push('');
+    }
+    const fixes = report.checks.flatMap((check) => (check.fix ? [check.fix] : []));
+    if (fixes.length > 0) {
+        lines.push('Suggested fix:');
+        for (const fix of fixes) {
+            lines.push(`  ${fix.command.replaceAll('\n', '\n  ')}`);
+        }
+        lines.push('');
+    }
+    lines.push('Result:');
+    if (report.hasErrors) {
+        lines.push('  Environment is not usable.');
+    }
+    else if (report.hasWarnings) {
+        lines.push('  Environment is usable, but warnings should be reviewed.');
+    }
+    else {
+        lines.push('  Environment is usable.');
+    }
+    return lines.join('\n');
+};

package/doctor/types.d.ts

@@ -0,0 +1,25 @@
+import { ExecCommand } from '../shared/index.js';
+export type DoctorCheckLevel = 'ok' | 'warning' | 'error';
+export type DoctorFix = {
+    readonly label: string;
+    readonly command: string;
+    readonly safeToRun: boolean;
+};
+export type DoctorCheck = {
+    readonly name: 'node' | 'corepack' | 'yarn' | 'git';
+    readonly label: string;
+    readonly group: 'Runtime' | 'Package manager' | 'Git';
+    readonly level: DoctorCheckLevel;
+    readonly message: string;
+    readonly detail?: string;
+    readonly version?: string;
+    readonly fix?: DoctorFix;
+};
+export type DoctorReport = {
+    readonly checks: readonly DoctorCheck[];
+    readonly hasErrors: boolean;
+    readonly hasWarnings: boolean;
+};
+export type DoctorCheckOptions = {
+    readonly execCommand?: ExecCommand;
+};

package/file-plan/createFilePlan.d.ts

@@ -0,0 +1,4 @@
+import { FilePlanItem, FilePlanOptions, ProjectFile } from './types.js';
+export declare const createFilePlan: (targetDirectory: string, files: readonly ProjectFile[], options?: FilePlanOptions & {
+    readonly fileExists?: (filePath: string) => Promise<boolean>;
+}) => Promise<FilePlanItem[]>;

package/file-plan/createFilePlan.js

@@ -0,0 +1,29 @@
+import path from 'node:path';
+import { fileExists as fileExistsDefault } from '../shared/index.js';
+const getFilePlanStatus = (exists, { overwrite, skipExisting, }) => {
+    if (!exists) {
+        return 'create';
+    }
+    if (overwrite) {
+        return 'overwrite';
+    }
+    if (skipExisting) {
+        return 'skip';
+    }
+    return 'conflict';
+};
+export const createFilePlan = async (targetDirectory, files, options = {}) => {
+    const { fileExists = fileExistsDefault, overwrite = false, skipExisting = false } = options;
+    if (overwrite && skipExisting) {
+        throw new Error('Cannot use overwrite and skipExisting together.');
+    }
+    const plan = [];
+    for (const file of files) {
+        const exists = await fileExists(path.join(targetDirectory, file.path));
+        plan.push({
+            ...file,
+            status: getFilePlanStatus(exists, { overwrite, skipExisting }),
+        });
+    }
+    return plan;
+};

package/file-plan/index.d.ts

@@ -0,0 +1,4 @@
+export * from './createFilePlan.js';
+export * from './printFilePlan.js';
+export * from './writeFilePlan.js';
+export type * from './types.js';

package/file-plan/index.js

@@ -0,0 +1,3 @@
+export * from './createFilePlan.js';
+export * from './printFilePlan.js';
+export * from './writeFilePlan.js';

package/file-plan/printFilePlan.d.ts

@@ -0,0 +1,2 @@
+import { FilePlanItem } from './types.js';
+export declare const printFilePlan: (plan: readonly FilePlanItem[]) => string;

package/file-plan/printFilePlan.js

@@ -0,0 +1,44 @@
+const sections = [
+    [
+        'create',
+        'CREATE',
+        '+',
+        'to create',
+    ],
+    [
+        'overwrite',
+        'OVERWRITE',
+        '~',
+        'to overwrite',
+    ],
+    [
+        'skip',
+        'SKIP',
+        '-',
+        'to skip',
+    ],
+    [
+        'conflict',
+        'CONFLICT',
+        '!',
+        'conflict',
+    ],
+];
+export const printFilePlan = (plan) => {
+    const lines = ['File plan:', ''];
+    for (const [status, title, marker] of sections) {
+        const items = plan.filter((item) => item.status === status);
+        if (items.length === 0) {
+            continue;
+        }
+        lines.push(title, ...items.map((item) => `  ${marker} ${item.path}`), '');
+    }
+    lines.push('Summary:');
+    for (const [status, , , label,] of sections) {
+        const count = plan.filter((item) => item.status === status).length;
+        if (count > 0) {
+            lines.push(`  ${count} ${label}${status === 'conflict' && count !== 1 ? 's' : ''}`);
+        }
+    }
+    return lines.join('\n');
+};

package/file-plan/types.d.ts

@@ -0,0 +1,12 @@
+export type FilePlanItemStatus = 'create' | 'overwrite' | 'skip' | 'conflict';
+export type ProjectFile = {
+    readonly path: string;
+    readonly content: string;
+};
+export type FilePlanItem = ProjectFile & {
+    readonly status: FilePlanItemStatus;
+};
+export type FilePlanOptions = {
+    readonly overwrite?: boolean;
+    readonly skipExisting?: boolean;
+};

package/file-plan/writeFilePlan.d.ts

@@ -0,0 +1,2 @@
+import { FilePlanItem } from './types.js';
+export declare const writeFilePlan: (targetDirectory: string, plan: readonly FilePlanItem[]) => Promise<void>;

package/file-plan/writeFilePlan.js

@@ -0,0 +1,12 @@
+import fs from 'node:fs/promises';
+import path from 'node:path';
+export const writeFilePlan = async (targetDirectory, plan) => {
+    for (const item of plan) {
+        if (item.status === 'skip' || item.status === 'conflict') {
+            continue;
+        }
+        const absolutePath = path.join(targetDirectory, item.path);
+        await fs.mkdir(path.dirname(absolutePath), { recursive: true });
+        await fs.writeFile(absolutePath, item.content, 'utf8');
+    }
+};

package/index.d.ts

@@ -2,7 +2,10 @@ export * from './cli/index.js';
 export * from './commands/doctor/index.js';
 export * from './commands/init/index.js';
 export * from './commands/new/index.js';
-export * from './checks/node/index.js';
 export * from './checks/yarn/index.js';
+export * from './doctor/index.js';
+export * from './file-plan/index.js';
+export * from './presets/index.js';
 export * from './project-plan/index.js';
 export * from './prompts/project-plan/index.js';
+export * from './shared/index.js';

package/index.js

@@ -2,7 +2,10 @@ export * from './cli/index.js';
 export * from './commands/doctor/index.js';
 export * from './commands/init/index.js';
 export * from './commands/new/index.js';
-export * from './checks/node/index.js';
 export * from './checks/yarn/index.js';
+export * from './doctor/index.js';
+export * from './file-plan/index.js';
+export * from './presets/index.js';
 export * from './project-plan/index.js';
 export * from './prompts/project-plan/index.js';
+export * from './shared/index.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vyriy",
-  "version": "0.3.2",
+  "version": "0.3.4",
   "description": "Interactive project master for calm cloud-ready applications.",
   "type": "module",
   "main": "./index.js",
@@ -169,6 +169,116 @@
       "import": "./commands/new/new.js",
       "default": "./commands/new/new.js"
     },
+    "./doctor/checkCorepack": {
+      "types": "./doctor/checkCorepack.d.ts",
+      "import": "./doctor/checkCorepack.js",
+      "default": "./doctor/checkCorepack.js"
+    },
+    "./doctor/checkCorepack.js": {
+      "types": "./doctor/checkCorepack.d.ts",
+      "import": "./doctor/checkCorepack.js",
+      "default": "./doctor/checkCorepack.js"
+    },
+    "./doctor/checkGit": {
+      "types": "./doctor/checkGit.d.ts",
+      "import": "./doctor/checkGit.js",
+      "default": "./doctor/checkGit.js"
+    },
+    "./doctor/checkGit.js": {
+      "types": "./doctor/checkGit.d.ts",
+      "import": "./doctor/checkGit.js",
+      "default": "./doctor/checkGit.js"
+    },
+    "./doctor/checkNodeVersion": {
+      "types": "./doctor/checkNodeVersion.d.ts",
+      "import": "./doctor/checkNodeVersion.js",
+      "default": "./doctor/checkNodeVersion.js"
+    },
+    "./doctor/checkNodeVersion.js": {
+      "types": "./doctor/checkNodeVersion.d.ts",
+      "import": "./doctor/checkNodeVersion.js",
+      "default": "./doctor/checkNodeVersion.js"
+    },
+    "./doctor/checkYarn": {
+      "types": "./doctor/checkYarn.d.ts",
+      "import": "./doctor/checkYarn.js",
+      "default": "./doctor/checkYarn.js"
+    },
+    "./doctor/checkYarn.js": {
+      "types": "./doctor/checkYarn.d.ts",
+      "import": "./doctor/checkYarn.js",
+      "default": "./doctor/checkYarn.js"
+    },
+    "./doctor/createDoctorReport": {
+      "types": "./doctor/createDoctorReport.d.ts",
+      "import": "./doctor/createDoctorReport.js",
+      "default": "./doctor/createDoctorReport.js"
+    },
+    "./doctor/createDoctorReport.js": {
+      "types": "./doctor/createDoctorReport.d.ts",
+      "import": "./doctor/createDoctorReport.js",
+      "default": "./doctor/createDoctorReport.js"
+    },
+    "./doctor/index": {
+      "types": "./doctor/index.d.ts",
+      "import": "./doctor/index.js",
+      "default": "./doctor/index.js"
+    },
+    "./doctor/index.js": {
+      "types": "./doctor/index.d.ts",
+      "import": "./doctor/index.js",
+      "default": "./doctor/index.js"
+    },
+    "./doctor/printDoctorReport": {
+      "types": "./doctor/printDoctorReport.d.ts",
+      "import": "./doctor/printDoctorReport.js",
+      "default": "./doctor/printDoctorReport.js"
+    },
+    "./doctor/printDoctorReport.js": {
+      "types": "./doctor/printDoctorReport.d.ts",
+      "import": "./doctor/printDoctorReport.js",
+      "default": "./doctor/printDoctorReport.js"
+    },
+    "./file-plan/createFilePlan": {
+      "types": "./file-plan/createFilePlan.d.ts",
+      "import": "./file-plan/createFilePlan.js",
+      "default": "./file-plan/createFilePlan.js"
+    },
+    "./file-plan/createFilePlan.js": {
+      "types": "./file-plan/createFilePlan.d.ts",
+      "import": "./file-plan/createFilePlan.js",
+      "default": "./file-plan/createFilePlan.js"
+    },
+    "./file-plan/index": {
+      "types": "./file-plan/index.d.ts",
+      "import": "./file-plan/index.js",
+      "default": "./file-plan/index.js"
+    },
+    "./file-plan/index.js": {
+      "types": "./file-plan/index.d.ts",
+      "import": "./file-plan/index.js",
+      "default": "./file-plan/index.js"
+    },
+    "./file-plan/printFilePlan": {
+      "types": "./file-plan/printFilePlan.d.ts",
+      "import": "./file-plan/printFilePlan.js",
+      "default": "./file-plan/printFilePlan.js"
+    },
+    "./file-plan/printFilePlan.js": {
+      "types": "./file-plan/printFilePlan.d.ts",
+      "import": "./file-plan/printFilePlan.js",
+      "default": "./file-plan/printFilePlan.js"
+    },
+    "./file-plan/writeFilePlan": {
+      "types": "./file-plan/writeFilePlan.d.ts",
+      "import": "./file-plan/writeFilePlan.js",
+      "default": "./file-plan/writeFilePlan.js"
+    },
+    "./file-plan/writeFilePlan.js": {
+      "types": "./file-plan/writeFilePlan.d.ts",
+      "import": "./file-plan/writeFilePlan.js",
+      "default": "./file-plan/writeFilePlan.js"
+    },
     "./index": {
       "types": "./index.d.ts",
       "import": "./index.js",
@@ -179,6 +289,26 @@
       "import": "./index.js",
       "default": "./index.js"
     },
+    "./presets/createProjectFiles": {
+      "types": "./presets/createProjectFiles.d.ts",
+      "import": "./presets/createProjectFiles.js",
+      "default": "./presets/createProjectFiles.js"
+    },
+    "./presets/createProjectFiles.js": {
+      "types": "./presets/createProjectFiles.d.ts",
+      "import": "./presets/createProjectFiles.js",
+      "default": "./presets/createProjectFiles.js"
+    },
+    "./presets/index": {
+      "types": "./presets/index.d.ts",
+      "import": "./presets/index.js",
+      "default": "./presets/index.js"
+    },
+    "./presets/index.js": {
+      "types": "./presets/index.d.ts",
+      "import": "./presets/index.js",
+      "default": "./presets/index.js"
+    },
     "./project-plan/api/api": {
       "types": "./project-plan/api/api.d.ts",
       "import": "./project-plan/api/api.js",
@@ -308,6 +438,56 @@
       "types": "./prompts/project-plan/project-plan.d.ts",
       "import": "./prompts/project-plan/project-plan.js",
       "default": "./prompts/project-plan/project-plan.js"
+    },
+    "./shared/commandExists": {
+      "types": "./shared/commandExists.d.ts",
+      "import": "./shared/commandExists.js",
+      "default": "./shared/commandExists.js"
+    },
+    "./shared/commandExists.js": {
+      "types": "./shared/commandExists.d.ts",
+      "import": "./shared/commandExists.js",
+      "default": "./shared/commandExists.js"
+    },
+    "./shared/execCommand": {
+      "types": "./shared/execCommand.d.ts",
+      "import": "./shared/execCommand.js",
+      "default": "./shared/execCommand.js"
+    },
+    "./shared/execCommand.js": {
+      "types": "./shared/execCommand.d.ts",
+      "import": "./shared/execCommand.js",
+      "default": "./shared/execCommand.js"
+    },
+    "./shared/fileExists": {
+      "types": "./shared/fileExists.d.ts",
+      "import": "./shared/fileExists.js",
+      "default": "./shared/fileExists.js"
+    },
+    "./shared/fileExists.js": {
+      "types": "./shared/fileExists.d.ts",
+      "import": "./shared/fileExists.js",
+      "default": "./shared/fileExists.js"
+    },
+    "./shared/index": {
+      "types": "./shared/index.d.ts",
+      "import": "./shared/index.js",
+      "default": "./shared/index.js"
+    },
+    "./shared/index.js": {
+      "types": "./shared/index.d.ts",
+      "import": "./shared/index.js",
+      "default": "./shared/index.js"
+    },
+    "./shared/semver": {
+      "types": "./shared/semver.d.ts",
+      "import": "./shared/semver.js",
+      "default": "./shared/semver.js"
+    },
+    "./shared/semver.js": {
+      "types": "./shared/semver.d.ts",
+      "import": "./shared/semver.js",
+      "default": "./shared/semver.js"
     }
   }
 }

package/presets/createProjectFiles.d.ts

@@ -0,0 +1,2 @@
+import { CreateProjectFiles } from './types.js';
+export declare const createProjectFiles: CreateProjectFiles;

package/presets/createProjectFiles.js

@@ -0,0 +1,52 @@
+const json = (value) => `${JSON.stringify(value, null, 2)}\n`;
+const createPackageJson = ({ description, packageScope, projectName, }) => ({
+    path: 'package.json',
+    content: json({
+        name: `${packageScope}/${projectName}`,
+        version: '0.1.0',
+        description,
+        private: true,
+        type: 'module',
+        packageManager: 'yarn@4.14.1',
+        engines: {
+            node: '>=24.0.0',
+        },
+        scripts: {
+            build: 'tsc --pretty false',
+            test: 'jest --coverage=false',
+            lint: 'eslint .',
+        },
+        devDependencies: {},
+    }),
+});
+export const createProjectFiles = (plan) => [
+    createPackageJson(plan),
+    {
+        path: 'README.md',
+        content: `# ${plan.projectName}\n\n${plan.description}\n`,
+    },
+    {
+        path: 'AGENTS.md',
+        content: `# ${plan.projectName} Agent Context\n\nKeep changes scoped, explicit, and easy to validate.\n`,
+    },
+    {
+        path: '.editorconfig',
+        content: 'root = true\n\n[*]\ncharset = utf-8\nend_of_line = lf\ninsert_final_newline = true\nindent_style = space\nindent_size = 2\n',
+    },
+    {
+        path: '.gitignore',
+        content: 'node_modules/\ndist/\ncoverage/\n.yarn/cache/\n.env\n',
+    },
+    {
+        path: 'src/index.ts',
+        content: "export type * from './types.js';\n",
+    },
+    {
+        path: 'src/index.test.ts',
+        content: "import { describe, expect, it } from '@jest/globals';\n\ndescribe('project', () => {\n  it('has a test harness', () => {\n    expect(true).toBe(true);\n  });\n});\n",
+    },
+    {
+        path: 'src/types.ts',
+        content: 'export type ProjectName = string;\n',
+    },
+];

package/presets/index.d.ts

@@ -0,0 +1,2 @@
+export * from './createProjectFiles.js';
+export type * from './types.js';

package/presets/index.js

@@ -0,0 +1 @@
+export * from './createProjectFiles.js';

package/presets/types.d.ts

@@ -0,0 +1,3 @@
+import { ProjectFile } from '../file-plan/index.js';
+import { VyriyProjectPlan } from '../project-plan/index.js';
+export type CreateProjectFiles = (plan: VyriyProjectPlan) => ProjectFile[];

package/shared/commandExists.d.ts

@@ -0,0 +1,2 @@
+import { CommandExists } from './types.js';
+export declare const commandExists: CommandExists;

package/shared/commandExists.js

@@ -0,0 +1,10 @@
+import { execCommand as execCommandDefault } from './execCommand.js';
+export const commandExists = async (command, { execCommand = execCommandDefault } = {}) => {
+    try {
+        await execCommand(command, ['--version']);
+        return true;
+    }
+    catch {
+        return false;
+    }
+};

package/shared/execCommand.d.ts

@@ -0,0 +1,2 @@
+import { ExecCommand } from './types.js';
+export declare const execCommand: ExecCommand;

package/shared/execCommand.js

@@ -0,0 +1,7 @@
+import { execFile } from 'node:child_process';
+import { promisify } from 'node:util';
+const execFileAsync = promisify(execFile);
+export const execCommand = async (command, args = []) => {
+    const { stdout } = await execFileAsync(command, args);
+    return stdout.trim();
+};

package/shared/fileExists.d.ts

@@ -0,0 +1,2 @@
+import { FileExists } from './types.js';
+export declare const fileExists: FileExists;

package/shared/fileExists.js

@@ -0,0 +1,10 @@
+import fs from 'node:fs/promises';
+export const fileExists = async (filePath) => {
+    try {
+        await fs.access(filePath);
+        return true;
+    }
+    catch {
+        return false;
+    }
+};

package/shared/index.d.ts

@@ -0,0 +1,5 @@
+export * from './commandExists.js';
+export * from './execCommand.js';
+export * from './fileExists.js';
+export * from './semver.js';
+export type * from './types.js';

package/shared/index.js

@@ -0,0 +1,4 @@
+export * from './commandExists.js';
+export * from './execCommand.js';
+export * from './fileExists.js';
+export * from './semver.js';

package/shared/semver.d.ts

@@ -0,0 +1 @@
+export declare const getMajorVersion: (version: string) => number | undefined;

package/shared/semver.js

@@ -0,0 +1,4 @@
+export const getMajorVersion = (version) => {
+    const majorVersion = /^v?(\d+)/.exec(version.trim())?.[1];
+    return majorVersion ? Number.parseInt(majorVersion, 10) : undefined;
+};