vyriy 0.3.2 → 0.3.5

package/presets/createProjectFiles.js

@@ -0,0 +1,179 @@
+import { agentsTemplate } from './agentsTemplate.js';
+const json = (value) => `${JSON.stringify(value, null, 2)}\n`;
+const createRootPackageJson = ({ 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: {
+            lint: 'eslint .',
+            test: 'jest --coverage=false',
+            build: 'tsc --pretty false',
+            deploy: 'echo "Deploy is not configured yet."',
+            smoke: 'echo "Smoke checks are not configured yet."',
+            e2e: 'echo "E2E checks are not configured yet."',
+        },
+        devDependencies: {},
+        workspaces: [
+            'packages/*',
+            'workspaces/*',
+        ],
+    }),
+});
+const createPackageManifest = ({ packageScope, workspaceName, }) => ({
+    path: `packages/${workspaceName}/package.json`,
+    content: json({
+        name: `${packageScope}/${workspaceName}`,
+        version: '0.1.0',
+        private: true,
+        type: 'module',
+        main: 'index.js',
+    }),
+});
+const createPackageFiles = (plan, packagePlan) => [
+    createPackageManifest({
+        packageScope: plan.packageScope,
+        workspaceName: packagePlan.name,
+    }),
+    {
+        path: `packages/${packagePlan.name}/README.md`,
+        content: `# ${plan.packageScope}/${packagePlan.name}\n\n${plan.description}\n`,
+    },
+    {
+        path: `packages/${packagePlan.name}/index.ts`,
+        content: packagePlan.kind === 'stack' ? "export * from './stack.js';\n" : "export type * from './types.js';\n",
+    },
+    ...(packagePlan.kind === 'stack'
+        ? [
+            {
+                path: `packages/${packagePlan.name}/stack.ts`,
+                content: 'export type StackName = string;\n',
+            },
+            {
+                path: `packages/${packagePlan.name}/stack.test.ts`,
+                content: "import { describe, expect, it } from '@jest/globals';\n\ndescribe('stack', () => {\n  it('has a test harness', () => {\n    expect(true).toBe(true);\n  });\n});\n",
+            },
+        ]
+        : [
+            {
+                path: `packages/${packagePlan.name}/types.ts`,
+                content: 'export type PackageName = string;\n',
+            },
+            {
+                path: `packages/${packagePlan.name}/${packagePlan.name}.test.ts`,
+                content: "import { describe, expect, it } from '@jest/globals';\n\ndescribe('package', () => {\n  it('has a test harness', () => {\n    expect(true).toBe(true);\n  });\n});\n",
+            },
+        ]),
+];
+const createWorkspaceFiles = (plan, workspacePlan) => [
+    {
+        path: `workspaces/${workspacePlan.name}/package.json`,
+        content: json({
+            name: `${plan.packageScope}/${workspacePlan.name}-workspace`,
+            version: '0.1.0',
+            private: true,
+            type: 'module',
+            main: 'index.js',
+        }),
+    },
+    {
+        path: `workspaces/${workspacePlan.name}/index.ts`,
+        content: 'export type WorkspaceName = string;\n',
+    },
+    {
+        path: `workspaces/${workspacePlan.name}/${workspacePlan.name}.test.ts`,
+        content: "import { describe, expect, it } from '@jest/globals';\n\ndescribe('workspace', () => {\n  it('has a test harness', () => {\n    expect(true).toBe(true);\n  });\n});\n",
+    },
+];
+const shouldCreateStylelintConfig = (plan) => plan.features.some((feature) => [
+    'react',
+    'webpack',
+].includes(feature));
+export const createProjectFiles = (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';\nimport ReadMe from './README.md?raw';\n\n<Meta title=\"Project/README\" />\n\n<Markdown>{ReadMe}</Markdown>\n",
+    },
+    {
+        path: 'AGENTS.md',
+        content: agentsTemplate,
+    },
+    {
+        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: '.npmrc',
+        content: 'engine-strict=true\n',
+    },
+    {
+        path: '.nvmrc',
+        content: '24\n',
+    },
+    {
+        path: '.yarnrc.yml',
+        content: 'nodeLinker: node-modules\n',
+    },
+    {
+        path: 'yarn.lock',
+        content: '',
+    },
+    {
+        path: 'tsconfig.json',
+        content: json({
+            extends: '@vyriy/typescript-config/index.json',
+            compilerOptions: {
+                noEmit: false,
+            },
+            include: [
+                'packages/**/*.ts',
+                'packages/**/*.tsx',
+                'workspaces/**/*.ts',
+                'workspaces/**/*.tsx',
+                '*.ts',
+            ],
+        }),
+    },
+    {
+        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",
+    },
+    ...(shouldCreateStylelintConfig(plan)
+        ? [
+            {
+                path: 'stylelint.config.ts',
+                content: "export { default } from '@vyriy/stylelint-config';\n",
+            },
+        ]
+        : []),
+    ...plan.packages.flatMap((packagePlan) => createPackageFiles(plan, packagePlan)),
+    ...plan.workspaces.flatMap((workspacePlan) => createWorkspaceFiles(plan, workspacePlan)),
+];

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/project-plan/ci/ci.d.ts

