@karmaniverous/get-dotenv 6.0.0-0 → 6.0.0

package/dist/templates/cli/index.ts

@@ -0,0 +1,26 @@
+#!/usr/bin/env node
+
+import { createCli } from '@karmaniverous/get-dotenv/cli';
+
+import {
+  awsPlugin,
+  awsWhoamiPlugin,
+  batchPlugin,
+  cmdPlugin,
+  initPlugin,
+} from '@/src/plugins';
+
+import { helloPlugin } from './plugins/hello';
+
+await createCli({
+  alias: 'mycli',
+  compose: (program) =>
+    program
+      .use(
+        cmdPlugin({ asDefault: true, optionAlias: '-c, --cmd <command...>' }),
+      )
+      .use(batchPlugin())
+      .use(awsPlugin().use(awsWhoamiPlugin()))
+      .use(initPlugin())
+      .use(helloPlugin()),
+})();

package/dist/templates/cli/plugins/hello.ts

@@ -0,0 +1,43 @@
+import {
+  definePlugin,
+  getRootCommand,
+} from '@karmaniverous/get-dotenv/cliHost';
+import { z } from 'zod';
+
+const HelloConfigSchema = z.object({
+  loud: z.boolean().optional().default(false),
+  color: z.string().optional(),
+});
+
+export const helloPlugin = () => {
+  const plugin = definePlugin({
+    ns: 'hello',
+    configSchema: HelloConfigSchema,
+    setup(cli) {
+      cli
+        .ns('hello')
+        .description('Say hello with current dotenv context')
+        .addOption(
+          plugin.createPluginDynamicOption(
+            cli,
+            '--loud',
+            (_bag, cfg) =>
+              `print greeting in ALL CAPS${cfg.loud ? ' (default)' : ''}`,
+          ),
+        )
+        .action(() => {
+          const ctx = cli.getCtx();
+          // Derive CLI name from the true root command using a typed helper.
+          const rootName = getRootCommand(cli).name();
+
+          const cfg = plugin.readConfig(cli);
+          const keys = Object.keys(ctx.dotenv);
+          const label = cfg.loud
+            ? `[${rootName}] DOTENV KEYS (${String(keys.length)}):`
+            : `[${rootName}] dotenv keys (${String(keys.length)}):`;
+          console.log(label, keys.join(', '));
+        });
+    },
+  });
+  return plugin;
+};

package/dist/templates/config/js/getdotenv.config.js

@@ -0,0 +1,20 @@
+export default {
+  // Help-time root defaults (example):
+  // rootOptionDefaults: {
+  //   redact: true,
+  //   // redactPatterns: ['API_KEY', 'SECRET'],
+  // },
+  // Help-time visibility (example): hide selected root flags in -h
+  // rootOptionVisibility: { capture: false },
+
+  vars: { APP_SETTING: 'app_value' },
+  envVars: { dev: { ENV_SETTING: 'dev_value' } },
+  dynamic: {
+    GREETING: ({ APP_SETTING = '' }) => `Hello ${APP_SETTING}`,
+    // Example: env-aware dynamic value. The second argument receives the
+    // selected environment (if any); tailor behavior per environment.
+    // For example, with env='dev' this yields "for-dev"; when env is not
+    // provided, this returns an empty string.
+    ENV_TAG: (_vars, env) => (env ? `for-${env}` : ''),
+  },
+};

package/dist/templates/config/json/local/getdotenv.config.local.json

@@ -0,0 +1,7 @@
+{
+  "vars": { "APP_SECRET": "secret_value" },
+  "envVars": {
+    "dev": { "ENV_SECRET": "dev_secret" },
+    "test": { "ENV_SECRET": "test_secret" }
+  }
+}

package/dist/templates/config/json/public/getdotenv.config.json

@@ -0,0 +1,9 @@
+{
+  "vars": {
+    "APP_SETTING": "app_value"
+  },
+  "envVars": {
+    "dev": { "ENV_SETTING": "dev_value" },
+    "test": { "ENV_SETTING": "test_value" }
+  }
+}

package/dist/templates/config/public/getdotenv.config.json

@@ -0,0 +1,8 @@
+{
+  "vars": {
+    "APP_NAME": "my-app"
+  },
+  "envVars": {
+    "dev": { "DEV_ONLY": "1" }
+  }
+}

package/dist/templates/config/ts/getdotenv.config.ts

