vyriy 0.3.9 → 0.4.1

package/doctor/printDoctorReport.js

@@ -1,42 +0,0 @@
-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

@@ -1,25 +0,0 @@
-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

@@ -1,4 +0,0 @@
-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

@@ -1,29 +0,0 @@
-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

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

package/file-plan/index.js

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

package/file-plan/printFilePlan.d.ts

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

package/file-plan/printFilePlan.js

@@ -1,44 +0,0 @@
-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

@@ -1,12 +0,0 @@
-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

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

package/file-plan/writeFilePlan.js

@@ -1,12 +0,0 @@
-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

@@ -1,12 +0,0 @@
-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 './commands/publish/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

@@ -1,12 +0,0 @@
-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 './commands/publish/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/presets/agentsTemplate.d.ts

@@ -1 +0,0 @@
-export declare const agentsTemplate: string;

package/presets/agentsTemplate.js

@@ -1,105 +0,0 @@
-export const agentsTemplate = [
-    '# Project Agent Guide',
-    '',
-    'This repository follows a calm engineering style: changes should be explicit, reusable, typed, documented, tested, and easy to reason about.',
-    '',
-    'Use this guide as the default behavior for AI agents and contributors working in this repository. Prefer local package conventions when they are more specific than this document.',
-    '',
-    '## Core Principles',
-    '',
-    '- Prefer simple modules over clever frameworks or hidden conventions.',
-    '- Keep package and project boundaries explicit.',
-    '- Avoid project-specific coupling in reusable code.',
-    '- Extract only proven reusable behavior.',
-    '- Keep public APIs small, typed, documented, and stable.',
-    '- Prefer SSR-friendly and SSG-friendly code paths when working with frontend or shared code.',
-    '- Keep integrations replaceable and avoid hard coupling to a CMS, framework, vendor, or runtime host.',
-    '- Prefer infrastructure assumptions that are easy to deploy, observe, and replace.',
-    '- Prefer the option that is simpler to explain, easier to evolve, and calmer to maintain.',
-    '',
-    '## File Shape',
-    '',
-    '- Prefer one exported runtime method, component, helper, or class per production file when it stays readable.',
-    '- Prefer one matching test file per production file, for example `feature.ts` and `feature.test.ts`.',
-    '- Use focused folders when behavior naturally splits into several related files.',
-    '- Keep `index.ts` as a public re-export surface only. Do not place implementation logic in it.',
-    '- Use relative import and export specifiers that match the package module style.',
-    '- Use `.js` relative specifiers in TypeScript source for ESM/NodeNext packages.',
-    '- Add `types.ts` when public shared types are part of the package contract.',
-    '- Keep constants near the code that owns them unless they are shared or clarify repeated behavior.',
-    '',
-    '## Public Surface',
-    '',
-    '- Every new public export must be re-exported from the package or module public entry point.',
-    '- Add or update public-surface tests when exports change.',
-    '- Add JSDoc for public exports when behavior, parameters, return values, or usage expectations need explanation.',
-    '- Avoid exporting internal helpers only to make tests easier.',
-    '- Do not hand-maintain package `exports` maps unless the project has a real custom publishing need.',
-    '',
-    '## Tests',
-    '',
-    '- Cover public behavior and meaningful edge cases.',
-    '- Prefer behavior-focused tests over private implementation lock-in.',
-    '- Keep tests deterministic.',
-    '- Avoid real network, filesystem, timers, browser, or cloud dependencies unless the behavior specifically requires them.',
-    '- When mocking modules, install mocks before loading the module under test.',
-    '- Use focused validation when changing behavior.',
-    '',
-    'Example validation commands:',
-    '',
-    '```bash',
-    'yarn test',
-    '```',
-    '',
-    'For workspaces, prefer the project convention, for example:',
-    '',
-    '```bash',
-    'yarn workspace <package-name> test',
-    '```',
-    '',
-    'For Jest-based packages, focused validation may look like:',
-    '',
-    '```bash',
-    'yarn jest packages/<package> --runInBand --coverage=false',
-    '```',
-    '',
-    '## Documentation',
-    '',
-    '- Keep `README.md` concise and usage-oriented.',
-    '- Start package READMEs with `# <package>`.',
-    '- Document real public exports, supported options, and examples that actually work.',
-    '- Update docs when public behavior changes.',
-    '- Keep generated docs wrappers, such as `doc.mdx`, aligned with the README when the project uses them.',
-    '- For component packages, include visual documentation or stories for supported states and common usage.',
-    '',
-    '## Components',
-    '',
-    '- Prefer lightweight React components with TypeScript when working in React packages.',
-    '- Keep components SSR-friendly and avoid browser globals during render.',
-    '- Prefer composable props and predictable ergonomics.',
-    '- Put each public component in its own file with a matching test.',
-    '- Add stories or examples when a component has visual states, variants, or interaction states.',
-    '- Keep styling explicit and reusable. Avoid hidden theme assumptions unless they are part of the package contract.',
-    '',
-    '## Change Discipline',
-    '',
-    '- Keep changes scoped to the requested behavior.',
-    '- Avoid unrelated refactors and metadata churn.',
-    '- Sync implementation, tests, docs, examples, and public re-exports together.',
-    '- Do not introduce new dependencies unless they clearly reduce complexity or are already part of the project direction.',
-    '- Prefer small, reviewable changes over broad rewrites.',
-    '- Preserve existing conventions unless there is a clear reason to change them.',
-    '',
-    '## Before Finishing',
-    '',
-    'Check that the change is complete:',
-    '',
-    '- Public exports are updated.',
-    '- Public-surface tests are updated when exports change.',
-    '- Matching unit tests exist for new behavior.',
-    '- README examples still match the real API.',
-    '- Visual docs, stories, or examples are updated for visible component behavior.',
-    '- TypeScript imports follow the package module style.',
-    '- No unrelated files, formatting churn, or generated artifacts were changed.',
-    '',
-].join('\n');

