envilder 0.4.0 → 0.5.0

package/.github/workflows/cli-validation.yml

@@ -0,0 +1,58 @@
+name: 🍄 Test CLI
+
+on:
+  workflow_dispatch: {}
+
+  pull_request:
+    branches:
+      - "*"
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - ready_for_review
+    paths:
+      - ".github/workflows/cli-validation.yml"
+      - "src/**"
+      - "scripts/**"
+      - "tests/**"
+      
+jobs:
+  validate:
+    runs-on: ubuntu-24.04
+    if: ${{ !github.event.pull_request.draft }}
+    timeout-minutes: 30
+
+    steps:
+      - name: 🚀 ♂️ Checkout
+        uses: actions/checkout@v4
+
+      - name: 🛠️ Setup Node.js with Cache
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          cache: 'yarn'
+
+      - name: 💉 Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: "eu-west-1"
+
+      - name: 🪙 Collect dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: 🏗️ Build the castle
+        run: yarn build      
+
+      - name: 🧩 Ensure executable permissions
+        run: |
+          chmod +x ./lib/cli/cli.js
+
+      - name: 🌈 Install envilder globally (with npm)
+        run: |
+          sudo npm install -g .
+        
+      - name: 🎮 Test cli envilder
+        run: yarn validate-cli

package/.github/workflows/unit-tests.yml

@@ -14,6 +14,7 @@ on:
     paths:
       - ".github/workflows/unit-tests.yml"
       - "src/**"
+      - "tests/**"
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.sha }}