@@ -0,0 +1,28 @@
+import { defineGetDotenvConfig } from '@karmaniverous/get-dotenv/core';
+
+type Vars = {
+  APP_SETTING?: string;
+  ENV_SETTING?: string;
+};
+
+export default defineGetDotenvConfig<Vars>({
+  // Help-time root defaults (example):
+  // rootOptionDefaults: {
+  //   redact: true,
+  //   // redactPatterns: ['API_KEY', 'SECRET'],
+  // },
+  // Help-time visibility (example): hide selected root flags in -h
+  // rootOptionVisibility: { capture: false },
+
+  vars: { APP_SETTING: 'app_value' },
+  envVars: { dev: { ENV_SETTING: 'dev_value' } },
+  dynamic: {
+    GREETING: ({ APP_SETTING = '' }) => `${APP_SETTING}-ts`,
+    // Example: env-aware dynamic value. The second argument receives the
+    // selected environment (if any); tailor behavior per environment.
+    // For example, with env='dev' this yields "for-dev"; when env is not
+    // provided, this returns an empty string.
+    ENV_TAG: (_vars: Record<string, string | undefined>, env?: string) =>
+      env ? `for-${env}` : '',
+  },
+});

package/dist/templates/config/yaml/local/getdotenv.config.local.yaml

@@ -0,0 +1,7 @@
+vars:
+  APP_SECRET: "secret_value"
+envVars:
+  dev:
+    ENV_SECRET: "dev_secret"
+  test:
+    ENV_SECRET: "test_secret"

package/dist/templates/config/yaml/public/getdotenv.config.yaml

@@ -0,0 +1,7 @@
+vars:
+  APP_SETTING: "app_value"
+envVars:
+  dev:
+    ENV_SETTING: "dev_value"
+  test:
+    ENV_SETTING: "test_value"

package/dist/templates/getdotenv.config.js

@@ -0,0 +1,20 @@
+export default {
+  // Help-time root defaults (example):
+  // rootOptionDefaults: {
+  //   redact: true,
+  //   // redactPatterns: ['API_KEY', 'SECRET'],
+  // },
+  // Help-time visibility (example): hide selected root flags in -h
+  // rootOptionVisibility: { capture: false },
+
+  vars: { APP_SETTING: 'app_value' },
+  envVars: { dev: { ENV_SETTING: 'dev_value' } },
+  dynamic: {
+    GREETING: ({ APP_SETTING = '' }) => `Hello ${APP_SETTING}`,
+    // Example: env-aware dynamic value. The second argument receives the
+    // selected environment (if any); tailor behavior per environment.
+    // For example, with env='dev' this yields "for-dev"; when env is not
+    // provided, this returns an empty string.
+    ENV_TAG: (_vars, env) => (env ? `for-${env}` : ''),
+  },
+};

package/dist/templates/getdotenv.config.json

@@ -0,0 +1,9 @@
+{
+  "vars": {
+    "APP_SETTING": "app_value"
+  },
+  "envVars": {
+    "dev": { "ENV_SETTING": "dev_value" },
+    "test": { "ENV_SETTING": "test_value" }
+  }
+}

package/dist/templates/getdotenv.config.local.json

@@ -0,0 +1,7 @@
+{
+  "vars": { "APP_SECRET": "secret_value" },
+  "envVars": {
+    "dev": { "ENV_SECRET": "dev_secret" },
+    "test": { "ENV_SECRET": "test_secret" }
+  }
+}

package/dist/templates/getdotenv.config.local.yaml

@@ -0,0 +1,7 @@
+vars:
+  APP_SECRET: "secret_value"
+envVars:
+  dev:
+    ENV_SECRET: "dev_secret"
+  test:
+    ENV_SECRET: "test_secret"

package/dist/templates/getdotenv.config.ts

@@ -0,0 +1,28 @@
+import { defineGetDotenvConfig } from '@karmaniverous/get-dotenv/core';
+
+type Vars = {
+  APP_SETTING?: string;
+  ENV_SETTING?: string;
+};
+
+export default defineGetDotenvConfig<Vars>({
+  // Help-time root defaults (example):
+  // rootOptionDefaults: {
+  //   redact: true,
+  //   // redactPatterns: ['API_KEY', 'SECRET'],
+  // },
+  // Help-time visibility (example): hide selected root flags in -h
+  // rootOptionVisibility: { capture: false },
+
+  vars: { APP_SETTING: 'app_value' },
+  envVars: { dev: { ENV_SETTING: 'dev_value' } },
+  dynamic: {
+    GREETING: ({ APP_SETTING = '' }) => `${APP_SETTING}-ts`,
+    // Example: env-aware dynamic value. The second argument receives the
+    // selected environment (if any); tailor behavior per environment.
+    // For example, with env='dev' this yields "for-dev"; when env is not
+    // provided, this returns an empty string.
+    ENV_TAG: (_vars: Record<string, string | undefined>, env?: string) =>
+      env ? `for-${env}` : '',
+  },
+});

