vyriy 0.3.9 → 0.4.1

package/commands/create/preset/library.js

@@ -0,0 +1,252 @@
+import packageJson from '../../../package.json' with { type: 'json' };
+import { base } from './base.js';
+export const library = {
+    files: (options) => {
+        const packageScope = options.scope ?? `@${options.name}`;
+        const packageName = `${packageScope}/${options.name}`;
+        return {
+            ...base.files(options),
+            'package.json': JSON.stringify({
+                name: options.name,
+                version: '0.0.0',
+                description: options.description,
+                private: true,
+                type: 'module',
+                agents: './AGENTS.md',
+                packageManager: packageJson.packageManager,
+                engines: {
+                    node: packageJson.engines.node,
+                },
+                workspaces: [
+                    'packages/*',
+                ],
+                license: 'MIT',
+                repository: {
+                    type: 'git',
+                    url: `https://github.com/${options.name}/${options.name}`,
+                },
+                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',
+                    'fix:stylelint': 'stylelint "**/*.{css,scss}" --fix',
+                    'lint:ts': 'tsc',
+                    'lint:prettier': 'prettier . --check',
+                    'lint:eslint': 'eslint .',
+                    'lint:stylelint': 'stylelint "**/*.{css,scss}"',
+                    'build:dist': 'rimraf dist && tsc -p tsconfig.build.json && vyriy -d',
+                    'build:storybook': 'cross-env STORYBOOK_DISABLE_TELEMETRY=1 storybook build --quiet --disable-telemetry',
+                    'test:jest': 'jest',
+                    postinstall: 'husky',
+                },
+                devDependencies: {
+                    '@vyriy/typescript-config': `^${packageJson.version}`,
+                    typescript: packageJson.peerDependencies.typescript,
+                    '@vyriy/prettier-config': `^${packageJson.version}`,
+                    prettier: packageJson.peerDependencies.prettier,
+                    '@vyriy/eslint-config': `^${packageJson.version}`,
+                    eslint: packageJson.peerDependencies.eslint,
+                    '@vyriy/jest-config': `^${packageJson.version}`,
+                    jest: packageJson.peerDependencies.jest,
+                    '@vyriy/storybook-config': `^${packageJson.version}`,
+                    storybook: packageJson.peerDependencies.storybook,
+                    '@vyriy/path': `^${packageJson.version}`,
+                    vyriy: `^${packageJson.version}`,
+                    husky: packageJson.peerDependencies.husky,
+                    'npm-run-all2': packageJson.peerDependencies['npm-run-all2'],
+                    'cross-env': packageJson.peerDependencies['cross-env'],
+                    react: packageJson.peerDependencies.react,
+                    'react-dom': packageJson.peerDependencies['react-dom'],
+                    '@types/react': packageJson.peerDependencies['@types/react'],
+                    '@types/react-dom': packageJson.peerDependencies['@types/react-dom'],
+                    '@vyriy/stylelint-config': `^${packageJson.version}`,
+                    stylelint: packageJson.peerDependencies.stylelint,
+                    rimraf: packageJson.peerDependencies.rimraf,
+                },
+            }, null, 2) + '\n',
+            'tsconfig.build.json': JSON.stringify({
+                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,
+                },
+            }, null, 2) + '\n',
+            'stylelint.config.ts': "export { default } from '@vyriy/stylelint-config';\n",
+            [`packages/${options.name}/package.json`]: JSON.stringify({
+                name: packageName,
+                version: '0.0.0',
+                description: options.description,
+                private: true,
+                type: 'module',
+                main: 'index.js',
+                dependencies: {
+                    '@vyriy/cn': `^${packageJson.version}`,
+                },
+                peerDependencies: {
+                    react: packageJson.peerDependencies.react,
+                },
+            }, null, 2) + '\n',
+            [`packages/${options.name}/README.md`]: `# ${packageName}\n\n${options.description}\n`,
+            [`packages/${options.name}/doc.mdx`]: `import { Meta, Markdown } from '@storybook/addon-docs/blocks';
+import ReadMe from './README.md?raw';
+
+<Meta title="UI/Button" />
+
+<Markdown>{ReadMe}</Markdown>
+`,
+            [`packages/${options.name}/index.ts`]: "export * from './button.js';\nexport type * from './types.js';\n",
+            [`packages/${options.name}/types.ts`]: `import type { ComponentProps, FC } from 'react';
+
+export type ButtonProps = ComponentProps<'button'> & {
+  readonly variant?: 'primary' | 'secondary';
+};
+
+export type ButtonType = FC<ButtonProps>;
+`,
+            [`packages/${options.name}/button.tsx`]: `import { cn } from '@vyriy/cn';
+
+import type { ButtonType } from './types.js';
+
+import './button.scss';
+
+export const Button: ButtonType = ({ className, variant = 'primary', ...props }) => (
+  <button type="button" className={cn('button', \`button--\${variant}\`, className)} {...props} />
+);
+`,
+            [`packages/${options.name}/index.test.ts`]: `import { describe, expect, it } from '@jest/globals';
+
+import { Button } from './button.js';
+import { Button as PublicButton } from './index.js';
+
+describe('ui entry point', () => {
+  it('exports Button', () => {
+    expect(PublicButton).toBe(Button);
+  });
+});
+`,
+            [`packages/${options.name}/button.scss`]: `.button {
+  border: 1px solid transparent;
+  border-radius: 6px;
+  cursor: pointer;
+  font: inherit;
+  padding: 0.5rem 0.875rem;
+}
+
+.button--primary {
+  background: #1f6feb;
+  color: #fff;
+}
+
+.button--secondary {
+  background: #fff;
+  border-color: #d0d7de;
+  color: #24292f;
+}
+`,
+            [`packages/${options.name}/styles.d.ts`]: "declare module '*.scss';\n",
+            [`packages/${options.name}/button.stories.tsx`]: `import type { Meta, StoryObj } from '@storybook/react-webpack5';
+
+import { Button } from './button.js';
+
+const meta = {
+  title: 'UI/Button',
+  component: Button,
+  args: {
+    children: 'Button',
+  },
+  argTypes: {
+    children: {
+      control: 'text',
+      description: 'Button label.',
+      table: {
+        type: { summary: 'ReactNode' },
+      },
+    },
+    variant: {
+      control: 'select',
+      options: ['primary', 'secondary'],
+      description: 'Visual style of the button.',
+      table: {
+        type: { summary: "'primary' | 'secondary'" },
+        defaultValue: { summary: 'primary' },
+      },
+    },
+    className: {
+      table: { disable: true },
+    },
+  },
+} satisfies Meta<typeof Button>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Primary: Story = {
+  args: {
+    variant: 'primary',
+  },
+};
+
+export const Secondary: Story = {
+  args: {
+    variant: 'secondary',
+  },
+};
+`,
+            [`packages/${options.name}/button.test.tsx`]: `import type { ReactElement } from 'react';
+import { describe, expect, it } from '@jest/globals';
+
+import { Button } from './button.js';
+
+type ButtonElement = ReactElement<{
+  readonly className: string;
+  readonly type: string;
+}>;
+
+describe('Button', () => {
+  it('creates a primary button by default', () => {
+    const element = Button({ children: 'Save' }) as ButtonElement;
+
+    expect(element.props.className).toBe('button button--primary');
+    expect(element.props.type).toBe('button');
+  });
+
+  it('composes secondary and custom classes', () => {
+    const element = Button({
+      children: 'Cancel',
+      className: 'wide',
+      type: 'submit',
+      variant: 'secondary',
+    }) as ButtonElement;
+
+    expect(element.props.className).toBe('button button--secondary wide');
+    expect(element.props.type).toBe('submit');
+  });
+});
+`,
+        };
+    },
+    ci: {
+        ...base.ci,
+    },
+    deploy: {},
+};

