@ben-studios/envedit 0.0.0-stage → 1.0.0

package/coverage/.lcov.info.64d068458fa931ef.tmp

@@ -0,0 +1,139 @@
+TN:
+SF:lib/config.ts
+FNF:12
+FNH:12
+DA:1,46
+DA:2,50
+DA:3,48
+DA:4,52
+DA:5,48
+DA:8,62
+DA:10,86
+DA:12,133
+DA:13,108
+DA:14,114
+DA:39,1
+DA:41,27
+DA:42,81
+DA:43,10
+DA:44,94
+DA:45,22
+DA:46,9
+DA:48,154
+DA:50,39
+DA:52,103
+DA:54,124
+DA:55,118
+DA:59,20
+DA:60,12
+DA:61,42
+DA:62,52
+DA:63,56
+DA:64,102
+DA:65,90
+DA:66,26
+DA:67,26
+DA:68,12
+DA:70,33
+DA:73,22
+DA:74,160
+DA:76,99
+DA:79,28
+DA:80,70
+DA:81,61
+DA:82,9
+DA:84,123
+DA:85,136
+DA:86,9
+DA:88,32
+DA:91,43
+DA:92,123
+DA:93,122
+DA:94,9
+DA:96,43
+DA:99,38
+DA:100,72
+DA:102,127
+DA:103,104
+DA:104,72
+DA:105,9
+DA:107,28
+DA:108,76
+DA:109,30
+DA:110,8
+DA:112,2
+DA:114,62
+DA:115,33
+DA:116,91
+DA:117,42
+DA:118,42
+DA:119,36
+DA:121,60
+DA:122,32
+DA:123,5
+DA:124,9
+DA:127,20
+DA:128,50
+DA:129,109
+DA:130,86
+DA:131,8
+DA:133,2
+LF:76
+LH:76
+end_of_record
+TN:
+SF:lib/error.ts
+FNF:1
+FNH:1
+DA:1,42
+DA:2,15
+DA:3,19
+DA:4,31
+LF:4
+LH:4
+end_of_record
+TN:
+SF:lib/logger.ts
+FNF:6
+FNH:6
+DA:1,47
+DA:14,1
+DA:16,177
+DA:17,61
+DA:20,43
+DA:21,69
+DA:22,32
+DA:24,41
+DA:25,68
+DA:26,32
+DA:28,41
+DA:29,68
+DA:30,32
+DA:32,43
+DA:33,69
+DA:34,32
+DA:36,43
+DA:37,69
+DA:38,30
+DA:40,2
+LF:20
+LH:20
+end_of_record
+TN:
+SF:test/util.ts
+FNF:2
+FNH:2
+DA:1,21
+DA:2,21
+DA:3,23
+DA:4,24
+DA:7,30
+DA:8,47
+DA:9,22
+DA:10,24
+DA:11,17
+DA:12,2
+DA:13,4
+LF:11
+LH:11
+end_of_record

package/coverage/junit.xml

