vyriy 0.0.0 → 0.2.0

package/project-plan/print/print.d.ts

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

package/project-plan/print/print.js

@@ -0,0 +1,47 @@
+const printList = (values) => values.length === 0 ? '  - none' : values.map((value) => `  - ${value}`).join('\n');
+const printCi = (plan) => plan.ci.enabled
+    ? `CI/CD:
+  enabled: yes
+  providers:
+${printList(plan.ci.providers)}
+  pipelines:
+${printList(plan.ci.pipelines)}
+`
+    : `CI/CD:
+  enabled: no
+`;
+const printApi = (plan) => {
+    if (!plan.api) {
+        return '';
+    }
+    const rest = plan.api.rest
+        ? `  REST:
+    router: ${plan.api.rest.packageName}
+`
+        : '';
+    const graphql = plan.api.graphql
+        ? `  GraphQL:
+    package: ${plan.api.graphql.packageName}
+`
+        : '';
+    return `API:
+  style: ${plan.api.style}
+  runtime: ${plan.api.runtime}
+${rest}${graphql}`;
+};
+export const printProjectPlan = (plan) => `Project summary:
+
+Name: ${plan.projectName}
+Target directory: ${plan.targetDirectory}
+Scope: ${plan.packageScope}
+Description: ${plan.description}
+Preset: ${plan.preset}
+Kind: ${plan.projectKind}
+Features:
+${printList(plan.features)}
+Packages:
+${printList(plan.packages.map((packagePlan) => `${packagePlan.name} (${packagePlan.kind})`))}
+Workspaces:
+${printList(plan.workspaces.map((workspacePlan) => `${workspacePlan.name} (${workspacePlan.kind})`))}
+${printApi(plan)}${printCi(plan)}
+`;

package/project-plan/print/types.d.ts

@@ -0,0 +1,2 @@
+import { VyriyProjectPlan } from '../types.js';
+export type PrintProjectPlan = (plan: VyriyProjectPlan) => string;

package/project-plan/types.d.ts

@@ -0,0 +1,46 @@
+export type VyriyProjectKind = 'library' | 'api' | 'csr' | 'ssr' | 'ssg' | 'mfe' | 'fullstack' | 'aws-serverless' | 'empty';
+export type VyriyPreset = 'library' | 'api' | 'react-csr' | 'react-ssr' | 'react-ssg' | 'mfe' | 'openmfe' | 'mfe-bff' | 'openmfe-bff' | 'fullstack' | 'aws-serverless' | 'empty';
+export type VyriyFeature = 'typescript' | 'eslint' | 'prettier' | 'jest' | 'rest-api' | 'graphql-api' | 'react' | 'storybook' | 'webpack' | 'docker' | 'aws-cdk' | 'dynamodb' | 'lambda' | 'fargate' | 's3' | 'cloudfront' | 'openmfe' | 'bff';
+export type VyriyPackagePlan = {
+    readonly name: string;
+    readonly kind: 'core' | 'ui' | 'api' | 'bff' | 'ssr' | 'ssg' | 'mfe' | 'contract';
+    readonly publishable: boolean;
+};
+export type VyriyWorkspacePlan = {
+    readonly name: string;
+    readonly kind: 'web' | 'api' | 'ssr' | 'ssg' | 'storybook' | 'bff' | 'mfe' | 'openmfe' | 'cdk';
+};
+export type VyriyCiProvider = 'gitlab' | 'github';
+export type VyriyCiPipeline = 'install' | 'typecheck' | 'lint' | 'prettier' | 'test' | 'build' | 'storybook' | 'docker' | 'npm-publish' | 'aws-deploy';
+export type VyriyCiPlan = {
+    readonly enabled: boolean;
+    readonly providers: VyriyCiProvider[];
+    readonly pipelines: VyriyCiPipeline[];
+};
+export type VyriyApiStyle = 'rest' | 'graphql' | 'mixed';
+export type VyriyApiRuntime = 'node' | 'lambda' | 'fargate';
+export type VyriyApiPlan = {
+    readonly enabled: boolean;
+    readonly style: VyriyApiStyle;
+    readonly runtime: VyriyApiRuntime;
+    readonly rest?: {
+        readonly router: 'vyriy-router';
+        readonly packageName: '@vyriy/router';
+    };
+    readonly graphql?: {
+        readonly packageName: 'graphql';
+    };
+};
+export type VyriyProjectPlan = {
+    readonly projectName: string;
+    readonly targetDirectory: string;
+    readonly packageScope: string;
+    readonly description: string;
+    readonly projectKind: VyriyProjectKind;
+    readonly preset: VyriyPreset;
+    readonly features: VyriyFeature[];
+    readonly packages: VyriyPackagePlan[];
+    readonly workspaces: VyriyWorkspacePlan[];
+    readonly ci: VyriyCiPlan;
+    readonly api?: VyriyApiPlan;
+};