package/commands/create/preset/mfe.d.ts

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

package/commands/create/preset/mfe.js

@@ -0,0 +1,16 @@
+import { base } from './base.js';
+export const mfe = {
+    files: (options) => ({
+        ...base.files(options),
+    }),
+    ci: {
+        github: {
+            '.gitlab-ci.yml': 'code',
+        },
+    },
+    deploy: {
+        docker: {
+            Dockerfile: 'code',
+        },
+    },
+};

package/commands/create/preset/rest.d.ts

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

package/commands/create/preset/rest.js

@@ -0,0 +1,16 @@
+import { base } from './base.js';
+export const rest = {
+    files: (options) => ({
+        ...base.files(options),
+    }),
+    ci: {
+        github: {
+            '.gitlab-ci.yml': 'code',
+        },
+    },
+    deploy: {
+        docker: {
+            Dockerfile: 'code',
+        },
+    },
+};

package/commands/create/preset/spa.d.ts

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

package/commands/create/preset/spa.js

@@ -0,0 +1,16 @@
+import { base } from './base.js';
+export const spa = {
+    files: (options) => ({
+        ...base.files(options),
+    }),
+    ci: {
+        github: {
+            '.gitlab-ci.yml': 'code',
+        },
+    },
+    deploy: {
+        docker: {
+            Dockerfile: 'code',
+        },
+    },
+};