@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuites name="bun test" tests="16" assertions="34" failures="0" skipped="0" time="0.164498">
+  <testsuite name="test/error.test.ts" file="test/error.test.ts" tests="1" assertions="4" failures="0" skipped="0" time="0.052159" hostname="Bens-Mac.local">
+    <testsuite name="Error Handling" file="test/error.test.ts" line="8" tests="1" assertions="4" failures="0" skipped="0" time="0.003" hostname="Bens-Mac.local">
+      <testcase name="NotFoundError should have correct name and message" classname="Error Handling" time="0.003242" file="test/error.test.ts" line="9" assertions="4" />
+    </testsuite>
+  </testsuite>
+  <testsuite name="test/variable.test.ts" file="test/variable.test.ts" tests="9" assertions="20" failures="0" skipped="0" time="0.024627" hostname="Bens-Mac.local">
+    <testsuite name="Variable Management" file="test/variable.test.ts" line="8" tests="9" assertions="20" failures="0" skipped="0" time="0.002" hostname="Bens-Mac.local">
+      <testcase name="Import variables from .env content" classname="Variable Management" time="0.001122" file="test/variable.test.ts" line="11" assertions="2" />
+      <testcase name="Add a new variable" classname="Variable Management" time="0.001079" file="test/variable.test.ts" line="26" assertions="1" />
+      <testcase name="Edit an existing variable" classname="Variable Management" time="0.000109" file="test/variable.test.ts" line="35" assertions="1" />
+      <testcase name="Remove an existing variable" classname="Variable Management" time="0.000379" file="test/variable.test.ts" line="43" assertions="1" />
+      <testcase name="Verify Type Details" classname="Variable Management" time="0.000082" file="test/variable.test.ts" line="51" assertions="7" />
+      <testsuite name="Environment File" file="test/variable.test.ts" line="67" tests="4" assertions="8" failures="0" skipped="0" time="0" hostname="Bens-Mac.local">
+        <testcase name="Has Initialized Properly" classname="Environment File &gt; Variable Management" time="0.000251" file="test/variable.test.ts" line="76" assertions="3" />
+        <testcase name="Add Variable" classname="Environment File &gt; Variable Management" time="0.000169" file="test/variable.test.ts" line="82" assertions="2" />
+        <testcase name="Edit Variable" classname="Environment File &gt; Variable Management" time="0.000142" file="test/variable.test.ts" line="91" assertions="2" />
+        <testcase name="Remove Variable" classname="Environment File &gt; Variable Management" time="0.000087" file="test/variable.test.ts" line="100" assertions="1" />
+      </testsuite>
+    </testsuite>
+  </testsuite>
+  <testsuite name="test/config.test.ts" file="test/config.test.ts" tests="5" assertions="5" failures="0" skipped="0" time="0.001569" hostname="Bens-Mac.local">
+    <testsuite name="Environment Management" file="test/config.test.ts" line="8" tests="5" assertions="5" failures="0" skipped="0" time="0" hostname="Bens-Mac.local">
+      <testcase name="Add a new environment" classname="Environment Management" time="0.000073" file="test/config.test.ts" line="11" assertions="1" />
+      <testcase name="Edit an existing environment" classname="Environment Management" time="0.000056" file="test/config.test.ts" line="20" assertions="1" />
+      <testcase name="Set an environment as active" classname="Environment Management" time="0.000176" file="test/config.test.ts" line="30" assertions="1" />
+      <testcase name="Set no environment as active" classname="Environment Management" time="0.000066" file="test/config.test.ts" line="40" assertions="1" />
+      <testcase name="Remove an existing environment" classname="Environment Management" time="0.000072" file="test/config.test.ts" line="47" assertions="1" />
+    </testsuite>
+  </testsuite>
+  <testsuite name="test/logger.test.ts" file="test/logger.test.ts" tests="1" assertions="5" failures="0" skipped="0" time="0.049246" hostname="Bens-Mac.local">
+    <testsuite name="Logging Utilities" file="test/logger.test.ts" line="8" tests="1" assertions="5" failures="0" skipped="0" time="0.001" hostname="Bens-Mac.local">
+      <testcase name="To Not Throw Errors" classname="Logging Utilities" time="0.001158" file="test/logger.test.ts" line="15" assertions="5" />
+    </testsuite>
+  </testsuite>
+</testsuites>

package/coverage/lcov.info

