create-sy 2.5.0 → 2.5.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "create-sy",
   "displayName": "Syngrisi Setup Package",
-  "version": "2.5.0",
+  "version": "2.5.1",
   "description": "Easily install and configure Syngrisi for visual testing.",
   "author": {
     "name": "Viktar Silakou",
@@ -31,6 +31,9 @@
     "create-sy": "./bin/sy.js"
   },
   "type": "module",
+  "engines": {
+    "node": ">=22.19.0"
+  },
   "scripts": {
     "build": "run-s clean compile",
     "clean": "rimraf tsconfig.tsbuildinfo ./build ./coverage",
@@ -73,5 +76,9 @@
     "cross-spawn": "^7.0.3",
     "semver": "^7.7.3"
   },
-  "gitHead": "12bfda406cbe5aaccf3f17fdab02a9bd1a9d6343"
+  "files": [
+    "build",
+    "bin"
+  ],
+  "gitHead": "0c9cedf39168bce54fd23fc2ded183a5741c373b"
 }

package/.eslintrc.cjs

@@ -1,44 +0,0 @@
-module.exports = {
-    root: true,
-    parser: '@typescript-eslint/parser',
-    plugins: ['@typescript-eslint'],
-    extends: [
-        'eslint:recommended',
-        'plugin:import/errors',
-        'plugin:import/warnings'
-    ],
-    env: {
-        node: true,
-        es6: true,
-        jest: true
-    },
-    parserOptions: {
-        ecmaVersion: 2019,
-        sourceType: 'module'
-    },
-    rules: {
-        semi: ['error', 'never'],
-        quotes: ['error', 'single'],
-        indent: [2, 4],
-
-        'no-constant-condition': 0,
-        // see https://stackoverflow.com/questions/55280555/typescript-eslint-eslint-plugin-error-route-is-defined-but-never-used-no-un
-        'no-unused-vars': 'off',
-        '@typescript-eslint/no-unused-vars': 'error',
-
-        'import/no-unresolved': 0,
-        'import/named': 2,
-        'import/namespace': 2,
-        'import/default': 2,
-        'import/export': 2,
-
-    },
-    overrides: [
-        {
-            files: ['*.ts'],
-            rules: {
-                'no-undef': 'off'
-            }
-        }
-    ]
-}

package/CHANGELOG.md

@@ -1,5 +0,0 @@
-# create-sy
-
-## 2.5.0
-
-## 2.4.1

package/docs/E2E_TESTS_REPORT.md