package/prompts/project-plan/index.d.ts

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

package/prompts/project-plan/index.js

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

package/prompts/project-plan/project-plan.d.ts

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

package/prompts/project-plan/project-plan.js

@@ -0,0 +1,132 @@
+import { stdin, stdout } from 'node:process';
+import { createInterface } from 'node:readline';
+import { createProjectPlanFromPreset, getDefaultApiStyleFromPreset, isApiPreset, } from '../../project-plan/index.js';
+const presets = [
+    'library',
+    'api',
+    'react-csr',
+    'react-ssr',
+    'react-ssg',
+    'mfe',
+    'openmfe',
+    'mfe-bff',
+    'openmfe-bff',
+    'fullstack',
+    'aws-serverless',
+    'empty',
+];
+const extraFeatures = [
+    'storybook',
+    'docker',
+    'aws-cdk',
+    'dynamodb',
+    'lambda',
+    'fargate',
+    's3',
+    'cloudfront',
+];
+const apiStyles = ['rest', 'graphql', 'mixed'];
+const ciProviders = ['none', 'gitlab', 'github'];
+const createQuestion = (readline, output) => {
+    const queuedLines = [];
+    const pendingQuestions = [];
+    readline.on('line', (line) => {
+        const resolve = pendingQuestions.shift();
+        if (resolve) {
+            resolve(line);
+            return;
+        }
+        queuedLines.push(line);
+    });
+    readline.on('close', () => {
+        for (const resolve of pendingQuestions.splice(0)) {
+            resolve('');
+        }
+    });
+    return (query) => {
+        output.write(query);
+        const queuedLine = queuedLines.shift();
+        if (queuedLine !== undefined) {
+            return Promise.resolve(queuedLine);
+        }
+        return new Promise((resolve) => pendingQuestions.push(resolve));
+    };
+};
+const promptWithDefault = async (question, label, defaultValue) => {
+    const answer = (await question(`${label} (${defaultValue}): `)).trim();
+    return answer || defaultValue;
+};
+const parsePreset = (value, defaultValue) => {
+    const normalizedValue = value.trim();
+    const numericValue = Number.parseInt(normalizedValue, 10);
+    if (Number.isInteger(numericValue) && presets[numericValue - 1]) {
+        return presets[numericValue - 1];
+    }
+    return presets.includes(normalizedValue) ? normalizedValue : defaultValue;
+};
+const parseFeatures = (value) => value
+    .split(',')
+    .map((feature) => feature.trim())
+    .filter((feature) => extraFeatures.includes(feature));
+const parseApiStyle = (value, defaultValue) => {
+    const normalizedValue = value.trim().toLowerCase();
+    const numericValue = Number.parseInt(normalizedValue, 10);
+    if (Number.isInteger(numericValue) && apiStyles[numericValue - 1]) {
+        return apiStyles[numericValue - 1];
+    }
+    return apiStyles.includes(normalizedValue) ? normalizedValue : defaultValue;
+};
+const parseCiProvider = (value, defaultValue) => {
+    const normalizedValue = value.trim().toLowerCase();
+    const numericValue = Number.parseInt(normalizedValue, 10);
+    if (Number.isInteger(numericValue) && ciProviders[numericValue - 1]) {
+        return ciProviders[numericValue - 1];
+    }
+    return ciProviders.includes(normalizedValue)
+        ? normalizedValue
+        : defaultValue;
+};
+export const askProjectPlan = async ({ defaults = {}, input = stdin, output = stdout } = {}) => {
+    const readline = createInterface({ input, output });
+    const question = createQuestion(readline, output);
+    try {
+        output.write('Vyriy Project Master\n\n');
+        const projectName = await promptWithDefault(question, 'Project name', defaults.projectName ?? 'my-app');
+        const targetDirectory = await promptWithDefault(question, 'Target directory', defaults.targetDirectory ?? projectName);
+        const packageScope = await promptWithDefault(question, 'Package scope', defaults.packageScope ?? `@${projectName}`);
+        const description = await promptWithDefault(question, 'Description', defaults.description ?? 'Calm cloud-ready application.');
+        output.write('\nProject preset:\n');
+        presets.forEach((preset, index) => output.write(`  ${index + 1}. ${preset}\n`));
+        const presetAnswer = await promptWithDefault(question, 'Preset number or name', defaults.preset ?? 'react-ssr');
+        const preset = parsePreset(presetAnswer, defaults.preset ?? 'react-ssr');
+        const defaultApiStyle = defaults.apiStyle ?? getDefaultApiStyleFromPreset(preset);
+        const apiStyle = isApiPreset(preset)
+            ? parseApiStyle(await promptWithDefault(question, 'API style: 1. rest (@vyriy/router), 2. graphql, 3. mixed', defaultApiStyle), defaultApiStyle)
+            : undefined;
+        output.write('\nCI/CD provider:\n');
+        output.write('  1. none\n');
+        output.write('  2. gitlab\n');
+        output.write('  3. github\n');
+        const defaultCiProvider = defaults.ciProvider ?? 'none';
+        const ciProvider = parseCiProvider(await promptWithDefault(question, 'CI/CD provider number or name', defaultCiProvider), defaultCiProvider);
+        output.write('\nAdditional features, comma-separated:\n');
+        output.write(`  ${extraFeatures.join(', ')}\n`);
+        const featuresAnswer = await promptWithDefault(question, 'Features', defaults.features?.join(', ') ?? '');
+        const features = parseFeatures(featuresAnswer);
+        const plan = createProjectPlanFromPreset({
+            projectName,
+            targetDirectory,
+            packageScope,
+            description,
+            preset,
+            features,
+            apiStyle,
+            ciProvider,
+        });
+        const confirmation = (await promptWithDefault(question, 'Use this project plan?', 'yes')).toLowerCase();
+        return confirmation === 'yes' || confirmation === 'y' ? plan : undefined;
+    }
+    finally {
+        readline.close();
+    }
+};

package/prompts/project-plan/types.d.ts

@@ -0,0 +1,18 @@
+import { Readable, Writable } from 'node:stream';
+import { VyriyApiStyle, VyriyCiPromptProvider, VyriyFeature, VyriyPreset, VyriyProjectPlan } from '../../project-plan/index.js';
+export type PromptProjectPlanDefaults = {
+    readonly projectName?: string;
+    readonly targetDirectory?: string;
+    readonly packageScope?: string;
+    readonly description?: string;
+    readonly preset?: VyriyPreset;
+    readonly features?: readonly VyriyFeature[];
+    readonly apiStyle?: VyriyApiStyle;
+    readonly ciProvider?: VyriyCiPromptProvider;
+};
+export type PromptProjectPlanOptions = {
+    readonly defaults?: PromptProjectPlanDefaults;
+    readonly input?: Readable;
+    readonly output?: Writable;
+};
+export type PromptProjectPlan = (options?: PromptProjectPlanOptions) => Promise<VyriyProjectPlan | undefined>;