@simplens/onboard 1.0.1 → 1.0.2

package/src/validators.ts

@@ -1,192 +1,145 @@
-import { execa } from 'execa';
-import { logError, logSuccess, logWarning } from './utils.js';
-import {
-    DockerNotInstalledError,
-    DockerNotRunningError,
-    DockerPermissionError,
-} from './types/errors.js';
-import { VALIDATION } from './config/constants.js';
-
-export type OSType = 'windows' | 'linux' | 'darwin';
-
-/**
- * Checks if Docker is installed on the system by running `docker --version`.
- * 
- * @throws {DockerNotInstalledError} When Docker is not found in PATH or not installed
- * 
- * @example
- * ```ts
- * try {
- *   await checkDockerInstalled();
- *   console.log('Docker is available');
- * } catch (error) {
- *   // Handle DockerNotInstalledError
- * }
- * ```
- */
-export async function checkDockerInstalled(): Promise<void> {
-    try {
-        await execa('docker', ['--version']);
-    } catch (error: any) {
-        throw new DockerNotInstalledError();
-    }
-}
-
-/**
- * Checks if the Docker daemon is running by executing `docker ps`.
- * Provides specific error types based on the failure reason.
- * 
- * @throws {DockerPermissionError} When user lacks permissions to access Docker socket
- * @throws {DockerNotRunningError} When Docker daemon is not running or unreachable
- * 
- * @example
- * ```ts
- * try {
- *   await checkDockerRunning();
- * } catch (error) {
- *   if (error instanceof DockerPermissionError) {
- *     // Guide user to add sudo or docker group
- *   }
- * }
- * ```
- */
-export async function checkDockerRunning(): Promise<void> {
-    try {
-        await execa('docker', ['ps']);
-    } catch (error: any) {
-        const errorMessage = error.message?.toLowerCase() || '';
-        
-        if (errorMessage.includes('permission denied') || errorMessage.includes('eacces')) {
-            throw new DockerPermissionError();
-        }
-        
-        if (errorMessage.includes('cannot connect') || errorMessage.includes('is the docker daemon running')) {
-            throw new DockerNotRunningError();
-        }
-        
-        // Generic docker error
-        throw new DockerNotRunningError();
-    }
-}
-
-/**
- * Detects the operating system platform.
- * 
- * @returns OS type: 'windows', 'darwin' (macOS), or 'linux'
- * @note Defaults to 'linux' for unknown platforms
- * 
- * @example
- * ```ts
- * const os = detectOS();
- * if (os === 'linux') {
- *   // Linux-specific configuration
- * }
- * ```
- */
-export function detectOS(): OSType {
-    const platform = process.platform;
-    if (platform === 'win32') return 'windows';
-    if (platform === 'linux') return 'linux';
-    if (platform === 'darwin') return 'darwin';
-    return 'linux'; // Default fallback
-}
-
-/**
- * Validates all system prerequisites before starting the onboarding process.
- * Checks Docker installation, daemon status, and detects the operating system.
- * 
- * @throws {DockerNotInstalledError} If Docker is not installed
- * @throws {DockerNotRunningError} If Docker daemon is not running  
- * @throws {DockerPermissionError} If user lacks Docker permissions
- * 
- * @example
- * ```ts
- * try {
- *   await validatePrerequisites();
- *   // Proceed with setup
- * } catch (error) {
- *   // Handle prerequisite errors
- * }
- * ```
- */
-export async function validatePrerequisites(): Promise<void> {
-    console.log('\n🔍 Checking prerequisites...\n');
-
-    // Check Docker installation
-    try {
-        await checkDockerInstalled();
-        logSuccess('Docker is installed');
-    } catch (error) {
-        // Error will be caught by main() and displayed with troubleshooting
-        throw error;
-    }
-
-    // Check Docker daemon
-    try {
-        await checkDockerRunning();
-        logSuccess('Docker daemon is running');
-    } catch (error) {
-        // Error will be caught by main() and displayed with troubleshooting
-        throw error;
-    }
-
-    // Detect OS
-    const os = detectOS();
-    logSuccess(`Detected OS: ${os}`);
-
-    if (os === 'linux') {
-        logWarning('Linux detected: You may need to provide your machine IP for infra services.');
-    }
-}
-
-/**
- * Validates environment variable values based on the variable name/type.
- * Performs format-specific validation for URLs, ports, and security credentials.
- * 
- * @param key - Environment variable name (e.g., 'MONGO_URI', 'PORT', 'API_KEY')
- * @param value - Value to validate
- * @returns `true` if valid, `false` otherwise
- * 
- * @remarks
- * Validation rules:
- * - URLs: Must contain protocol (mongodb://, redis://)
- * - Ports: Must be 1-65535
- * - Secrets/Keys/Passwords: Must be at least 8 characters
- * 
- * @example
- * ```ts
- * validateEnvValue('MONGO_URI', 'mongodb://localhost:27017'); // true
- * validateEnvValue('PORT', '3000'); // true
- * validateEnvValue('API_KEY', 'short'); // false (too short)
- * ```
- */
-export function validateEnvValue(key: string, value: string): boolean {
-    // URL validation
-    if (key.includes('URL') || key.includes('URI')) {
-        if (!value) return false;
-        // Basic URL format check
-        if (key === 'MONGO_URI' && !value.includes('mongodb://')) {
-            return false;
-        }
-        if (key === 'REDIS_URL' && !value.includes('redis://')) {
-            return false;
-        }
-    }
-
-    // Port validation
-    if (key.includes('PORT')) {
-        const port = parseInt(value, 10);
-        if (isNaN(port) || port < VALIDATION.PORT_MIN || port > VALIDATION.PORT_MAX) {
-            return false;
-        }
-    }
-
-    // API Key validation (should not be empty for security)
-    if (key.includes('API_KEY') || key.includes('SECRET') || key.includes('PASSWORD')) {
-        if (!value || value.length < VALIDATION.MIN_PASSWORD_LENGTH) {
-            return false;
-        }
-    }
-
-    return true;
-}
+import { execa } from 'execa';
+import { logSuccess, logWarning } from './utils.js';
+import { spinner } from './ui.js';
+import {
+    DockerNotInstalledError,
+    DockerNotRunningError,
+    DockerPermissionError,
+} from './types/errors.js';
+import { VALIDATION } from './config/constants.js';
+
+export type OSType = 'windows' | 'linux' | 'darwin';
+
+/**
+ * Checks if Docker is installed on the system by running `docker --version`.
+ *
+ * @throws {DockerNotInstalledError} When Docker is not found in PATH or not installed
+ */
+export async function checkDockerInstalled(): Promise<void> {
+    try {
+        await execa('docker', ['--version']);
+    } catch (error: unknown) {
+        throw new DockerNotInstalledError();
+    }
+}
+
+/**
+ * Checks if the Docker daemon is running by executing `docker ps`.
+ * Provides specific error types based on the failure reason.
+ *
+ * @throws {DockerPermissionError} When user lacks permissions to access Docker socket
+ * @throws {DockerNotRunningError} When Docker daemon is not running or unreachable
+ */
+export async function checkDockerRunning(): Promise<void> {
+    try {
+        await execa('docker', ['ps']);
+    } catch (error: unknown) {
+        const errorMessage = (error as Error).message?.toLowerCase() || '';
+
+        if (errorMessage.includes('permission denied') || errorMessage.includes('eacces')) {
+            throw new DockerPermissionError();
+        }
+
+        if (errorMessage.includes('cannot connect') || errorMessage.includes('is the docker daemon running')) {
+            throw new DockerNotRunningError();
+        }
+
+        // Generic docker error
+        throw new DockerNotRunningError();
+    }
+}
+
+/**
+ * Detects the operating system platform.
+ *
+ * @returns OS type: 'windows', 'darwin' (macOS), or 'linux'
+ * @note Defaults to 'linux' for unknown platforms
+ */
+export function detectOS(): OSType {
+    const platform = process.platform;
+    if (platform === 'win32') return 'windows';
+    if (platform === 'linux') return 'linux';
+    if (platform === 'darwin') return 'darwin';
+    return 'linux'; // Default fallback
+}
+
+/**
+ * Validates all system prerequisites before starting the onboarding process.
+ * Checks Docker installation, daemon status, and detects the operating system.
+ * Uses clack spinners for visual feedback.
+ *
+ * @throws {DockerNotInstalledError} If Docker is not installed
+ * @throws {DockerNotRunningError} If Docker daemon is not running
+ * @throws {DockerPermissionError} If user lacks Docker permissions
+ */
+export async function validatePrerequisites(): Promise<void> {
+    logSuccess('Running prerequisite checks...');
+
+    // Check Docker installation
+    const s = spinner();
+    s.start('Checking Docker installation...');
+    try {
+        await checkDockerInstalled();
+        s.stop('Docker installation detected');
+    } catch (error) {
+        s.error('Docker installation check failed');
+        throw error;
+    }
+
+    // Check Docker daemon
+    s.start('Checking Docker daemon status...');
+    try {
+        await checkDockerRunning();
+        s.stop('Docker daemon is running');
+    } catch (error) {
+        s.error('Docker daemon check failed');
+        throw error;
+    }
+
+    // Detect OS
+    const os = detectOS();
+    logSuccess(`Detected OS: ${os}`);
+
+    if (os === 'linux') {
+        logWarning('Linux detected: You may need to provide your machine IP for infra services.');
+    }
+}
+
+/**
+ * Validates environment variable values based on the variable name/type.
+ * Performs format-specific validation for URLs, ports, and security credentials.
+ *
+ * @param key - Environment variable name (e.g., 'MONGO_URI', 'PORT', 'API_KEY')
+ * @param value - Value to validate
+ * @returns `true` if valid, `false` otherwise
+ */
+export function validateEnvValue(key: string, value: string): boolean {
+    // URL validation
+    if (key.includes('URL') || key.includes('URI')) {
+        if (!value) return false;
+        // Basic URL format check
+        if (key === 'MONGO_URI' && !value.includes('mongodb://')) {
+            return false;
+        }
+        if (key === 'REDIS_URL' && !value.includes('redis://')) {
+            return false;
+        }
+    }
+
+    // Port validation
+    if (key.includes('PORT')) {
+        const port = parseInt(value, 10);
+        if (isNaN(port) || port < VALIDATION.PORT_MIN || port > VALIDATION.PORT_MAX) {
+            return false;
+        }
+    }
+
+    // API Key validation (should not be empty for security)
+    if (key.includes('API_KEY') || key.includes('SECRET') || key.includes('PASSWORD')) {
+        if (!value || value.length < VALIDATION.MIN_PASSWORD_LENGTH) {
+            return false;
+        }
+    }
+
+    return true;
+}