@@ -1,3 +1,3 @@
 import { CreateCiPlan } from './types.js';
-export declare const defaultValidationPipelines: readonly ["install", "typecheck", "lint", "prettier", "test", "build"];
+export declare const defaultValidationPipelines: readonly ["install", "lint", "test", "build", "deploy", "smoke", "e2e"];
 export declare const createCiPlan: CreateCiPlan;

package/project-plan/ci/ci.js

@@ -1,10 +1,11 @@
 export const defaultValidationPipelines = [
     'install',
-    'typecheck',
     'lint',
-    'prettier',
     'test',
     'build',
+    'deploy',
+    'smoke',
+    'e2e',
 ];
 export const createCiPlan = ({ provider = 'none' } = {}) => provider === 'none'
     ? {

package/project-plan/create/create.js

@@ -6,9 +6,10 @@ const baseFeatures = [
     'eslint',
     'prettier',
     'jest',
+    'storybook',
 ];
 const presetFeatures = {
-    library: ['react', 'storybook'],
+    library: ['react'],
     api: [],
     'react-csr': ['react', 'webpack'],
     'react-ssr': ['react', 'webpack'],
@@ -23,7 +24,11 @@ const presetFeatures = {
         'bff',
     ],
     fullstack: ['react', 'webpack'],
-    'aws-serverless': ['aws-cdk', 'lambda', 'dynamodb'],
+    'aws-serverless': [
+        'aws-cdk',
+        'lambda',
+        'apigateway',
+    ],
     empty: [],
 };
 const packagePlans = {
@@ -71,7 +76,7 @@ const packagePlans = {
     ],
     'aws-serverless': [
         { name: 'api', kind: 'api', publishable: false },
-        { name: 'infrastructure', kind: 'core', publishable: false },
+        { name: 'stack', kind: 'stack', publishable: false },
     ],
     empty: [],
 };
@@ -105,7 +110,7 @@ const workspacePlans = {
         { name: 'web', kind: 'web' },
         { name: 'api', kind: 'api' },
     ],
-    'aws-serverless': [{ name: 'cdk', kind: 'cdk' }],
+    'aws-serverless': [{ name: 'stack', kind: 'stack' }],
     empty: [],
 };
 const uniqueFeatures = (features) => [...new Set(features)];

package/project-plan/types.d.ts

