@benshawmean/envedit 1.2.2 → 1.3.0

package/@types/custom.d.ts

@@ -0,0 +1,10 @@
+import type { CommandModule as YargModule } from 'yargs';
+import type { Logger } from '#lib/logger';
+
+type Argv = {
+    level: string;
+}
+
+declare global {
+    export type CommandModule = YargModule<Argv, Argv>;
+}

package/README.md

@@ -1,4 +1,4 @@
-# envedit
+# ![EnvEdit Icon](https://cdn.benshawmean.com/icons/envedit-icon.png){width=32} envedit
 
 `envedit` is a simple CLI application used to manage environments.
 It allows you to create, edit, and delete custom environments, as well as

package/cmd/environment.ts

@@ -1,21 +1,10 @@
-import type { CommandModule } from "yargs";
+import Commands from "./environmentCmd";
 
-import Add from "./environment/add";
-import Edit from "./environment/edit";
-import List from "./environment/list";
-import Remove from "./environment/remove";
-
-const data = {
+export default {
     command: 'environment',
     describe: 'Manage environments',
     builder: (yargs) => yargs
         .usage('Usage: envedit environment <command> [options]')
-        .command([Add, Edit, List, Remove])
+        .command(Commands)
         .demandCommand(),
-    handler: async (_args) => {}
-} satisfies CommandModule;
-
-export const command = data.command;
-export const describe = data.describe;
-export const builder = data.builder;
-export const handler = data.handler;
+} as CommandModule;

package/cmd/{environment → environmentCmd}/add.ts

@@ -1,18 +1,18 @@
 import fs from "node:fs";
 
 import { confirm, input, password, select } from "@inquirer/prompts";
-import type { CommandModule } from "yargs";
 
 import { Configuration, EnvironmentFile, VariableType } from "#lib/config";
 import { NotFoundError } from "#lib/error";