package/biome.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://biomejs.dev/schemas/1.8.3/schema.json",
   "files": {
-    "include": ["./src/**", "./tests/**"],
+    "include": ["./src/**", "./tests/**", "./scripts/**"],
     "ignore": ["**/node_modules/**", "**/lib/**", "**/dist/**", "**/coverage/**", "**/.lock", "**/.md"]
   },
   "organizeImports": {

package/package.json

@@ -1,19 +1,22 @@
 {
   "name": "envilder",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "A CLI tool to generate .env files from AWS SSM parameters",
   "exports": {
     ".": {
+      "import": "./lib/index.js",
       "types": "./lib/index.d.ts"
     }
   },
+  "main": "./lib/index.js",
   "bin": {
-    "envilder": "lib/cli/cliRunner.js"
+    "envilder": "lib/cli/cli.js"
   },
   "scripts": {
     "clean": "npx jest --clearCache && yarn cache clean --force && npx rimraf lib && npx rimraf node_modules && npx rimraf coverage && npx rimraf yarn.lock",
-    "test-run": "yarn build && node lib/cli/cliRunner.js --map=tests/sample/param-map.json --envfile=tests/sample/autogenerated.env",
-    "build": "tsc -p tsconfig.build.json --sourceMap --declaration",
+    "test-run": "yarn build && node lib/cli/cli.js --map=tests/sample/param-map.json --envfile=tests/sample/autogenerated.env",
+    "build": "tsc -p tsconfig.build.json --sourceMap --declaration && node --no-warnings scripts/chmod-cli.js",
+    "validate-cli": "node --no-warnings --loader ts-node/esm scripts/validate-cli.ts",
     "format": "npx biome format",
     "format:write": "npx biome format --write",
     "lint": "npx secretlint \"**/*\" && biome lint --write && biome format --write && biome check --write && tsc --noEmit",
@@ -40,10 +43,8 @@
   },
   "type": "module",
   "dependencies": {
-    "@aws-sdk/client-ssm": "^3.654.0",
+    "@aws-sdk/client-ssm": "^3.806.0",
     "@aws-sdk/credential-providers": "^3.806.0",
-    "@secretlint/core": "^9.2.1",
-    "@secretlint/secretlint-rule-preset-recommend": "^9.0.0",
     "@types/node": "^22.5.5",
     "commander": "^13.1.0",
     "dotenv": "^16.4.5",
@@ -51,17 +52,14 @@
   },
   "devDependencies": {
     "@biomejs/biome": "^1.9.1",
+    "@secretlint/secretlint-rule-preset-recommend": "^9.3.2",
     "@vitest/coverage-v8": "^3.1.1",
     "rimraf": "^6.0.1",
-    "secretlint": "^9.0.0",
+    "secretlint": "^9.3.2",
     "ts-node": "^10.9.2",
     "typescript": "^5.6.2",
     "vitest": "^3.1.1"
   },
-  "resolutions": {
-    "string-width": "4.2.3",
-    "strip-ansi": "6.0.1"
-  },
   "engines": {
     "node": ">=20.0.0",
     "yarn": ">=1.22"

package/scripts/chmod-cli.js

@@ -0,0 +1,24 @@
+#!/usr/bin/env node
+/**
+ * Simple script to set executable permissions on the CLI entry point.
+ * Only runs the chmod command on Unix-based systems.
+ */
+import { chmod } from 'node:fs/promises';
+import { join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+// Get the project root directory
+const rootDir = join(fileURLToPath(new URL('.', import.meta.url)), '..');
+const cliFilePath = join(rootDir, 'lib', 'cli', 'cli.js');
+
+// Only run on non-Windows platforms
+if (process.platform !== 'win32') {
+  chmod(cliFilePath, 0o755) // rwxr-xr-x permissions
+    .then(() => console.log(`✅ Set executable permissions for: ${cliFilePath}`))
+    .catch((error) => {
+      console.error(`❌ Error setting permissions: ${error.message}`);
+      process.exit(1);
+    });
+} else {
+  console.log('📋 Skipping executable permissions on Windows platform');
+}

package/scripts/validate-cli.ts

@@ -0,0 +1,141 @@
+#!/usr/bin/env node
+import { spawn } from 'node:child_process';
+import { existsSync } from 'node:fs';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+const rootDir = join(__dirname, '..');
+const isGithubAction = process.env.GITHUB_ACTIONS === 'true';
+const isWindows = process.platform === 'win32';
+const findCommand = isWindows ? 'where' : 'which';
+
+/**
+ * Run a command with the given arguments
+ */
+function runCommand(command: string, args: string[]): Promise<{ code: number; output: string }> {
+  return new Promise((resolve) => {
+    const proc = spawn(command, args, { shell: true });
+    let output = '';
+
+    proc.stdout.on('data', (data) => {
+      output += data.toString();
+    });
+
+    proc.stderr.on('data', (data) => {
+      output += data.toString();
+    });
+
+    proc.on('close', (code) => {
+      resolve({ code: code ?? 0, output });
+    });
+  });
+}
+
+/**
+ * Try to run a command with both global and local CLI approaches
+ */
+async function tryCommandWithFallback(
+  args: string[],
+): Promise<{ code: number; output: string; usedFallback: boolean }> {
+  // Try global command first
+  const globalResult = await runCommand('envilder', args);
+
+  if (globalResult.code === 0) {
+    return { ...globalResult, usedFallback: false };
+  }
+
+  // Fall back to direct node execution
+  console.log('Global envilder command failed, trying direct Node.js execution...');
+  const directResult = await runCommand('node', ['./lib/cli/cli.js', ...args]);
+
+  return {
+    ...directResult,
+    usedFallback: true,
+  };
+}
+
+async function validateCLI() {
+  console.log(`🔍 Validating envilder CLI installation${isGithubAction ? ' in GitHub Actions' : ''}...`);
+
+  try {
+    // Test 1: Check CLI version and accessibility
+    console.log('Testing envilder version command...');
+    const versionResult = await tryCommandWithFallback(['--version']);
+
+    if (versionResult.code !== 0) {
+      throw new Error(`❌ envilder version command failed: ${versionResult.output}`);
+    }
+    console.log('✅ envilder version command works');
+
+    // Test 2: Check help command
+    console.log('Testing envilder help command...');
+    const helpResult = await tryCommandWithFallback(['--help']);
+
+    if (helpResult.code !== 0) {
+      throw new Error(`❌ envilder help command failed: ${helpResult.output}`);
+    }
+
+    if (!helpResult.output.includes('--map') || !helpResult.output.includes('--envfile')) {
+      throw new Error('❌ envilder help command output is missing expected options');
+    }
+    console.log('✅ envilder help command works');
+
+    // Test 3: Check sample file generation
+    const testEnvFile = join(rootDir, 'tests', 'sample', 'cli-validation.env');
+    console.log('Testing envilder file generation...');
+
+    const sampleResult = await tryCommandWithFallback([
+      '--map',
+      join(rootDir, 'tests', 'sample', 'param-map.json'),
+      '--envfile',
+      testEnvFile,
+    ]);
+
+    if (sampleResult.code !== 0) {
+      throw new Error(`❌ envilder failed to generate environment file: ${sampleResult.output}`);
+    }
+
+    if (!sampleResult.output.includes('Environment File generated')) {
+      throw new Error('❌ envilder did not output expected success message');
+    }
+
+    if (!existsSync(testEnvFile)) {
+      throw new Error(`❌ envilder did not create the environment file at ${testEnvFile}`);
+    }
+    console.log('✅ envilder successfully generated environment file');
+
+    // Test 4: Check error handling for invalid arguments
+    console.log('Testing envilder with invalid arguments...');
+    const errorResult = await tryCommandWithFallback(['--invalid']);
+
+    if (errorResult.code === 0) {
+      throw new Error('❌ envilder should fail with invalid arguments');
+    }
+    console.log('✅ envilder properly handles invalid arguments');
+
+    // Test 5: Check error handling for missing required options
+    console.log('Testing envilder with missing required options...');
+    const missingResult = await tryCommandWithFallback([]);
+
+    if (missingResult.code === 0) {
+      throw new Error('❌ envilder should fail when required options are missing');
+    }
+    console.log('✅ envilder properly handles missing required options');
+
+    console.log('🎉 All CLI validation tests passed!');
+  } catch (error) {
+    if (error instanceof Error) {
+      console.error(error.message);
+    } else {
+      console.error('Unknown error occurred during CLI validation');
+    }
+    process.exit(1);
+  }
+}
+
+validateCLI().catch((error) => {
+  console.error(error.message);
+  process.exit(1);
+});

package/src/cli/cli.ts

@@ -0,0 +1,76 @@
+#!/usr/bin/env node
+import { existsSync, readFileSync } from 'node:fs';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { Command } from 'commander';
+import { run } from '../index.js';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+/**
+ * Find the package.json file by traversing up directories
+ * @param startDir The directory to start searching from
+ * @param maxDepth Maximum number of parent directories to check
+ * @returns Path to package.json if found, or null if not found
+ */
+function findPackageJson(startDir: string, maxDepth = 5): string | null {
+  let currentDir = startDir;
+  let depth = 0;
+
+  while (depth < maxDepth) {
+    const packagePath = join(currentDir, 'package.json');
+    if (existsSync(packagePath)) {
+      return packagePath;
+    }
+
+    // Go up one directory
+    const parentDir = dirname(currentDir);
+    if (parentDir === currentDir) {
+      // We've reached the root
+      break;
+    }
+
+    currentDir = parentDir;
+    depth++;
+  }
+
+  return null;
+}
+
+// Get package.json path by searching up from current file
+const packageJsonPath = findPackageJson(__dirname) || join(__dirname, '..', '..', 'package.json');
+const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf8'));
+
+/**
+ * Parses CLI arguments and runs the environment file generator.
+ *
+ * Expects `--map` and `--envfile` options to be provided, with an optional `--profile` for AWS CLI profile selection. Invokes the main process to generate a `.env` file from AWS SSM parameters based on the provided mapping.
+ *
+ * @throws {Error} If either `--map` or `--envfile` arguments are missing.
+ */
+export async function main() {
+  const program = new Command();
+  program
+    .name('envilder')
+    .description('A CLI tool to generate .env files from AWS SSM parameters')
+    .version(packageJson.version)
+    .requiredOption('--map <path>', 'Path to the JSON file with environment variable mapping')
+    .requiredOption('--envfile <path>', 'Path to the .env file to be generated')
+    .option('--profile <name>', 'AWS CLI profile to use');
+
+  await program.parseAsync(process.argv);
+  const options = program.opts();
+
+  if (!options.map || !options.envfile) {
+    throw new Error('Missing required arguments: --map and --envfile');
+  }
+
+  await run(options.map, options.envfile, options.profile);
+}
+
+// Execute the CLI
+main().catch((error) => {
+  console.error('🚨 Uh-oh! Looks like Mario fell into the wrong pipe! 🍄💥');
+  console.error(error);
+});

package/tests/cli/{cliRunner.test.ts → cli.test.ts}

@@ -1,12 +1,12 @@
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
-import { cliRunner } from '../../src/cli/cliRunner';
+import { main } from '../../src/cli/cli';
 import { run } from '../../src/index';
 
 vi.mock('../../src/index', () => ({
   run: vi.fn(),
 }));
 
-describe('cliRunner', () => {
+describe('CLI', () => {
   const originalArgv = process.argv;
 
   beforeEach(() => {
@@ -24,7 +24,7 @@ describe('cliRunner', () => {
     process.argv.push('--map', mockMapPath, '--envfile', mockEnvFilePath);
 
     // Act
-    await cliRunner();
+    await main();
 
     // Assert
     expect(run).toHaveBeenCalledWith(mockMapPath, mockEnvFilePath, undefined);
@@ -37,7 +37,7 @@ describe('cliRunner', () => {
     });
 
     // Act
-    const action = cliRunner();
+    const action = main();
 
     // Assert
     await expect(action).rejects.toThrow('process.exit called');
@@ -51,7 +51,7 @@ describe('cliRunner', () => {
     process.argv.push('--map', mockMapPath, '--envfile', mockEnvFilePath, '--profile', mockProfile);
 
     // Act
-    await cliRunner();
+    await main();
 
     // Assert
     expect(run).toHaveBeenCalledWith(mockMapPath, mockEnvFilePath, mockProfile);

package/tests/sample/cli-validation.env

@@ -0,0 +1 @@
+TOKEN_SECRET=this_is_for_test

package/tsconfig.build.json

@@ -1,7 +1,14 @@
 {
   "extends": "./tsconfig.json",
   "compilerOptions": {
-    "rootDir": "./src"
+    "rootDir": "./src",
+    "outDir": "./lib",
+    "module": "ESNext",
+    "moduleResolution": "Node",
+    "preserveConstEnums": true,
+    "sourceMap": true
   },
-  "include": ["./src/**/*"]
-}
+  "include": [
+    "./src/**/*"
+  ]
+}

package/tsconfig.json

@@ -10,13 +10,21 @@
     "esModuleInterop": true,
     "noImplicitAny": true,
     "skipLibCheck": true,
-    "lib": ["es2022"],
+    "lib": [
+      "es2022"
+    ],
     "declaration": true,
     "declarationMap": true,
     "sourceMap": true,
     "forceConsistentCasingInFileNames": true,
     "resolveJsonModule": true,
-    "types": ["node", "picocolors"]
+    "types": [
+      "node",
+      "picocolors"
+    ]
   },
-  "include": ["src/**/*"]
-}
+  "include": [
+    "src/**/*",
+    "scripts/**/*"
+  ]
+}

package/vite.config.ts

@@ -11,7 +11,7 @@ export default defineConfig({
       reportsDirectory: './coverage',
       all: true,
       include: ['src/**/*.ts'],
-      exclude: ['node_modules', 'test', 'coverage', 'dist'],
+      exclude: ['node_modules', 'test', 'coverage', 'dist', 'scripts'],
     },
   },
 });

package/src/cli/cliRunner.ts

@@ -1,35 +0,0 @@
-#!/usr/bin/env node
-import { Command } from 'commander';
-import { run } from '../index.js';
-
-/**
- * Parses CLI arguments and runs the environment file generator.
- *
- * Expects `--map` and `--envfile` options to be provided, with an optional `--profile` for AWS CLI profile selection. Invokes the main process to generate a `.env` file from AWS SSM parameters based on the provided mapping.
- *
- * @throws {Error} If either `--map` or `--envfile` arguments are missing.
- */
-export async function cliRunner() {
-  const program = new Command();
-
-  program
-    .name('envilder')
-    .description('A CLI tool to generate .env files from AWS SSM parameters')
-    .version('0.1.0')
-    .requiredOption('--map <path>', 'Path to the JSON file with environment variable mapping')
-    .requiredOption('--envfile <path>', 'Path to the .env file to be generated')
-    .option('--profile <name>', 'AWS CLI profile to use');
-
-  await program.parseAsync(process.argv);
-  const options = program.opts();
-
-  if (!options.map || !options.envfile) {
-    throw new Error('Missing required arguments: --map and --envfile');
-  }
-
-  await run(options.map, options.envfile, options.profile);
-}
-
-cliRunner().catch((error) => {
-  console.error('🚨 Uh-oh! Looks like Mario fell into the wrong pipe! 🍄💥');
-});