package/presets/base/createBaseFiles.d.ts

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

package/presets/base/createBaseFiles.js

@@ -1,307 +0,0 @@
-import { agentsTemplate } from '../agentsTemplate.js';
-import { json, packageVersion, peerDependencies, publishedPackageJson } from '../config.js';
-const baseRootDevDependencies = {
-    '@vyriy/typescript-config': packageVersion(publishedPackageJson.version),
-    typescript: peerDependencies.typescript,
-    '@vyriy/prettier-config': packageVersion(publishedPackageJson.version),
-    prettier: peerDependencies.prettier,
-    '@vyriy/eslint-config': packageVersion(publishedPackageJson.version),
-    eslint: peerDependencies.eslint,
-    '@vyriy/jest-config': packageVersion(publishedPackageJson.version),
-    jest: peerDependencies.jest,
-    '@vyriy/storybook-config': packageVersion(publishedPackageJson.version),
-    storybook: peerDependencies.storybook,
-    '@storybook/react-webpack5': peerDependencies['@storybook/react-webpack5'],
-    react: peerDependencies.react,
-    'react-dom': peerDependencies['react-dom'],
-    '@types/react': peerDependencies['@types/react'],
-    '@types/react-dom': peerDependencies['@types/react-dom'],
-    '@vyriy/path': packageVersion(publishedPackageJson.version),
-    husky: peerDependencies.husky,
-    'npm-run-all2': peerDependencies['npm-run-all2'],
-    'cross-env': peerDependencies['cross-env'],
-};
-const buildDistDevDependencies = {
-    vyriy: packageVersion(publishedPackageJson.version),
-    rimraf: peerDependencies.rimraf,
-};
-const stylelintDevDependencies = {
-    '@vyriy/stylelint-config': packageVersion(publishedPackageJson.version),
-    stylelint: peerDependencies.stylelint,
-};
-const shouldCreateStylelintConfig = (plan) => plan.features.some((feature) => [
-    'react',
-    'webpack',
-].includes(feature));
-const getStylePackageName = (plan) => plan.packages.find((packagePlan) => packagePlan.kind === 'ui')?.name ?? 'ui';
-const shouldCreateResetStyles = (plan) => shouldCreateStylelintConfig(plan) && plan.preset !== 'library';
-const hasPublishablePackages = (plan) => plan.packages.some((packagePlan) => packagePlan.publishable);
-const createRootPackageJson = (plan) => {
-    const publishable = hasPublishablePackages(plan);
-    const stylelint = shouldCreateStylelintConfig(plan);
-    return {
-        path: 'package.json',
-        content: json({
-            name: `${plan.packageScope}/${plan.projectName}`,
-            version: '0.0.0',
-            description: plan.description,
-            private: true,
-            type: 'module',
-            packageManager: publishedPackageJson.packageManager,
-            engines: {
-                node: publishedPackageJson.engines.node,
-            },
-            workspaces: [
-                'packages/*',
-                'workspaces/*',
-            ],
-            scripts: {
-                storybook: 'cross-env STORYBOOK_DISABLE_TELEMETRY=1 storybook dev -p 6006 --disable-telemetry',
-                check: 'run-s lint build test',
-                fix: "run-s 'fix:*'",
-                lint: "run-s 'lint:*'",
-                build: "run-s 'build:*'",
-                test: "run-s 'test:*'",
-                'fix:prettier': 'prettier . --write',
-                'fix:eslint': 'eslint . --fix',
-                'lint:ts': 'tsc --pretty false',
-                'lint:prettier': 'prettier . --check',
-                'lint:eslint': 'eslint .',
-                ...(stylelint ? { 'lint:stylelint': 'stylelint "packages/**/*.{scss,css}"' } : {}),
-                'build:dist': publishable
-                    ? 'rimraf dist && tsc -p tsconfig.build.json && vyriy publish'
-                    : 'echo "Build dist is not configured yet."',
-                'build:storybook': 'cross-env STORYBOOK_DISABLE_TELEMETRY=1 storybook build --quiet --disable-telemetry',
-                'test:jest': 'jest --passWithNoTests',
-                postinstall: 'husky',
-            },
-            devDependencies: {
-                ...baseRootDevDependencies,
-                ...(publishable ? buildDistDevDependencies : {}),
-                ...(stylelint ? stylelintDevDependencies : {}),
-            },
-        }),
-    };
-};
-const createBuildTsConfig = () => ({
-    path: 'tsconfig.build.json',
-    content: json({
-        extends: './tsconfig.json',
-        include: [
-            'packages/**/*.ts',
-            'packages/**/*.tsx',
-            'packages/**/*.json',
-        ],
-        exclude: [
-            '**/*.test.ts',
-            '**/*.test.tsx',
-            '**/*.stories.ts',
-            '**/*.stories.tsx',
-        ],
-        compilerOptions: {
-            rootDir: './packages',
-            outDir: './dist',
-            noEmit: false,
-            declaration: true,
-            allowImportingTsExtensions: false,
-        },
-    }),
-});
-const createStyleFiles = (plan) => shouldCreateStylelintConfig(plan)
-    ? [
-        {
-            path: 'stylelint.config.ts',
-            content: "export { default } from '@vyriy/stylelint-config';\n",
-        },
-        ...(shouldCreateResetStyles(plan)
-            ? [
-                {
-                    path: `packages/${getStylePackageName(plan)}/reset.scss`,
-                    content: `html {
-  box-sizing: border-box;
-}
-
-*,
-*::before,
-*::after {
-  box-sizing: inherit;
-}
-
-body {
-  margin: 0;
-}
-`,
-                },
-            ]
-            : []),
-    ]
-    : [];
-export const createBaseFiles = (plan) => [
-    createRootPackageJson(plan),
-    {
-        path: 'README.md',
-        content: `# ${plan.projectName}\n\n${plan.description}\n`,
-    },
-    {
-        path: 'doc.mdx',
-        content: `import { Meta, Markdown } from '@storybook/addon-docs/blocks';
-import ReadMe from './README.md?raw';
-
-<Meta title="${plan.projectName}" />
-
-<Markdown>{ReadMe}</Markdown>
-`,
-    },
-    {
-        path: 'AGENTS.md',
-        content: agentsTemplate,
-    },
-    {
-        path: '.editorconfig',
-        content: `# https://editorconfig.org
-root = true
-
-[*]
-charset = utf-8
-end_of_line = lf
-insert_final_newline = true
-trim_trailing_whitespace = true
-
-indent_style = space
-indent_size = 2
-
-max_line_length = 100
-
-# Markdown
-[*.md]
-trim_trailing_whitespace = false
-max_line_length = off
-
-# YAML / YML
-[*.{yml,yaml}]
-indent_size = 2
-
-# JSON
-[*.json]
-indent_size = 2
-
-# TypeScript / JavaScript
-[*.{ts,tsx,js,jsx}]
-indent_size = 2
-
-# Shell / Bash
-[*.sh]
-indent_size = 2`,
-    },
-    {
-        path: '.gitignore',
-        content: `.yarn/*
-!.yarn/cache
-!.yarn/patches
-!.yarn/plugins
-!.yarn/releases
-!.yarn/sdks
-!.yarn/versions
-
-.DS_Store
-.idea
-node_modules
-coverage
-dist
-storybook-static
-*storybook.log
-consumer
-
-cdk.out
-cdk.context.json
-
-!/**/.gitkeep`,
-    },
-    {
-        path: '.npmrc',
-        content: 'engine-strict=true\n',
-    },
-    {
-        path: '.nvmrc',
-        content: 'lts/krypton',
-    },
-    {
-        path: '.yarnrc.yml',
-        content: 'nodeLinker: node-modules\nnpmMinimalAgeGate: 0\n',
-    },
-    {
-        path: '.husky/commit-msg',
-        content: '#!/bin/sh\n',
-    },
-    {
-        path: '.husky/post-checkout',
-        content: '#!/bin/sh\n\nyarn\n',
-    },
-    {
-        path: '.husky/post-merge',
-        content: '#!/bin/sh\n\nyarn\n',
-    },
-    {
-        path: '.husky/pre-commit',
-        content: '#!/bin/sh\n\nyarn check\n',
-    },
-    {
-        path: '.husky/pre-push',
-        content: '#!/bin/sh\n\nyarn check\n',
-    },
-    {
-        path: '.storybook/main.ts',
-        content: `import config from '@vyriy/storybook-config';
-import { path } from '@vyriy/path';
-
-export default {
-  ...config,
-  stories: [
-    path('**/*.mdx'),
-    path('**/*.stories.@(js|jsx|mjs|ts|tsx)'),
-  ],
-};
-`,
-    },
-    {
-        path: '.storybook/preview.tsx',
-        content: "export { default } from '@vyriy/storybook-config/preview';\n",
-    },
-    {
-        path: 'yarn.lock',
-        content: '',
-    },
-    {
-        path: 'tsconfig.json',
-        content: json({
-            extends: '@vyriy/typescript-config/index.json',
-            include: [
-                '.storybook/**/*.ts',
-                '.storybook/**/*.tsx',
-                'packages/**/*.ts',
-                'packages/**/*.tsx',
-                'workspaces/**/*.ts',
-                'workspaces/**/*.tsx',
-                '*.ts',
-            ],
-        }),
-    },
-    ...(hasPublishablePackages(plan) ? [createBuildTsConfig()] : []),
-    {
-        path: 'prettier.config.ts',
-        content: "export { default } from '@vyriy/prettier-config';\n",
-    },
-    {
-        path: '.prettierignore',
-        content: 'node_modules\ndist\ncoverage\nstorybook-static\n',
-    },
-    {
-        path: 'eslint.config.ts',
-        content: "export { default } from '@vyriy/eslint-config';\n",
-    },
-    {
-        path: 'jest.config.ts',
-        content: "export { default } from '@vyriy/jest-config';\n",
-    },
-    ...createStyleFiles(plan),
-];

package/presets/config.d.ts

@@ -1,28 +0,0 @@
-import packageJson from '../package.json';
-type PublishedPackageJson = typeof packageJson & {
-    readonly engines: {
-        readonly node: string;
-    };
-    readonly packageManager: string;
-};
-export declare const json: (value: unknown) => string;
-export declare const packageVersion: (version: string) => string;
-export declare const publishedPackageJson: PublishedPackageJson;
-export declare const peerDependencies: {
-    "@storybook/react-webpack5": string;
-    "@types/react": string;
-    "@types/react-dom": string;
-    "cross-env": string;
-    eslint: string;
-    husky: string;
-    jest: string;
-    "npm-run-all2": string;
-    prettier: string;
-    react: string;
-    "react-dom": string;
-    rimraf: string;
-    storybook: string;
-    stylelint: string;
-    typescript: string;
-};
-export {};