-import { logger } from "#lib/logger";
+import { Logger } from "#lib/logger";
 
 export default {
     command: 'add',
     describe: 'Add a new environment',
     builder: (yargs) => yargs,
-    handler: async (_args) => {
-        const config = new Configuration().loadConfigurationFile();
+    handler: async (argv) => {
+        const config = new Configuration().load();
+        const logger = new Logger(argv.level);
 
         const name = await input({
             message: "Enter the environment name:",
@@ -45,7 +45,7 @@ export default {
 
         config
             .addEnvironment({ name, prefix, file, isActive })
-            .saveConfigurationFile();
+            .save();
 
         const envFile = new EnvironmentFile(file).load();
 

package/cmd/{environment → environmentCmd}/edit.ts

@@ -1,18 +1,18 @@
 import fs from "node:fs";
 
 import { confirm, input, select, checkbox } from "@inquirer/prompts";
-import type { CommandModule } from "yargs";
 
 import { Configuration } from "#lib/config";
 import { NotFoundError } from "#lib/error";
-import { logger } from "#lib/logger";
+import { Logger } from "#lib/logger";
 
 export default {
     command: 'edit',
     describe: 'Edit an environment',
     builder: (yargs) => yargs,
-    handler: async (_args) => {
-        const config = new Configuration().loadConfigurationFile();
+    handler: async (argv) => {
+        const config = new Configuration().load();
+        const logger = new Logger(argv.level);
 
         const name = await select({
             message: "Select the environment to edit:",
@@ -65,7 +65,7 @@ export default {
 
         config
             .editEnvironment(name, updatedEnv)
-            .saveConfigurationFile();
+            .save();
 
         if (itemsToEdit.includes("file") && fs.existsSync(selectedEnv.file)) {
             logger.debug(`Old environment file found: ${selectedEnv.file}`);

package/cmd/environmentCmd/index.ts

@@ -0,0 +1,6 @@
+import Add from "./add";
+import Edit from "./edit";
+import List from "./list";
+import Remove from "./remove";
+
+export default [Add, Edit, List, Remove]

package/cmd/{environment → environmentCmd}/list.ts

@@ -1,14 +1,13 @@
-import type { CommandModule } from "yargs";
-
 import { Configuration } from "#lib/config";
-import { logger } from "#lib/logger";
+import { Logger } from "#lib/logger";
 
 export default {
     command: 'list',
     describe: 'List all environments',
     builder: (yargs) => yargs,
-    handler: async (_args) => {
-        const config = new Configuration().loadConfigurationFile();
+    handler: async (argv) => {
+        const config = new Configuration().load();
+        const logger = new Logger(argv.level);
 
         logger.debug(`Listing all environments`);
 

package/cmd/{environment → environmentCmd}/remove.ts

@@ -1,18 +1,18 @@
 import fs from "node:fs";
 
 import { confirm, select } from "@inquirer/prompts";
-import type { CommandModule } from "yargs";
 
 import { Configuration } from "#lib/config";
 import { NotFoundError } from "#lib/error";
-import { logger } from "#lib/logger";
+import { Logger } from "#lib/logger";
 
 export default {
     command: 'remove',
     describe: 'Remove an environment',
     builder: (yargs) => yargs,
-    handler: async (_args) => {
-        const config = new Configuration().loadConfigurationFile();
+    handler: async (argv) => {
+        const config = new Configuration().load();
+        const logger = new Logger(argv.level);
 
         const name = await select({
             message: "Select the environment to remove:",
@@ -28,12 +28,11 @@ export default {
             throw new NotFoundError(`Environment not found: ${name}`);
         }
 
-        logger
-            .debug(`Removing environment "${name}" with file: "${selectedEnv.file}"`);
+        logger.debug(`Removing environment "${name}" with file: "${selectedEnv.file}"`);
 
         config
             .removeEnvironment(name)
-            .saveConfigurationFile();
+            .save();
 
         if (fs.existsSync(selectedEnv.file)) {
             const toDelete = await confirm({
@@ -41,8 +40,7 @@ export default {
             });
 
             if (toDelete) {
-                logger
-                    .debug(`Deleting environment file: ${selectedEnv.file}`);
+                logger.debug(`Deleting environment file: ${selectedEnv.file}`);
                 fs.unlinkSync(selectedEnv.file);
             }
         }

package/cmd/index.ts

@@ -0,0 +1,6 @@
+import Environment from './environment';
+import Variable from './variable';
+import Use from './use';
+import Setup from './setup';
+
+export default [Environment, Variable, Use, Setup];

package/cmd/setup.ts

@@ -1,18 +1,19 @@
 import fs from "node:fs";
 
 import { confirm } from "@inquirer/prompts";
-import type { CommandModule } from "yargs";
 
 import { Configuration } from "#lib/config";
-import { logger } from "#lib/logger";
+import { Logger } from "#lib/logger";
 
-const data = {
+export default {
     command: 'setup',
     describe: 'Setup the project for use with envedit',
     builder: (yargs) => yargs
         .usage('Usage: envedit setup'),
-    handler: async (_args) => {
-        new Configuration().loadConfigurationFile();
+    handler: async (argv) => {
+        const logger = new Logger(argv.level);
+
+        new Configuration().load();
 
         if (fs.existsSync('.git')) {
             logger.debug(`Git repository found. Checking for git ignore file.`);
@@ -56,9 +57,4 @@ const data = {
             }
         }
     }
-} satisfies CommandModule;
-
-export const command = data.command;
-export const describe = data.describe;
-export const builder = data.builder;
-export const handler = data.handler;
+} as CommandModule;

package/cmd/use.ts

@@ -1,19 +1,20 @@
 import fs from "node:fs";
 
 import { select } from "@inquirer/prompts";
-import type { CommandModule } from "yargs";
 
 import { Configuration } from "#lib/config";
 import { NotFoundError } from "#lib/error";
-import { logger } from "#lib/logger";
+import { Logger } from "#lib/logger";
 
-const data = {
+export default {
     command: 'use',
     describe: 'Set the current environment to use',
     builder: (yargs) => yargs
         .usage('Usage: envedit use'),
-    handler: async (_args) => {
-        const config = new Configuration().loadConfigurationFile();
+    handler: async (argv) => {
+        const logger = new Logger(argv.level);
+
+        const config = new Configuration().load();
 
         const name = await select({
             message: "Select the environment to use",
@@ -39,7 +40,7 @@ const data = {
                 env.isActive = env.name === name;
             }
 
-            config.saveConfigurationFile();
+            config.save();
         }
 
         logger.debug(`Creating symlink to environment file: ${selectedEnv.file}`);
@@ -54,9 +55,4 @@ const data = {
 
         fs.symlinkSync(envFilePath, '.env', 'file');
     }
-} satisfies CommandModule;
-
-export const command = data.command;
-export const describe = data.describe;
-export const builder = data.builder;
-export const handler = data.handler;
+} as CommandModule;

package/cmd/variable.ts

@@ -1,21 +1,10 @@
-import type { CommandModule } from "yargs";
+import Commands from "./variableCmd";
 
-import Add from "./variable/add";
-import Edit from "./variable/edit";
-import List from "./variable/list";
-import Remove from "./variable/remove";
-
-const data = {
+export default {
     command: 'variable',
     describe: 'Manage environment variables',
     builder: (yargs) => yargs
         .usage('Usage: envedit variable <command> [options]')
-        .command([Add, Edit, List, Remove])
+        .command(Commands)
         .demandCommand(),
-    handler: async (_args) => {}
-} satisfies CommandModule;
-
-export const command = data.command;
-export const describe = data.describe;
-export const builder = data.builder;
-export const handler = data.handler;
+} as CommandModule;

package/cmd/{variable → variableCmd}/add.ts

@@ -1,16 +1,16 @@
 import { confirm, input, password, select } from "@inquirer/prompts";
-import type { CommandModule } from "yargs";
 
 import { Configuration, EnvironmentFile, VariableType } from "#lib/config";
 import { NotFoundError } from "#lib/error";
-import { logger } from "#lib/logger";
+import { Logger } from "#lib/logger";
 
 export default {
     command: 'add',
     describe: 'Add a new environment variable',
     builder: (yargs) => yargs,
-    handler: async (_args) => {
-        const config = new Configuration().loadConfigurationFile();
+    handler: async (argv) => {
+        const config = new Configuration().load();
+        const logger = new Logger(argv.level);
 
         const name = await input({
             message: "Enter the variable name:",
@@ -33,12 +33,11 @@ export default {
             ],
         });
 
-        logger
-            .debug(`Adding new variable "${name}" with type "${type}"`);
+        logger.debug(`Adding new variable "${name}" with type "${type}"`);
 
         config
             .addVariable({ name, type })
-            .saveConfigurationFile();
+            .save();
 
         const shouldGloballySet = await confirm({
             message: "Do you want to set this variable with a global value for all environments?",
@@ -59,8 +58,7 @@ export default {
                 ? await password(request)
                 : await input(request);
 
-            logger
-                .debug(`Setting variable "${name}" with global value "${globalValue}" for all environments`);
+            logger.debug(`Setting variable "${name}" with global value "${globalValue}" for all environments`);
 
             valuesToSet.forEach((envValue) => { envValue.value = globalValue });
         } else {
@@ -74,15 +72,13 @@ export default {
                     ? await password(request)
                     : await input(request);
 
-                logger
-                    .debug(`Setting variable "${name}" with value "${envValue.value}" for environment "${envValue.envName}"`);
+                logger.debug(`Setting variable "${name}" with value "${envValue.value}" for environment "${envValue.envName}"`);
             }
         }
 
         for (const envValue of valuesToSet) {
             const env = config.getEnvironment(envValue.envName);
-            logger
-                .debug(`Retrieving environment: ${envValue.envName}`);
+            logger.debug(`Retrieving environment: ${envValue.envName}`);
 
             if (!env) {
                 throw new NotFoundError(`Environment not found: ${envValue.envName}`);

package/cmd/{variable → variableCmd}/edit.ts

@@ -1,16 +1,16 @@
 import { confirm, input, password, select, checkbox } from "@inquirer/prompts";
-import type { CommandModule } from "yargs";
 
 import { Configuration, EnvironmentFile, VariableType } from "#lib/config";
 import { NotFoundError } from "#lib/error";
-import { logger } from "#lib/logger";
+import { Logger } from "#lib/logger";
 
 export default {
     command: 'edit',
     describe: 'Edit an environment variable',
     builder: (yargs) => yargs,
-    handler: async (_args) => {
-        const config = new Configuration().loadConfigurationFile();
+    handler: async (argv) => {
+        const config = new Configuration().load();
+        const logger = new Logger(argv.level);
 
         const name = await select({
             message: "Select the variable to edit:",
@@ -35,8 +35,7 @@ export default {
         });
 
         if (isEditingConfig) {
-            logger
-                .debug(`Editing variable configuration for: ${name}`);
+            logger.debug(`Editing variable configuration for: ${name}`);
 
             const itemsToEdit = await checkbox({
                 message: "Select the items to edit:",
@@ -57,8 +56,7 @@ export default {
                 for (const env of config.configuration.environments) {
                     const envFile = new EnvironmentFile(env.file).load();
 
-                    logger
-                        .debug(`Editing variable "${name}" in environment file: ${env.file}`);
+                    logger.debug(`Editing variable "${name}" in environment file: ${env.file}`);
 
                     if (envFile.content[name] !== undefined) {
                         const value = envFile.content[name];
@@ -79,16 +77,14 @@ export default {
                     default: variableConfiguration.type,
                 });
 
-                logger
-                    .debug(`Editing variable type for "${name}" to "${updatedVariable.type}"`);
+                logger.debug(`Editing variable type for "${name}" to "${updatedVariable.type}"`);
             }
 
             config
                 .editVariable(name, updatedVariable)
-                .saveConfigurationFile();
+                .save();
         } else {
-            logger
-                .debug(`Adding editing variable value for: ${name}`);
+            logger.debug(`Adding editing variable value for: ${name}`);
 
             let valuesToSet = config.configuration.environments.map(env => ({
                 envName: env.name,
@@ -109,8 +105,7 @@ export default {
                     ? await password(request)
                     : await input(request);
 
-                logger
-                    .debug(`Setting variable "${variableConfiguration.name}" with global value "${globalValue}" for all environments`);
+                logger.debug(`Setting variable "${variableConfiguration.name}" with global value "${globalValue}" for all environments`);
 
                 valuesToSet.forEach((envValue) => { envValue.value = globalValue });
             } else {
@@ -122,8 +117,7 @@ export default {
                     })),
                 });
 
-                logger
-                    .debug(`Selected environments for editing: ${envsToEdit.join(", ")}`);
+                logger.debug(`Selected environments for editing: ${envsToEdit.join(", ")}`);
 
                 valuesToSet = valuesToSet.filter(envValue => envsToEdit.includes(envValue.envName));
 
@@ -151,8 +145,7 @@ export default {
                     throw new NotFoundError(`Environment not found: ${envValue.envName}`);
                 }
 
-                logger
-                    .debug(`Setting variable "${variableConfiguration.name}" with value "${envValue.value}" in environment file: ${env.file}`);
+                logger.debug(`Setting variable "${variableConfiguration.name}" with value "${envValue.value}" in environment file: ${env.file}`);
 
                 EnvironmentFile.quickUpdate(env.file, variableConfiguration.name, envValue.value);
             }

package/cmd/variableCmd/index.ts

@@ -0,0 +1,6 @@
+import Add from "./add";
+import Edit from "./edit";
+import List from "./list";
+import Remove from "./remove";
+
+export default [Add, Edit, List, Remove]

package/cmd/variableCmd/list.ts

@@ -0,0 +1,35 @@
+import { Configuration, EnvironmentFile, VariableType } from "#lib/config";
+import { NotFoundError } from "#lib/error";
+import { Logger } from "#lib/logger";
+
+export default {
+    command: 'list',
+    describe: 'List all environment variables',
+    builder: (yargs) => yargs,
+    handler: async (argv) => {
+        const config = new Configuration().load();
+        const logger = new Logger(argv.level);
+
+        const activeEnv = config.getActiveEnvironment();
+
+        if (!activeEnv) {
+            throw new NotFoundError(`No active environment found. Please set an active environment using the "use" command.`);
+        }
+
+        const envFile = new EnvironmentFile(activeEnv.file).load();
+
+        for (const [key, value] of Object.entries(envFile.content)) {
+            const variableConfiguration = config.getVariable(key);
+            if (variableConfiguration) {
+                const type = Configuration.getTypeDetails(variableConfiguration.type);
+
+                const maskedValue = type.value === VariableType.Private ? value.replaceAll(/./gm, '*') : value;
+
+                logger
+                    .info(`Name: ${key}`)
+                    .info(`Value: ${maskedValue}`)
+                    .info(`Type: ${type.name} (${type.value})`);
+            }
+        }
+    }
+} satisfies CommandModule;

package/cmd/{variable → variableCmd}/remove.ts

@@ -1,16 +1,16 @@
 import { select } from "@inquirer/prompts";
-import type { CommandModule } from "yargs";
 
 import { Configuration, EnvironmentFile } from "#lib/config";
 import { NotFoundError } from "#lib/error";
-import { logger } from "#lib/logger";
+import { Logger } from "#lib/logger";
 
 export default {
     command: 'remove',
     describe: 'Remove an environment variable',
     builder: (yargs) => yargs,
-    handler: async (_args) => {
-        const config = new Configuration().loadConfigurationFile();
+    handler: async (argv) => {
+        const config = new Configuration().load();
+        const logger = new Logger(argv.level);
 
         const name = await select({
             message: "Select the variable to remove:",
@@ -24,19 +24,17 @@ export default {
             throw new NotFoundError(`Variable not found: ${name}`);
         }
 
-        logger
-            .debug(`Removing variable "${name}" from configuration and all environment files`);
+        logger.debug(`Removing variable "${name}" from configuration and all environment files`);
 
         config
             .removeVariable(name)
-            .saveConfigurationFile();
+            .save();
 
         for (const env of config.configuration.environments) {
             const envFile = new EnvironmentFile(env.file).load();
 
             if (envFile.content[name] !== undefined) {
-                logger
-                    .debug(`Removing variable "${name}" from environment file: ${env.file}`);
+                logger.debug(`Removing variable "${name}" from environment file: ${env.file}`);
                 envFile.removeVariable(name).save();
             }
         }

package/index.ts

@@ -2,24 +2,20 @@
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
 
-import { logger } from "#lib/logger";
+import Commands from "./cmd";
 
 await yargs(hideBin(process.argv))
+    .option("level", {
+        alias: "l",
+        type: "string",
+        description: "Set the log level",
+        choices: ['debug', 'info', 'warn', 'error', 'fatal'],
+        default: process.env.LOG_LEVEL || "info",
+    })
+    .env('ENVEDIT')
     .scriptName("envedit")
     .usage("Usage: $0 <command>")
-    .commandDir(
-        `${import.meta.dir}/cmd`,
-        {
-            extensions: ['ts'],
-            visit: (commandObject, commandPath, filename) => {
-                logger.debug(`Loading command: ${commandPath}`);
-
-                logger.debug(`Command Name: ${commandObject.command}`);
-                logger.debug(`Command Description: ${commandObject.describe}`);
-
-                return commandObject;
-            }
-        },
-    )
+    .command(Commands)
     .demandCommand()
+    .strict()
     .parseAsync();

package/lib/config.ts

@@ -3,6 +3,9 @@ import fs from 'fs';
 import { parse } from 'dotenv';
 
 import { NotFoundError } from '#lib/error';
+import { Logger } from '#lib/logger';
+
+const logger = new Logger(process.env.LOG_LEVEL || 'info');
 
 export enum VariableType {
     Public,
@@ -50,10 +53,10 @@ export class Configuration {
         };
     }
 
-    public loadConfigurationFile() {
+    public load() {
         if (!fs.existsSync(this.configFilePath)) {
-            console.log(`Configuration file not found: ${this.configFilePath}`);
-            console.log(`Creating a new configuration file`);
+            logger.info(`Configuration file not found: ${this.configFilePath}`);
+            logger.info(`Creating a new configuration file`);
 
             const config = new Configuration();
 
@@ -61,7 +64,7 @@ export class Configuration {
                 config.importFromEnv(fs.readFileSync('.env', "utf-8"));
             }
 
-            this.saveConfigurationFile();
+            this.save();
         }
 
         const configContent = Bun.YAML.parse(fs.readFileSync(this.configFilePath, "utf-8")) as GeneralConfiguration;
@@ -72,7 +75,7 @@ export class Configuration {
         return this;
     }
 
-    public saveConfigurationFile() {
+    public save() {
         fs.writeFileSync(
             this.configFilePath,
             Bun.YAML.stringify(this.configuration, null, 2),
@@ -181,6 +184,20 @@ export class Configuration {
 
         return config;
     }
+
+    public static getTypeDetails(type: VariableType): { name: keyof typeof VariableType, value: VariableType } {
+        const VariableTypeMap = Object.entries(VariableType).reduce((acc, [key, value]) => {
+            if (typeof value === "number") {
+                acc[value] = key as keyof typeof VariableType;
+            }
+            return acc;
+        }, {} as Record<number, keyof typeof VariableType>);
+
+        return {
+            name: VariableTypeMap[type]!,
+            value: type
+        };
+    }
 }
 
 export class EnvironmentFile {

package/lib/logger.ts

@@ -1,15 +1,40 @@
 import pino from 'pino';
+import type { LevelWithSilentOrString, Logger as PinoLogger } from 'pino';
 
-const level = process.env.LOG_LEVEL || 'info';
+export class Logger {
+    private readonly logger: PinoLogger<never, boolean>;
+    constructor(public readonly level: LevelWithSilentOrString) {
+        this.logger = pino({
+            level,
+            transport: {
+                target: 'pino-pretty',
+                options: {
+                    colorize: true,
+                    translateTime: 'SYS:standard',
+                    ignore: 'pid,hostname',
+                },
+            },
+        });
+    }
 
-export const logger = pino({
-    level,
-    transport: {
-        target: 'pino-pretty',
-        options: {
-            colorize: true,
-            translateTime: 'SYS:standard',
-            ignore: 'pid,hostname',
-        },
-    },
-});
+    public readonly debug = (msg: string) => {
+        this.logger.debug(msg);
+        return this;
+    }
+    public readonly info = (msg: string) => {
+        this.logger.info(msg);
+        return this;
+    }
+    public readonly warn = (msg: string) => {
+        this.logger.warn(msg);
+        return this;
+    }
+    public readonly error = (msg: string) => {
+        this.logger.error(msg);
+        return this;
+    }
+    public readonly fatal = (msg: string) => {
+        this.logger.fatal(msg);
+        return this;
+    }
+}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@benshawmean/envedit",
   "module": "index.ts",
   "type": "module",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "license": "GPL-3.0-only",
   "bin": {
     "envedit": "index.ts"

package/tsconfig.json

@@ -7,7 +7,7 @@
     "moduleDetection": "force",
     "jsx": "react-jsx",
     "allowJs": true,
-    "types": ["bun"],
+    "types": ["bun", "./@types/custom.d.ts"],
 
     // Bundler mode
     "moduleResolution": "bundler",

package/cmd/variable/list.ts

@@ -1,43 +0,0 @@
-import type { CommandModule } from "yargs";
-
-import { Configuration, EnvironmentFile, VariableType } from "#lib/config";
-import { NotFoundError } from "#lib/error";
-import { logger } from "#lib/logger";
-
-export default {
-    command: 'list',
-    describe: 'List all environment variables',
-    builder: (yargs) => yargs,
-    handler: async (_args) => {
-        const config = new Configuration().loadConfigurationFile();
-
-        const activeEnv = config.getActiveEnvironment();
-
-        if (!activeEnv) {
-            throw new NotFoundError(`No active environment found. Please set an active environment using the "use" command.`);
-        }
-
-        const envFile = new EnvironmentFile(activeEnv.file).load();
-
-        const mappedVariables: Array<{ name: string; value: string; type: VariableType }> = [];
-
-        for (const [key, value] of Object.entries(envFile.content)) {
-            const variableConfiguration = config.getVariable(key);
-            if (variableConfiguration) {
-                logger.debug(`Mapping variable "${key}" with value "${value}" and type "${variableConfiguration.type}"`);
-
-                const data = {
-                    name: key,
-                    value: variableConfiguration.type === VariableType.Private ? value.replaceAll(/./gm, '*') : value,
-                    type: variableConfiguration.type,
-                };
-
-                mappedVariables.push(data);
-            }
-        }
-
-        console.log(
-            JSON.stringify(mappedVariables, null, 2)
-        )
-    }
-} satisfies CommandModule;