@@ -0,0 +1,139 @@
+TN:
+SF:lib/config.ts
+FNF:12
+FNH:12
+DA:1,46
+DA:2,50
+DA:3,48
+DA:4,52
+DA:5,48
+DA:8,62
+DA:10,86
+DA:12,133
+DA:13,108
+DA:14,114
+DA:39,1
+DA:41,27
+DA:42,81
+DA:43,10
+DA:44,94
+DA:45,22
+DA:46,9
+DA:48,154
+DA:50,39
+DA:52,103
+DA:54,124
+DA:55,118
+DA:59,20
+DA:60,12
+DA:61,42
+DA:62,52
+DA:63,56
+DA:64,102
+DA:65,90
+DA:66,26
+DA:67,26
+DA:68,12
+DA:70,33
+DA:73,22
+DA:74,160
+DA:76,99
+DA:79,28
+DA:80,70
+DA:81,61
+DA:82,9
+DA:84,123
+DA:85,136
+DA:86,9
+DA:88,32
+DA:91,43
+DA:92,123
+DA:93,122
+DA:94,9
+DA:96,43
+DA:99,38
+DA:100,72
+DA:102,127
+DA:103,104
+DA:104,72
+DA:105,9
+DA:107,28
+DA:108,76
+DA:109,30
+DA:110,8
+DA:112,2
+DA:114,62
+DA:115,33
+DA:116,91
+DA:117,42
+DA:118,42
+DA:119,36
+DA:121,60
+DA:122,32
+DA:123,5
+DA:124,9
+DA:127,20
+DA:128,50
+DA:129,109
+DA:130,86
+DA:131,8
+DA:133,2
+LF:76
+LH:76
+end_of_record
+TN:
+SF:lib/error.ts
+FNF:1
+FNH:1
+DA:1,42
+DA:2,15
+DA:3,19
+DA:4,31
+LF:4
+LH:4
+end_of_record
+TN:
+SF:lib/logger.ts
+FNF:6
+FNH:6
+DA:1,47
+DA:14,1
+DA:16,177
+DA:17,61
+DA:20,43
+DA:21,69
+DA:22,32
+DA:24,41
+DA:25,68
+DA:26,32
+DA:28,41
+DA:29,68
+DA:30,32
+DA:32,43
+DA:33,69
+DA:34,32
+DA:36,43
+DA:37,69
+DA:38,30
+DA:40,2
+LF:20
+LH:20
+end_of_record
+TN:
+SF:test/util.ts
+FNF:2
+FNH:2
+DA:1,21
+DA:2,21
+DA:3,23
+DA:4,24
+DA:7,30
+DA:8,47
+DA:9,22
+DA:10,24
+DA:11,17
+DA:12,2
+DA:13,4
+LF:11
+LH:11
+end_of_record

package/lib/config.ts

