chore!: remove flag for useFlagInstead

Author: GalvinPython

README.md

@@ -60,6 +60,10 @@ API_KEY: test
 
 ## Preview
 
+### 0.2.0
+
+- Removed `flag` property for `useFlagInstead`
+
 ### 0.1.0
 
 - Added documentation

SECURITY.md

@@ -8,9 +8,6 @@ Only the latest major version is actively maintained and receives security updat
 | ------- | --------- |
 | 0.x     | ✅        |
 
-<!-- For future reference -->
-<!-- | 0.x     | ❌        | -->
-
 ## Reporting a Vulnerability
 
 If you discover a security vulnerability in this project, please report it responsibly using one of the two listed methods. Do **not** create an issue about any vulnerabilities.
@@ -27,4 +24,4 @@ I prefer it if you [opened a GitHub security advisory](https://github.com/galvin
 
 ### Alternative Contact
 
-If you do not wish to use GitHub, you may send an email to `imgalvin@pm.me` with the details of the issue
+If you do not wish to use GitHub, you may send an email to `contact@socialstats.app` with the details of the issue

package-lock.json

@@ -27,8 +27,14 @@ export interface VariableDefinition<T = unknown> {
 
     /**
      * Optional CLI flag (e.g., --token) that can be used instead of ENV.
+     * @alias Removed `flag` property. Use this instead.
      */
-    flag?: string;
+    useFlagInstead?: string;
+
+    /**
+     * Only load the variable if this CLI flag is present.
+     */
+    useWithFlag?: string;
 
     /**
      * Whether to quit the process if a required variable is missing.
@@ -88,20 +94,20 @@ export class EnvManager<T extends ProjectVars = {}> {
                 required = false,
                 default: defVal,
                 type = (v => v) as (val: string) => any,
-                flag,
+                useFlagInstead,
                 quitOnMissing,
             } = def;
 
             if (!result[project]) result[project] = {};
 
             // First try CLI flag, then fallback to env var
-            const raw = (flag && this.getFlagValue(flag)) || process.env[name];
+            const raw = (useFlagInstead && this.getFlagValue(useFlagInstead)) || process.env[name];
 
             if (raw === undefined || raw === "") {
                 if (defVal !== undefined) {
                     result[project][name] = defVal;
                 } else if (required) {
-                    const msg = `Missing required variable/flag: ${name}${flag ? ` (flag: ${flag})` : ""}`;
+                    const msg = `Missing required variable/flag: ${name}${useFlagInstead ? ` (useFlagInstead: ${useFlagInstead})` : ""}`;
                     if (quitOnMissing !== false) throw new Error(msg);
                     else console.warn(msg);
                 }

src/index.ts

@@ -13,7 +13,7 @@ describe("EnvManager", () => {
         const manager = new EnvManager()
             .add({
                 name: "DISCORD_TOKEN",
-                flag: "--discord-token",
+                useFlagInstead: "--discord-token",
                 type: String,
                 project: "discordBot",
                 required: true,
@@ -28,7 +28,7 @@ describe("EnvManager", () => {
         const manager = new EnvManager()
             .add({
                 name: "PORT",
-                flag: "--port",
+                useFlagInstead: "--port",
                 type: Number,
                 project: "apiServer",
                 default: 3000,
@@ -47,7 +47,7 @@ describe("EnvManager", () => {
         const manager = new EnvManager()
             .add({
                 name: "PORT",
-                flag: "--port",
+                useFlagInstead: "--port",
                 type: Number,
                 project: "apiServer",
                 required: false