@@ -1,24 +1,24 @@
 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 VyriyFeature = 'typescript' | 'eslint' | 'prettier' | 'jest' | 'rest-api' | 'graphql-api' | 'react' | 'storybook' | 'webpack' | 'docker' | 'aws-cdk' | 'apigateway' | 'lambda' | 'fargate' | 's3' | 'cloudfront' | 'openmfe' | 'bff';
 export type VyriyPackagePlan = {
     readonly name: string;
-    readonly kind: 'core' | 'ui' | 'api' | 'bff' | 'ssr' | 'ssg' | 'mfe' | 'contract';
+    readonly kind: 'core' | 'ui' | 'api' | 'bff' | 'ssr' | 'ssg' | 'mfe' | 'contract' | 'stack';
     readonly publishable: boolean;
 };
 export type VyriyWorkspacePlan = {
     readonly name: string;
-    readonly kind: 'web' | 'api' | 'ssr' | 'ssg' | 'storybook' | 'bff' | 'mfe' | 'openmfe' | 'cdk';
+    readonly kind: 'web' | 'api' | 'ssr' | 'ssg' | 'storybook' | 'bff' | 'mfe' | 'openmfe' | 'stack';
 };
 export type VyriyCiProvider = 'gitlab' | 'github';
-export type VyriyCiPipeline = 'install' | 'typecheck' | 'lint' | 'prettier' | 'test' | 'build' | 'storybook' | 'docker' | 'npm-publish' | 'aws-deploy';
+export type VyriyCiPipeline = 'install' | 'lint' | 'test' | 'build' | 'deploy' | 'smoke' | 'e2e';
 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 VyriyApiRuntime = 'node' | 'lambda';
 export type VyriyApiPlan = {
     readonly enabled: boolean;
     readonly style: VyriyApiStyle;

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

@@ -16,10 +16,33 @@ const presets = [
     'empty',
 ];
 const extraFeatures = [
-    'storybook',
+    'docker',
+    'aws-api',
+    'aws-fargate',
+    'aws-static',
+];
+const extraFeatureMap = {
+    docker: ['docker'],
+    'aws-api': [
+        'aws-cdk',
+        'lambda',
+        'apigateway',
+    ],
+    'aws-fargate': [
+        'aws-cdk',
+        'fargate',
+        'docker',
+    ],
+    'aws-static': [
+        'aws-cdk',
+        's3',
+        'cloudfront',
+    ],
+};
+const directFeatureInputs = [
     'docker',
     'aws-cdk',
-    'dynamodb',
+    'apigateway',
     'lambda',
     'fargate',
     's3',
@@ -64,10 +87,15 @@ const parsePreset = (value, defaultValue) => {
     }
     return presets.includes(normalizedValue) ? normalizedValue : defaultValue;
 };
-const parseFeatures = (value) => value
-    .split(',')
-    .map((feature) => feature.trim())
-    .filter((feature) => extraFeatures.includes(feature));
+const parseFeatures = (value) => [
+    ...new Set(value
+        .split(',')
+        .map((feature) => feature.trim())
+        .flatMap((feature) => extraFeatureMap[feature] ??
+        (directFeatureInputs.includes(feature)
+            ? [feature]
+            : []))),
+];
 const parseApiStyle = (value, defaultValue) => {
     const normalizedValue = value.trim().toLowerCase();
     const numericValue = Number.parseInt(normalizedValue, 10);
@@ -109,9 +137,9 @@ export const askProjectPlan = async ({ defaults = {}, input = stdin, output = st
         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('\nAdditional infrastructure, comma-separated:\n');
         output.write(`  ${extraFeatures.join(', ')}\n`);
-        const featuresAnswer = await promptWithDefault(question, 'Features', defaults.features?.join(', ') ?? '');
+        const featuresAnswer = await promptWithDefault(question, 'Infrastructure', defaults.features?.join(', ') ?? '');
         const features = parseFeatures(featuresAnswer);
         const plan = createProjectPlanFromPreset({
             projectName,

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;
+};

package/shared/types.d.ts

@@ -0,0 +1,5 @@
+export type ExecCommand = (command: string, args?: readonly string[]) => Promise<string>;
+export type CommandExists = (command: string, options?: {
+    readonly execCommand?: ExecCommand;
+}) => Promise<boolean>;
+export type FileExists = (filePath: string) => Promise<boolean>;