package/commands/create/preset/ssg.d.ts

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

package/commands/create/preset/ssg.js

@@ -0,0 +1,16 @@
+import { base } from './base.js';
+export const ssg = {
+    files: (options) => ({
+        ...base.files(options),
+    }),
+    ci: {
+        github: {
+            '.gitlab-ci.yml': 'code',
+        },
+    },
+    deploy: {
+        docker: {
+            Dockerfile: 'code',
+        },
+    },
+};

package/commands/create/preset/ssr.d.ts

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

package/commands/create/preset/ssr.js

@@ -0,0 +1,16 @@
+import { base } from './base.js';
+export const ssr = {
+    files: (options) => ({
+        ...base.files(options),
+    }),
+    ci: {
+        github: {
+            '.gitlab-ci.yml': 'code',
+        },
+    },
+    deploy: {
+        docker: {
+            Dockerfile: 'code',
+        },
+    },
+};

package/commands/create/preset/types.d.ts

@@ -0,0 +1,15 @@
+import type { PlanResult } from '../plan/types.js';
+export type FileMap = Record<string, string>;
+export type CiProvider = 'gitlab' | 'github';
+export type DeployProvider = 'aws' | 'docker';
+export type Preset = {
+    files: (options: PlanResult) => FileMap;
+    ci: Partial<Record<CiProvider, FileMap>>;
+    deploy: Partial<Record<DeployProvider, FileMap>>;
+};
+export type PresetKey = 'base' | 'library' | 'api' | 'ssr' | 'rest' | 'gql' | 'ssg' | 'spa' | 'mfe';
+export type Presets = Partial<Record<PresetKey, {
+    name: string;
+    description: string;
+    preset: Preset;
+}>>;

package/commands/create/prompt/conflict-strategy.d.ts

@@ -0,0 +1,5 @@
+export type ConflictStrategy = {
+    readonly overwrite: boolean;
+    readonly skipExisting: boolean;
+};
+export declare const conflictStrategy: () => Promise<ConflictStrategy | undefined>;

package/commands/create/prompt/conflict-strategy.js

@@ -0,0 +1,22 @@
+import { stdin, stdout } from 'node:process';
+import { createInterface } from 'node:readline/promises';
+export const conflictStrategy = async () => {
+    console.log('\nWhat should Vyriy do?\n');
+    console.log('  1. overwrite existing files');
+    console.log('  2. skip existing files');
+    console.log('  3. abort');
+    const readline = createInterface({ input: stdin, output: stdout });
+    try {
+        const answer = (await readline.question('\nWhat should Vyriy do? (abort): ')).trim().toLowerCase();
+        if (answer === '1' || answer === 'overwrite') {
+            return { overwrite: true, skipExisting: false };
+        }
+        if (answer === '2' || answer === 'skip') {
+            return { overwrite: false, skipExisting: true };
+        }
+        return undefined;
+    }
+    finally {
+        readline.close();
+    }
+};