@@ -1,241 +0,0 @@
-# E2E Tests Implementation Report
-
-## Overview
-
-This document describes the work done on implementing E2E tests for the `create-sy` package using Apple Container CLI.
-
-## Completed Work
-
-### 1. E2E Test Infrastructure
-
-Created a complete e2e test infrastructure using Apple Container CLI:
-
-**Files created:**
-- `e2e/vitest.e2e.config.ts` - Vitest configuration for e2e tests
-- `e2e/fixtures/container.fixture.ts` - Container test fixture with helper functions
-- `e2e/utils/container-cli.ts` - Wrapper for Apple Container CLI operations
-- `e2e/container/start-containers.sh` - Script to build container images
-- `e2e/container/Dockerfile.node` - Dockerfile template for Node.js containers
-
-**Test files created:**
-- `e2e/tests/node-versions/node18.e2e.ts` - Node.js 18 compatibility tests
-- `e2e/tests/node-versions/node20.e2e.ts` - Node.js 20 compatibility tests
-- `e2e/tests/node-versions/node22.e2e.ts` - Node.js 22 compatibility tests
-- `e2e/tests/installation/npm-tag-latest.e2e.ts` - Latest version installation tests
-- `e2e/tests/installation/npm-tag-specific.e2e.ts` - Specific version installation tests
-- `e2e/tests/installation/npm-tag-invalid.e2e.ts` - Invalid tag validation tests
-- `e2e/tests/full-flow/install-and-start.e2e.ts` - Full installation flow tests
-
-### 2. Security Improvements
-
-Added `validateNpmTag()` function to prevent command injection:
-
-```typescript
-// src/utils.ts
-export function validateNpmTag(tag: string): void {
-    const forbiddenChars = /[;&|`$(){}[\]<>\\!#'"*?\n\r]/
-    if (forbiddenChars.test(tag)) {
-        throw new Error(`Invalid npmTag: contains forbidden characters`)
-    }
-    if (tag.length > 100) {
-        throw new Error(`Invalid npmTag: exceeds maximum length of 100 characters`)
-    }
-}
-```
-
-### 3. CLI Improvements
-
-Added `--yes` flag support for non-interactive mode:
-
-```typescript
-// src/createSyngrisiProject.ts
-const args = yargs(hideBin(process.argv))
-    .option('yes', {
-        alias: 'y',
-        type: 'boolean',
-        description: 'Skip confirmation prompts',
-        default: false,
-    })
-```
-
-### 4. Unit Tests
-
-All 24 unit tests passing with 100% coverage:
-- `validateNpmTag()` validation tests
-- CLI argument parsing tests
-- Package installation tests
-
-## Problems Encountered
-
-### 1. XPC Connection Interrupted Errors
-
-**Problem:** Apple Container CLI threw `XPC connection interrupted` errors when running containers.
-
-**Error message:**
-```
-internalError: "failed to wait for process...XPC connection error: Connection interrupted"
-```
-
-**Solution:** Added `container system start` call before running containers:
-```bash
-# e2e/container/start-containers.sh
-start_container_system() {
-    log_info "Starting container system service..."
-    container system start 2>/dev/null || true
-    log_info "Container system service started"
-}
-```
-
-**Reference:** https://github.com/apple/container/issues/699
-
-### 2. npm init Flags Not Passed to create-sy
-
-**Problem:** Flags like `-y -f` were consumed by `npm init` instead of being passed to create-sy.
-
-**Wrong approach:**
-```bash
-npm init sy@latest -y -f  # -y -f consumed by npm init
-```
-
-**Solution:** Use `--` separator to pass flags through:
-```bash
-npm init sy@latest -- --yes --force  # flags passed to create-sy
-```
-
-### 3. Shell Command Escaping in Containers
-
-**Problem:** Commands weren't being executed properly in containers due to escaping issues.
-
-**Solution:** Fixed escaping in `container-cli.ts`:
-```typescript
-// Use single quotes around the shell command
-const shellCommand = command.join(' && ')
-execSync(`container ${args.join(' ')} sh -c '${shellCommand}'`, {...})
-```
-
-### 4. Container Process Crashes (Exit Code 139)
-
-**Problem:** Some tests fail with exit code 139 (SIGSEGV) during npm installation.
-
-**Hypothesis tested:**
-- Memory issues in containers (increased memory allocation)
-- Timeout issues (increased to 5 minutes)
-- Concurrent container execution (switched to sequential with `singleFork: true`)
-
-**Status:** Not fully resolved. The issue appears to be related to npm installation inside containers crashing intermittently.
-
-### 5. Long Test Execution Time
-
-**Problem:** Tests take extremely long to complete (5+ minutes per test).
-
-**Cause:**
-- Each test starts a new container
-- Downloads create-sy from npm
-- Runs npm install which downloads all syngrisi dependencies
-
-**Current configuration:**
-```typescript
-// vitest.e2e.config.ts
-testTimeout: 300_000, // 5 minutes per test
-pool: 'forks',
-poolOptions: {
-    forks: {
-        singleFork: true, // Sequential execution
-    },
-},
-```
-
-## Test Results
-
-### Passing Tests
-
-| Test | Status | Duration |
-|------|--------|----------|
-| Node.js 18 environment verification | PASS | ~10s |
-| Node.js 20 environment verification | PASS | ~10s |
-| Node.js 22 environment verification | PASS | ~10s |
-
-### Failing/Unstable Tests
-
-| Test | Status | Issue |
-|------|--------|-------|
-| npm init sy@latest installs syngrisi | FAIL | Exit code 139 (SIGSEGV) |
-| Installation with specific version | UNSTABLE | Container crashes |
-| Full flow installation | UNSTABLE | Long timeout/crashes |
-
-## What's Not Done
-
-### 1. Stable npm Installation Tests
-The tests that actually run `npm init sy@latest` inside containers are unstable due to:
-- Container crashes (exit code 139)
-- Long execution times
-- Memory/resource issues
-
-### 2. Local Package Testing
-Currently tests download published `create-sy` from npm. A mechanism to test local unpublished changes would be beneficial:
-- Could use `npm pack` + volume mount
-- Or npm link approach inside containers
-
-### 3. CI Integration
-E2E tests are not yet integrated into CI pipeline:
-- Apple Container CLI only works on macOS
-- Would need self-hosted macOS runners
-- Or alternative containerization approach for Linux CI
-
-### 4. Security Validation Tests
-Tests for invalid npmTag are written but not fully verified:
-- `rejects dangerous characters in tag`
-- `rejects tag with shell metacharacters`
-
-## Recommendations
-
-1. **Short term:** Mark npm installation e2e tests as `@slow` or `@unstable` and run them separately
-2. **Medium term:** Investigate container memory/resource limits for stability
-3. **Long term:** Consider Docker-based tests for CI compatibility
-
-## File Structure
-
-```
-packages/create-sy/
-├── e2e/
-│   ├── container/
-│   │   ├── Dockerfile.node
-│   │   └── start-containers.sh
-│   ├── fixtures/
-│   │   └── container.fixture.ts
-│   ├── tests/
-│   │   ├── full-flow/
-│   │   │   └── install-and-start.e2e.ts
-│   │   ├── installation/
-│   │   │   ├── npm-tag-invalid.e2e.ts
-│   │   │   ├── npm-tag-latest.e2e.ts
-│   │   │   └── npm-tag-specific.e2e.ts
-│   │   └── node-versions/
-│   │       ├── node18.e2e.ts
-│   │       ├── node20.e2e.ts
-│   │       └── node22.e2e.ts
-│   ├── utils/
-│   │   └── container-cli.ts
-│   └── vitest.e2e.config.ts
-├── src/
-│   ├── utils.ts          # Added validateNpmTag()
-│   └── createSyngrisiProject.ts  # Added --yes flag
-└── tests/
-    └── *.test.ts         # 24 unit tests (100% coverage)
-```
-
-## Commands
-
-```bash
-# Run unit tests
-npm test
-
-# Run e2e tests (requires Apple Container CLI)
-npm run test:e2e
-
-# Run only environment verification tests (fast)
-npx vitest run --config e2e/vitest.e2e.config.ts --testNamePattern "verifies Node.js"
-
-# Build container images only
-npm run e2e:setup
-```

package/e2e/config.ts

@@ -1,21 +0,0 @@
-import { resolve } from 'node:path'
-
-export const config = {
-    // Timeouts (in milliseconds)
-    containerStartTimeout: 60_000,
-    npmInstallTimeout: 180_000, // 3 minutes for npm install
-    serverStartTimeout: 60_000,
-    testTimeout: 300_000, // 5 minutes per test
-
-    // Paths
-    createSyRoot: resolve(import.meta.dirname, '..'),
-    e2eRoot: resolve(import.meta.dirname),
-
-    // Container settings
-    nodeVersions: ['18', '20', '22'] as const,
-
-    // npm registry
-    npmRegistry: process.env.NPM_REGISTRY || 'https://registry.npmjs.org',
-} as const
-
-export type NodeVersion = typeof config.nodeVersions[number]

package/e2e/container/Dockerfile.node18

@@ -1,8 +0,0 @@
-FROM node:18-alpine
-
-WORKDIR /test-project
-
-# Verify node version
-RUN node --version && npm --version
-
-CMD ["sh"]

package/e2e/container/Dockerfile.node20

@@ -1,8 +0,0 @@
-FROM node:20-alpine
-
-WORKDIR /test-project
-
-# Verify node version
-RUN node --version && npm --version
-
-CMD ["sh"]

package/e2e/container/Dockerfile.node22

@@ -1,8 +0,0 @@
-FROM node:22-alpine
-
-WORKDIR /test-project
-
-# Verify node version
-RUN node --version && npm --version
-
-CMD ["sh"]

package/e2e/container/start-containers.sh

@@ -1,67 +0,0 @@
-#!/bin/bash
-set -e
-
-SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
-
-# Colors
-GREEN='\033[0;32m'
-YELLOW='\033[1;33m'
-RED='\033[0;31m'
-NC='\033[0m'
-
-log_info() { echo -e "${GREEN}[INFO]${NC} $1"; }
-log_warn() { echo -e "${YELLOW}[WARN]${NC} $1"; }
-log_error() { echo -e "${RED}[ERROR]${NC} $1"; }
-
-check_container_cli() {
-    if ! command -v container &> /dev/null; then
-        log_error "Apple container CLI not found"
-        echo "See: https://github.com/apple/container"
-        exit 1
-    fi
-    log_info "Apple container CLI found"
-}
-
-start_container_system() {
-    log_info "Starting container system service..."
-    # This fixes XPC connection errors
-    # See: https://github.com/apple/container/issues/699
-    container system start 2>/dev/null || true
-    log_info "Container system service started"
-}
-
-build_images() {
-    log_info "Building container images..."
-
-    log_info "Building Node 18 image..."
-    container build -t create-sy-node18 -f "$SCRIPT_DIR/Dockerfile.node18" "$SCRIPT_DIR"
-
-    log_info "Building Node 20 image..."
-    container build -t create-sy-node20 -f "$SCRIPT_DIR/Dockerfile.node20" "$SCRIPT_DIR"
-
-    log_info "Building Node 22 image..."
-    container build -t create-sy-node22 -f "$SCRIPT_DIR/Dockerfile.node22" "$SCRIPT_DIR"
-
-    log_info "All images built successfully"
-}
-
-main() {
-    check_container_cli
-    start_container_system
-
-    if [ "$1" = "--build" ] || [ "$1" = "-b" ]; then
-        build_images
-    else
-        log_info "Skipping image build. Use --build to build images."
-    fi
-
-    log_info "============================================"
-    log_info "E2E Infrastructure Ready!"
-    log_info "Available images:"
-    log_info "  - create-sy-node18"
-    log_info "  - create-sy-node20"
-    log_info "  - create-sy-node22"
-    log_info "============================================"
-}
-
-main "$@"

package/e2e/container/stop-containers.sh

@@ -1,24 +0,0 @@
-#!/bin/bash
-set -e
-
-# Colors
-GREEN='\033[0;32m'
-NC='\033[0m'
-
-log_info() { echo -e "${GREEN}[INFO]${NC} $1"; }
-
-if ! command -v container &> /dev/null; then
-    log_info "Apple container CLI not found, skipping cleanup"
-    exit 0
-fi
-
-log_info "Stopping any running test containers..."
-
-# Stop containers matching our naming pattern
-for container_id in $(container list -q 2>/dev/null | grep -E "create-sy-test-" || true); do
-    log_info "Stopping container: $container_id"
-    container stop "$container_id" 2>/dev/null || true
-    container delete -f "$container_id" 2>/dev/null || true
-done
-
-log_info "Cleanup complete"

package/e2e/fixtures/container.fixture.ts

@@ -1,64 +0,0 @@
-import {
-    isContainerCliAvailable,
-    containerRunCommand,
-    getNodeImage,
-    type NodeVersion,
-    type ExecResult,
-} from '../utils/container-cli.js'
-import { config } from '../config.js'
-
-export interface ContainerTestContext {
-    isAvailable: boolean
-    runInNode: (
-        version: NodeVersion,
-        commands: string[],
-        options?: { env?: Record<string, string>; timeout?: number }
-    ) => ExecResult
-}
-
-/**
- * Creates a container test context for running commands in Node containers
- */
-export function createContainerContext(): ContainerTestContext {
-    const isAvailable = isContainerCliAvailable()
-
-    const runInNode = (
-        version: NodeVersion,
-        commands: string[],
-        options: { env?: Record<string, string>; timeout?: number } = {}
-    ): ExecResult => {
-        if (!isAvailable) {
-            return {
-                stdout: '',
-                stderr: 'Apple Container CLI not available',
-                exitCode: 1,
-            }
-        }
-
-        const image = getNodeImage(version)
-        const timeout = options.timeout || config.npmInstallTimeout
-
-        return containerRunCommand(image, commands, {
-            env: {
-                ...options.env,
-                NPM_CONFIG_REGISTRY: config.npmRegistry,
-            },
-            timeout,
-        })
-    }
-
-    return {
-        isAvailable,
-        runInNode,
-    }
-}
-
-// Singleton context for tests
-let containerContext: ContainerTestContext | null = null
-
-export function getContainerContext(): ContainerTestContext {
-    if (!containerContext) {
-        containerContext = createContainerContext()
-    }
-    return containerContext
-}

package/e2e/utils/container-cli.ts

@@ -1,182 +0,0 @@
-import { execSync, spawn, ChildProcess } from 'node:child_process'
-
-export interface ContainerRunOptions {
-    name: string
-    image: string
-    env?: Record<string, string>
-    volumes?: string[]
-    workdir?: string
-    detached?: boolean
-    rm?: boolean
-    command?: string[]
-}
-
-export interface ExecResult {
-    stdout: string
-    stderr: string
-    exitCode: number
-}
-
-/**
- * Check if Apple Container CLI is available
- */
-export function isContainerCliAvailable(): boolean {
-    try {
-        execSync('container --version', { stdio: 'ignore' })
-        return true
-    } catch {
-        return false
-    }
-}
-
-/**
- * Run a container with specified options
- */
-export function containerRun(options: ContainerRunOptions): string {
-    const args: string[] = ['run']
-
-    if (options.detached) args.push('-d')
-    if (options.rm) args.push('--rm')
-    if (options.name) args.push('--name', options.name)
-    if (options.workdir) args.push('-w', options.workdir)
-
-    if (options.env) {
-        Object.entries(options.env).forEach(([k, v]) => {
-            args.push('-e', `${k}=${v}`)
-        })
-    }
-
-    options.volumes?.forEach(v => args.push('-v', v))
-
-    args.push(options.image)
-
-    if (options.command) {
-        args.push(...options.command)
-    }
-
-    return execSync(`container ${args.join(' ')}`, { encoding: 'utf-8' }).trim()
-}
-
-/**
- * Execute a command in a running container
- */
-export function containerExec(
-    containerName: string,
-    command: string[],
-    options: { timeout?: number } = {}
-): ExecResult {
-    const timeout = options.timeout || 120_000 // 2 minutes default
-
-    try {
-        const shellCommand = command.join(' ')
-        const stdout = execSync(
-            `container exec ${containerName} sh -c '${shellCommand}'`,
-            {
-                encoding: 'utf-8',
-                timeout,
-                maxBuffer: 10 * 1024 * 1024, // 10MB
-            }
-        )
-        return { stdout, stderr: '', exitCode: 0 }
-    } catch (error: any) {
-        return {
-            stdout: error.stdout || '',
-            stderr: error.stderr || error.message,
-            exitCode: error.status || 1,
-        }
-    }
-}
-
-/**
- * Run a command in a new container and return the result
- */
-export function containerRunCommand(
-    image: string,
-    command: string[],
-    options: {
-        env?: Record<string, string>
-        timeout?: number
-    } = {}
-): ExecResult {
-    const timeout = options.timeout || 180_000 // 3 minutes default
-
-    const args: string[] = ['run', '--rm']
-
-    if (options.env) {
-        Object.entries(options.env).forEach(([k, v]) => {
-            args.push('-e', `${k}=${v}`)
-        })
-    }
-
-    args.push(image)
-    const shellCommand = command.join(' && ')
-
-    try {
-        const stdout = execSync(`container ${args.join(' ')} sh -c '${shellCommand}'`, {
-            encoding: 'utf-8',
-            timeout,
-            maxBuffer: 10 * 1024 * 1024,
-        })
-        return { stdout, stderr: '', exitCode: 0 }
-    } catch (error: any) {
-        return {
-            stdout: error.stdout || '',
-            stderr: error.stderr || error.message,
-            exitCode: error.status || 1,
-        }
-    }
-}
-
-/**
- * Delete a container
- */
-export function containerDelete(name: string, force = true): void {
-    try {
-        execSync(`container delete ${force ? '-f' : ''} ${name}`, { stdio: 'ignore' })
-    } catch {
-        // Ignore errors - container may not exist
-    }
-}
-
-/**
- * Stop a container
- */
-export function containerStop(name: string): void {
-    try {
-        execSync(`container stop ${name}`, { stdio: 'ignore' })
-    } catch {
-        // Ignore errors
-    }
-}
-
-/**
- * Get container logs
- */
-export function containerLogs(name: string): string {
-    try {
-        return execSync(`container logs ${name}`, { encoding: 'utf-8' })
-    } catch {
-        return ''
-    }
-}
-
-/**
- * List running containers
- */
-export function containerList(): string[] {
-    try {
-        const output = execSync('container list -q', { encoding: 'utf-8' })
-        return output.split('\n').filter(Boolean)
-    } catch {
-        return []
-    }
-}
-
-export type NodeVersion = '18' | '20' | '22'
-
-/**
- * Get image name for a Node.js version
- */
-export function getNodeImage(version: NodeVersion): string {
-    return `create-sy-node${version}`
-}

package/e2e/vitest.e2e.config.ts

@@ -1,21 +0,0 @@
-import { defineConfig } from 'vitest/config'
-
-export default defineConfig({
-    test: {
-        include: ['e2e/tests/**/*.e2e.ts'],
-        exclude: ['node_modules', 'build'],
-        testTimeout: 300_000, // 5 minutes per test
-        hookTimeout: 120_000, // 2 minutes for hooks
-        pool: 'forks',
-        poolOptions: {
-            forks: {
-                singleFork: true, // Sequential execution for container tests
-            },
-        },
-        reporters: ['verbose'],
-        passWithNoTests: true,
-        env: {
-            E2E_MODE: 'true',
-        },
-    },
-})

package/typedoc.config.cjs

@@ -1,6 +0,0 @@
-/** @type {import('typedoc').TypeDocOptions} */
-module.exports = {
-    // entryPoints: ["./src/index.ts"],
-    extends: ["../../typedoc.base.json"],
-    out: ""
-};

package/vitest.config.ts

@@ -1,24 +0,0 @@
-/// <reference types="vitest" />
-import { defineConfig } from 'vite'
-
-export default defineConfig({
-    test: {
-        include: ['tests/**/*.test.ts'],
-        /**
-         * not to ESM ported packages
-         */
-        exclude: [
-            'build', '.idea', '.git', '.cache',
-            '**/node_modules/**', '__mocks__'
-        ],
-        coverage: {
-            provider: 'v8',
-            enabled: true,
-            exclude: ['**/build/**', '__mocks__', '**/*.test.ts', 'src/utils*'],
-            lines: 97,
-            functions: 80,
-            branches: 70,
-            statements: 97
-        }
-    }
-})