package/dist/templates/getdotenv.config.yaml

@@ -0,0 +1,7 @@
+vars:
+  APP_SETTING: "app_value"
+envVars:
+  dev:
+    ENV_SETTING: "dev_value"
+  test:
+    ENV_SETTING: "test_value"

package/dist/templates/hello.ts

@@ -0,0 +1,43 @@
+import {
+  definePlugin,
+  getRootCommand,
+} from '@karmaniverous/get-dotenv/cliHost';
+import { z } from 'zod';
+
+const HelloConfigSchema = z.object({
+  loud: z.boolean().optional().default(false),
+  color: z.string().optional(),
+});
+
+export const helloPlugin = () => {
+  const plugin = definePlugin({
+    ns: 'hello',
+    configSchema: HelloConfigSchema,
+    setup(cli) {
+      cli
+        .ns('hello')
+        .description('Say hello with current dotenv context')
+        .addOption(
+          plugin.createPluginDynamicOption(
+            cli,
+            '--loud',
+            (_bag, cfg) =>
+              `print greeting in ALL CAPS${cfg.loud ? ' (default)' : ''}`,
+          ),
+        )
+        .action(() => {
+          const ctx = cli.getCtx();
+          // Derive CLI name from the true root command using a typed helper.
+          const rootName = getRootCommand(cli).name();
+
+          const cfg = plugin.readConfig(cli);
+          const keys = Object.keys(ctx.dotenv);
+          const label = cfg.loud
+            ? `[${rootName}] DOTENV KEYS (${String(keys.length)}):`
+            : `[${rootName}] dotenv keys (${String(keys.length)}):`;
+          console.log(label, keys.join(', '));
+        });
+    },
+  });
+  return plugin;
+};

package/dist/templates/index.ts

@@ -0,0 +1,26 @@
+#!/usr/bin/env node
+
+import { createCli } from '@karmaniverous/get-dotenv/cli';
+
+import {
+  awsPlugin,
+  awsWhoamiPlugin,
+  batchPlugin,
+  cmdPlugin,
+  initPlugin,
+} from '@/src/plugins';
+
+import { helloPlugin } from './plugins/hello';
+
+await createCli({
+  alias: 'mycli',
+  compose: (program) =>
+    program
+      .use(
+        cmdPlugin({ asDefault: true, optionAlias: '-c, --cmd <command...>' }),
+      )
+      .use(batchPlugin())
+      .use(awsPlugin().use(awsWhoamiPlugin()))
+      .use(initPlugin())
+      .use(helloPlugin()),
+})();

package/dist/templates/js/getdotenv.config.js

@@ -0,0 +1,20 @@
+export default {
+  // Help-time root defaults (example):
+  // rootOptionDefaults: {
+  //   redact: true,
+  //   // redactPatterns: ['API_KEY', 'SECRET'],
+  // },
+  // Help-time visibility (example): hide selected root flags in -h
+  // rootOptionVisibility: { capture: false },
+
+  vars: { APP_SETTING: 'app_value' },
+  envVars: { dev: { ENV_SETTING: 'dev_value' } },
+  dynamic: {
+    GREETING: ({ APP_SETTING = '' }) => `Hello ${APP_SETTING}`,
+    // Example: env-aware dynamic value. The second argument receives the
+    // selected environment (if any); tailor behavior per environment.
+    // For example, with env='dev' this yields "for-dev"; when env is not
+    // provided, this returns an empty string.
+    ENV_TAG: (_vars, env) => (env ? `for-${env}` : ''),
+  },
+};

package/dist/templates/json/local/getdotenv.config.local.json

@@ -0,0 +1,7 @@
+{
+  "vars": { "APP_SECRET": "secret_value" },
+  "envVars": {
+    "dev": { "ENV_SECRET": "dev_secret" },
+    "test": { "ENV_SECRET": "test_secret" }
+  }
+}

package/dist/templates/json/public/getdotenv.config.json

@@ -0,0 +1,9 @@
+{
+  "vars": {
+    "APP_SETTING": "app_value"
+  },
+  "envVars": {
+    "dev": { "ENV_SETTING": "dev_value" },
+    "test": { "ENV_SETTING": "test_value" }
+  }
+}

package/dist/templates/local/getdotenv.config.local.json

@@ -0,0 +1,7 @@
+{
+  "vars": { "APP_SECRET": "secret_value" },
+  "envVars": {
+    "dev": { "ENV_SECRET": "dev_secret" },
+    "test": { "ENV_SECRET": "test_secret" }
+  }
+}

package/dist/templates/local/getdotenv.config.local.yaml