package/commands/create/prompt/index.d.ts

@@ -0,0 +1,7 @@
+export * from './conflict-strategy.js';
+export * from './prompt.js';
+export * from './provider.js';
+export * from './preset.js';
+export * from './resolve-option.js';
+export * from './scope.js';
+export type * from './types.js';

package/commands/create/prompt/index.js

@@ -0,0 +1,6 @@
+export * from './conflict-strategy.js';
+export * from './prompt.js';
+export * from './provider.js';
+export * from './preset.js';
+export * from './resolve-option.js';
+export * from './scope.js';

package/commands/create/prompt/preset.d.ts

@@ -0,0 +1,4 @@
+import { presets as appPreset } from '../preset/index.js';
+import type { PromptOutput, PromptQuestion } from './types.js';
+export type PresetName = keyof typeof appPreset;
+export declare const preset: (question: PromptQuestion, output: PromptOutput) => Promise<PresetName>;

package/commands/create/prompt/preset.js

@@ -0,0 +1,11 @@
+import { presets as appPreset } from '../preset/index.js';
+import { prompt } from './prompt.js';
+import { resolveOption } from './resolve-option.js';
+export const preset = async (question, output) => {
+    const defaultPreset = 'base';
+    const presetNames = Object.keys(appPreset);
+    output.write('\nProject preset:\n\n');
+    presetNames.forEach((presetName, index) => output.write(`  ${index + 1}. ${appPreset[presetName].name} - ${appPreset[presetName].description}\n`));
+    const presetValue = await prompt(question, '\nPreset number or name', defaultPreset);
+    return resolveOption(presetValue, presetNames, defaultPreset);
+};

package/commands/create/prompt/prompt.d.ts

@@ -0,0 +1,2 @@
+import type { Prompt } from '../plan/types.js';
+export declare const prompt: Prompt;

package/commands/create/prompt/prompt.js

@@ -0,0 +1,4 @@
+export const prompt = async (question, label, defaultValue) => {
+    const answer = (await question(`${label} (${defaultValue}): `)).trim();
+    return answer || defaultValue;
+};

package/commands/create/prompt/provider.d.ts

@@ -0,0 +1,2 @@
+import type { PromptOutput, PromptQuestion } from './types.js';
+export declare const provider: <OptionName extends string>(question: PromptQuestion, output: PromptOutput, label: string, options: Partial<Record<OptionName, unknown>>) => Promise<OptionName | undefined>;

package/commands/create/prompt/provider.js

@@ -0,0 +1,13 @@
+import { prompt } from './prompt.js';
+import { resolveOption } from './resolve-option.js';
+export const provider = async (question, output, label, options) => {
+    const optionNames = Object.keys(options);
+    const defaultOption = optionNames[0];
+    if (defaultOption === undefined) {
+        return undefined;
+    }
+    output.write(`\n${label}:\n\n`);
+    optionNames.forEach((optionName, index) => output.write(`  ${index + 1}. ${optionName}\n`));
+    const optionValue = await prompt(question, `\n${label} number or name`, defaultOption);
+    return resolveOption(optionValue, optionNames);
+};

package/commands/create/prompt/resolve-option.d.ts

@@ -0,0 +1,6 @@
+type ResolveOption = {
+    <OptionName extends string>(value: string, optionNames: readonly OptionName[], fallback: OptionName): OptionName;
+    <OptionName extends string>(value: string, optionNames: readonly OptionName[]): OptionName | undefined;
+};
+export declare const resolveOption: ResolveOption;
+export {};

package/commands/create/prompt/resolve-option.js