package/tsconfig.json

@@ -1,19 +1,19 @@
-{
-  "compilerOptions": {
-    "target": "ES2022",
-    "module": "ESNext",
-    "moduleResolution": "node",
-    "rootDir": "./src",
-    "outDir": "./dist",
-    "esModuleInterop": true,
-    "resolveJsonModule": true,
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
-    "skipLibCheck": true,
-    "declaration": true,
-    "declarationMap": true,
-    "sourceMap": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "dist"]
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "Node16",
+    "moduleResolution": "Node16",
+    "rootDir": "./src",
+    "outDir": "./dist",
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
 }

package/vitest.config.ts

@@ -1,22 +1,22 @@
-import { defineConfig } from 'vitest/config';
-
-export default defineConfig({
-  test: {
-    globals: true,
-    environment: 'node',
-    include: ['src/**/*.{test,spec}.{js,ts}'],
-    exclude: ['node_modules/**', 'dist/**'],
-    coverage: {
-      provider: 'v8',
-      reporter: ['text', 'json', 'html'],
-      exclude: [
-        'node_modules/**',
-        'dist/**',
-        '**/*.test.ts',
-        '**/*.spec.ts',
-        'src/templates.ts', // Large constant file
-      ],
-    },
-    testTimeout: 10000,
-  },
-});
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    globals: true,
+    environment: 'node',
+    include: ['src/**/*.{test,spec}.{js,ts}'],
+    exclude: ['node_modules/**', 'dist/**'],
+    coverage: {
+      provider: 'v8',
+      reporter: ['text', 'json', 'html'],
+      exclude: [
+        'node_modules/**',
+        'dist/**',
+        '**/*.test.ts',
+        '**/*.spec.ts',
+        'src/templates.ts', // Large constant file
+      ],
+    },
+    testTimeout: 10000,
+  },
+});