@@ -0,0 +1,7 @@
+vars:
+  APP_SECRET: "secret_value"
+envVars:
+  dev:
+    ENV_SECRET: "dev_secret"
+  test:
+    ENV_SECRET: "test_secret"

package/dist/templates/plugins/hello.ts

@@ -0,0 +1,43 @@
+import {
+  definePlugin,
+  getRootCommand,
+} from '@karmaniverous/get-dotenv/cliHost';
+import { z } from 'zod';
+
+const HelloConfigSchema = z.object({
+  loud: z.boolean().optional().default(false),
+  color: z.string().optional(),
+});
+
+export const helloPlugin = () => {
+  const plugin = definePlugin({
+    ns: 'hello',
+    configSchema: HelloConfigSchema,
+    setup(cli) {
+      cli
+        .ns('hello')
+        .description('Say hello with current dotenv context')
+        .addOption(
+          plugin.createPluginDynamicOption(
+            cli,
+            '--loud',
+            (_bag, cfg) =>
+              `print greeting in ALL CAPS${cfg.loud ? ' (default)' : ''}`,
+          ),
+        )
+        .action(() => {
+          const ctx = cli.getCtx();
+          // Derive CLI name from the true root command using a typed helper.
+          const rootName = getRootCommand(cli).name();
+
+          const cfg = plugin.readConfig(cli);
+          const keys = Object.keys(ctx.dotenv);
+          const label = cfg.loud
+            ? `[${rootName}] DOTENV KEYS (${String(keys.length)}):`
+            : `[${rootName}] dotenv keys (${String(keys.length)}):`;
+          console.log(label, keys.join(', '));
+        });
+    },
+  });
+  return plugin;
+};

package/dist/templates/public/getdotenv.config.json

@@ -0,0 +1,9 @@
+{
+  "vars": {
+    "APP_SETTING": "app_value"
+  },
+  "envVars": {
+    "dev": { "ENV_SETTING": "dev_value" },
+    "test": { "ENV_SETTING": "test_value" }
+  }
+}

package/dist/templates/public/getdotenv.config.yaml

@@ -0,0 +1,7 @@
+vars:
+  APP_SETTING: "app_value"
+envVars:
+  dev:
+    ENV_SETTING: "dev_value"
+  test:
+    ENV_SETTING: "test_value"

package/dist/templates/ts/getdotenv.config.ts

@@ -0,0 +1,28 @@
+import { defineGetDotenvConfig } from '@karmaniverous/get-dotenv/core';
+
+type Vars = {
+  APP_SETTING?: string;
+  ENV_SETTING?: string;
+};
+
+export default defineGetDotenvConfig<Vars>({
+  // Help-time root defaults (example):
+  // rootOptionDefaults: {
+  //   redact: true,
+  //   // redactPatterns: ['API_KEY', 'SECRET'],
+  // },
+  // Help-time visibility (example): hide selected root flags in -h
+  // rootOptionVisibility: { capture: false },
+
+  vars: { APP_SETTING: 'app_value' },
+  envVars: { dev: { ENV_SETTING: 'dev_value' } },
+  dynamic: {
+    GREETING: ({ APP_SETTING = '' }) => `${APP_SETTING}-ts`,
+    // Example: env-aware dynamic value. The second argument receives the
+    // selected environment (if any); tailor behavior per environment.
+    // For example, with env='dev' this yields "for-dev"; when env is not
+    // provided, this returns an empty string.
+    ENV_TAG: (_vars: Record<string, string | undefined>, env?: string) =>
+      env ? `for-${env}` : '',
+  },
+});

package/dist/templates/yaml/local/getdotenv.config.local.yaml

@@ -0,0 +1,7 @@
+vars:
+  APP_SECRET: "secret_value"
+envVars:
+  dev:
+    ENV_SECRET: "dev_secret"
+  test:
+    ENV_SECRET: "test_secret"

package/dist/templates/yaml/public/getdotenv.config.yaml

@@ -0,0 +1,7 @@
+vars:
+  APP_SETTING: "app_value"
+envVars:
+  dev:
+    ENV_SETTING: "dev_value"
+  test:
+    ENV_SETTING: "test_value"

package/getdotenv.config.json

@@ -1,19 +1 @@
-{
-  "//": "Packaged root defaults for get-dotenv (lowest precedence).",
-  "dotenvToken": ".env",
-  "privateToken": "local",
-  "paths": "./",
-  "loadProcess": true,
-  "shell": true,
-  "scripts": {
-    "git-status": {
-      "cmd": "git branch --show-current && git status -s -u",
-      "shell": true
-    }
-  },
-  "excludeDynamic": false,
-  "excludeEnv": false,
-  "excludeGlobal": false,
-  "excludePrivate": false,
-  "excludePublic": false
-}
+{}