@@ -0,0 +1,8 @@
+export const resolveOption = (value, optionNames, fallback) => {
+    const normalizedValue = value.trim();
+    const numericValue = Number.parseInt(normalizedValue, 10);
+    if (Number.isInteger(numericValue)) {
+        return optionNames[numericValue - 1] ?? fallback;
+    }
+    return optionNames.find((optionName) => optionName === normalizedValue) ?? fallback;
+};

package/commands/create/prompt/scope.d.ts

@@ -0,0 +1,2 @@
+import type { PromptQuestion } from './types.js';
+export declare const scope: (question: PromptQuestion, preset: string, name: string) => Promise<string | undefined>;

package/commands/create/prompt/scope.js

@@ -0,0 +1,2 @@
+import { prompt } from './prompt.js';
+export const scope = async (question, preset, name) => preset === 'library' ? prompt(question, 'Package scope', `@${name}`) : undefined;

package/commands/create/prompt/types.d.ts

@@ -0,0 +1,4 @@
+export type PromptQuestion = (query: string) => Promise<string>;
+export type PromptOutput = {
+    write: (chunk: string) => unknown;
+};

package/commands/dist.d.ts

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

package/commands/{publish/publish.js → dist.js}

@@ -60,6 +60,9 @@ const getPackageMain = async (packageDirectory, packageJson, javaScriptFiles) =>
     if (javaScriptFiles.includes('index.js')) {
         return 'index.js';
     }
+    if (getPackageBinFiles(packageJson).length > 0) {
+        return undefined;
+    }
     return javaScriptFiles[0];
 };
 const createExportTarget = (javaScriptFile) => {
@@ -174,9 +177,18 @@ const getPackageBinFiles = (packageJson) => {
     }
     return [];
 };