@@ -0,0 +1,133 @@
+import {
+    existsSync as exists,
+    readFileSync as read,
+    writeFileSync as write,
+    appendFileSync as append,
+} from 'fs';
+
+import { parse } from 'dotenv';
+
+import { NotFoundError } from '#lib/error';
+
+export enum VariableType {
+    Public,
+    Private,
+}
+
+export interface VariableConfiguration {
+    name: string;
+    type: VariableType;
+}
+
+export interface EnvironmentConfiguration {
+    name: string;
+    prefix: string;
+    file: string;
+    isActive: boolean;
+}
+
+export interface GeneralConfiguration {
+    version: number;
+    environments: EnvironmentConfiguration[];
+    variables: VariableConfiguration[];
+}
+
+export class Configuration {
+    public readonly vars: Map<string, VariableConfiguration> = new Map();
+    public readonly envs: Map<string, EnvironmentConfiguration> = new Map();
+    public readonly version: number = 1;
+    private readonly configFilePath: string = 'env.config.yaml';
+
+    constructor() {
+        if (!exists(this.configFilePath)) {
+            this
+                .importFromEnv(exists('.env') ? read('.env', "utf-8") : '')
+                .save();
+        }
+
+        const configContent = Bun.YAML.parse(read(this.configFilePath, "utf-8")) as GeneralConfiguration;
+
+        const setWrapper = <
+            K extends EnvironmentConfiguration | VariableConfiguration
+        >(map: Map<string, K>): ((item: K) => void) => (item: K) => void map.set(item.name, item);
+
+        configContent.environments.forEach(setWrapper(this.envs))
+        configContent.variables.forEach(setWrapper(this.vars))
+    }
+
+    public save() {
+        write(
+            this.configFilePath,
+            Bun.YAML.stringify({
+                "$schema": "https://benshawmean.com/api/schema/envedit",
+                version: this.version,
+                environments: Array.from(this.envs.values()),
+                variables: Array.from(this.vars.values()),
+            }, null, 2),
+            { mode: 0o600 },
+        );
+
+        return this;
+    }
+
+    public get active() {
+        const activeEnv = Array.from(this.envs.values()).find(env => env.isActive);
+
+        return activeEnv ? activeEnv.name : undefined;
+    }
+
+    public set active(env: string | undefined) {
+        if (env && !this.envs.has(env)) {
+            throw new NotFoundError(`Environment not found: ${env}`)
+        }
+
+        for (const [name, environment] of this.envs.entries()) {
+            this.envs.set(name, { ...environment, isActive: name === env });
+        }
+
+        this.save();
+    }
+
+    public importFromEnv(content: string): Configuration {
+        for (const [key, _] of Object.entries(parse(content))) {
+            this.vars.set(key, { name: key, type: VariableType.Private });
+        }
+
+        return this;
+    }
+
+    public static getTypeDetails(type: VariableType) {
+        const VariableTypeMap = new Map<number, keyof typeof VariableType>();
+
+        for (const [key, value] of Object.entries(VariableType)) {
+            if (typeof value !== "number") continue;
+            VariableTypeMap.set(value, key as keyof typeof VariableType);
+        }
+
+        return {
+            name: VariableTypeMap.get(type)!,
+            value: type
+        };
+    }
+}
+
+export class EnvironmentFile {
+    public readonly vars: Map<string, string> = new Map();
+    constructor(public readonly path: string) {
+        if (exists(path)) {
+            const content = read(path, "utf-8");
+            const parsed = parse(content);
+
+            for (const [key, value] of Object.entries(parsed)) {
+                this.vars.set(key, value);
+            }
+        }
+    }
+
+    public save() {
+        write(this.path, '')
+        for (const [key, value] of this.vars.entries()) {
+            append(this.path, `${key}='${value}'\n`);
+        }
+    }
+}

package/lib/error.ts

@@ -0,0 +1,6 @@
+export class NotFoundError extends Error {
+    constructor(message?: string) {
+        super(message);
+        this.name = 'NotFoundError';
+    }
+};

package/lib/logger.ts

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

package/package.json

@@ -1,6 +1,29 @@
 {
   "name": "@ben-studios/envedit",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "type": "module",
+  "version": "1.0.0",
+  "license": "GPL-3.0-only",
+  "bin": {
+    "envedit": "cli/index.ts"
+  },
+  "repository": {
+    "url": "https://gitlab.com/ben-studios/envedit.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/bun": "^1.3.14",
+    "@types/yargs": "^17.0.35"
+  },
+  "peerDependencies": {
+    "typescript": "^5"
+  },
+  "dependencies": {
+    "@inquirer/prompts": "^8.5.2",
+    "dotenv": "^17.4.2",
+    "pino": "^10.3.1",
+    "pino-pretty": "^13.1.3",
+    "yargs": "^18.1.0"
+  }
 }

package/tsconfig.json

@@ -0,0 +1,35 @@
+{
+  "compilerOptions": {
+    // Environment setup & latest features
+    "lib": ["ESNext"],
+    "target": "ESNext",
+    "module": "Preserve",
+    "moduleDetection": "force",
+    "jsx": "react-jsx",
+    "allowJs": true,
+    "types": ["bun", "./@types/custom.d.ts"],
+
+    // Bundler mode
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+
+    // Best practices
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true,
+
+    // Some stricter flags (disabled by default)
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noPropertyAccessFromIndexSignature": false,
+
+    "paths": {
+      "@/*": ["./*"],
+      "#lib/*": ["./lib/*"]
+    }
+  }
+}