+const toPackageLocalPath = (filePath) => filePath.replace(/^\.\//, '');
+const removePackageBinDeclarationFiles = async (packageDirectory, packageJson) => {
+    for (const binFile of getPackageBinFiles(packageJson)) {
+        const declarationFilePath = path.join(packageDirectory, toPackageLocalPath(binFile).replace(/\.js$/, '.d.ts'));
+        if (await hasFile(declarationFilePath)) {
+            await unlink(declarationFilePath);
+        }
+    }
+};
 const makePackageBinsExecutable = async (packageDirectory, packageJson) => {
     for (const binFile of getPackageBinFiles(packageJson)) {
-        const binFilePath = path.join(packageDirectory, binFile.replace(/^\.\//, ''));
+        const binFilePath = path.join(packageDirectory, toPackageLocalPath(binFile));
         if (await hasFile(binFilePath)) {
             await chmod(binFilePath, 0o755);
         }
@@ -187,7 +199,7 @@ const copyRootFile = async (fileName) => {
         await copyFile(fileName, path.join(DIST_DIR, fileName));
     }
 };
-const publishRootPackageJson = async () => {
+const distRootPackageJson = async () => {
     const packageJson = await readJson(PACKAGE_JSON_FILE);
     delete packageJson.agents;
     delete packageJson.dependencies;
@@ -196,10 +208,10 @@ const publishRootPackageJson = async () => {
     delete packageJson.devDependencies;
     await writeJson(path.join(DIST_DIR, PACKAGE_JSON_FILE), packageJson);
 };
-const publishRoot = async () => {
+const distRoot = async () => {
     await copyRootFile(README_FILE);
     await copyRootFile(LICENSE_FILE);
-    await publishRootPackageJson();
+    await distRootPackageJson();
 };
 const syncPackageRuntimeMetadata = (packageJson, rootPackageJson) => {
     if (packageJson.name !== 'vyriy') {
@@ -208,12 +220,13 @@ const syncPackageRuntimeMetadata = (packageJson, rootPackageJson) => {
     packageJson.packageManager = rootPackageJson.packageManager;
     packageJson.engines = rootPackageJson.engines;
 };
-const publishPackage = async (packageJsonPath, rootPackageJson) => {
+const distPackage = async (packageJsonPath, rootPackageJson) => {
     const packageDirectory = path.dirname(packageJsonPath);
     const packageJson = await readJson(packageJsonPath);
     await removeEmptyJavaScriptFiles(packageDirectory);
     await removeMissingJavaScriptExports(packageDirectory);
     await removeEmptyJavaScriptFiles(packageDirectory);
+    await removePackageBinDeclarationFiles(packageDirectory, packageJson);
     const javaScriptFiles = await getJavaScriptFiles(packageDirectory);
     await copyLicense(packageDirectory);
     await copyReadme(packageDirectory);
@@ -250,12 +263,12 @@ const publishPackage = async (packageJsonPath, rootPackageJson) => {
     await makePackageBinsExecutable(packageDirectory, packageJson);
     await writeJson(packageJsonPath, packageJson);
 };
-export const runPublishCommand = async ({ cwd = process.cwd() } = {}) => {
+export const dist = async () => {
     const previousCwd = process.cwd();
     try {
-        process.chdir(cwd);
+        process.chdir(process.cwd());
         const rootPackageJson = await readJson(PACKAGE_JSON_FILE);
-        await publishRoot();
+        await distRoot();
         const entries = await readdir(DIST_DIR, { withFileTypes: true });
         const packageJsonPaths = entries
             .filter((entry) => entry.isDirectory())
@@ -263,7 +276,7 @@ export const runPublishCommand = async ({ cwd = process.cwd() } = {}) => {
             .sort((left, right) => left.localeCompare(right));
         for (const packageJsonPath of packageJsonPaths) {
             if (await hasFile(packageJsonPath)) {
-                await publishPackage(packageJsonPath, rootPackageJson);
+                await distPackage(packageJsonPath, rootPackageJson);
             }
         }
         return 0;

package/commands/help.d.ts

@@ -0,0 +1,3 @@
+import { Command } from './types.js';
+export declare const text = "Vyriy Project Master\n\nUsage:\n  vyriy [name]           Create a new Vyriy project\n  vyriy .                Initialize a new Vyriy project in the current directory\n  vyriy --help, -h       Show help\n  vyriy --version, -v    Show version\n  vyriy --check-env, -c  Check local environment\n  vyriy --dist, -d       Prepare dist package metadata without publishing to npm\n  vyriy --dry-run        Print checks and file plan without writing\n  vyriy --overwrite      Overwrite existing generated paths\n  vyriy --skip-existing  Leave existing generated paths untouched\n  vyriy --no-install     Create files without installing dependencies\n  vyriy --no-verify      Install dependencies without running checks\n\nExamples:\n  vyriy app\n  vyriy .\n  vyriy -d";
+export declare const help: Command;

package/commands/help.js

@@ -0,0 +1,24 @@
+export const text = `Vyriy Project Master
+
+Usage:
+  vyriy [name]           Create a new Vyriy project
+  vyriy .                Initialize a new Vyriy project in the current directory
+  vyriy --help, -h       Show help
+  vyriy --version, -v    Show version
+  vyriy --check-env, -c  Check local environment
+  vyriy --dist, -d       Prepare dist package metadata without publishing to npm
+  vyriy --dry-run        Print checks and file plan without writing
+  vyriy --overwrite      Overwrite existing generated paths
+  vyriy --skip-existing  Leave existing generated paths untouched
+  vyriy --no-install     Create files without installing dependencies
+  vyriy --no-verify      Install dependencies without running checks
+
+Examples:
+  vyriy app
+  vyriy .
+  vyriy -d`;
+export const help = async () => {
+    console.log(text);
+    await Promise.resolve();
+    return 0;
+};

package/commands/index.d.ts

@@ -0,0 +1,5 @@
+export * from './help.js';
+export * from './version.js';
+export * from './dist.js';
+export * from './check-env.js';
+export * from './create/index.js';

package/commands/index.js

@@ -0,0 +1,5 @@
+export * from './help.js';
+export * from './version.js';
+export * from './dist.js';
+export * from './check-env.js';
+export * from './create/index.js';