@karmaniverous/get-dotenv 6.2.3 → 6.3.0

package/package.json

@@ -57,7 +57,6 @@
     "release-it": "^19.1.0",
     "rimraf": "^6.1.2",
     "rollup": "^4.53.3",
-    "rollup-plugin-copy": "^3.5.0",
     "rollup-plugin-dts": "^6.3.0",
     "tslib": "^2.8.1",
     "tsx": "^4.21.0",
@@ -221,5 +220,5 @@
   },
   "type": "module",
   "types": "dist/index.d.ts",
-  "version": "6.2.3"
+  "version": "6.3.0"
 }

package/dist/templates/cli/index.ts

@@ -1,25 +0,0 @@
-#!/usr/bin/env node
-
-import { createCli } from '@karmaniverous/get-dotenv/cli';
-import {
-  awsPlugin,
-  awsWhoamiPlugin,
-  batchPlugin,
-  cmdPlugin,
-  initPlugin,
-} from '@karmaniverous/get-dotenv/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/defaultAction.ts

@@ -1,27 +0,0 @@
-import {
-  type GetDotenvCliPublic,
-  getRootCommand,
-} from '@karmaniverous/get-dotenv/cliHost';
-
-import type { HelloPlugin } from '.';
-import type { HelloCommand } from './options';
-
-export function attachHelloDefaultAction(
-  cli: GetDotenvCliPublic,
-  cmd: HelloCommand,
-  plugin: HelloPlugin,
-) {
-  cmd.action((opts) => {
-    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 loud =
-      opts.loud === true ? true : opts.loudOff === true ? false : cfg.loud;
-
-    const keys = Object.keys(ctx.dotenv);
-    const label = `Hello, stranger!\n\n[${rootName}] dotenv keys (${String(keys.length)}):`;
-    console.log(loud ? label.toUpperCase() : label, keys.join(', '));
-  });
-}

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

@@ -1,26 +0,0 @@
-import { definePlugin } from '@karmaniverous/get-dotenv/cliHost';
-
-import { attachHelloDefaultAction } from './defaultAction';
-import { attachHelloOptions } from './options';
-import { attachHelloStrangerAction } from './strangerAction';
-import { helloPluginConfigSchema } from './types';
-
-export const helloPlugin = () => {
-  const plugin = definePlugin({
-    ns: 'hello',
-    configSchema: helloPluginConfigSchema,
-    setup(cli) {
-      // Keep description in the plugin “index” (this file), not in an options helper.
-      cli.description('Say hello with current dotenv context');
-
-      const helloCmd = attachHelloOptions(cli, plugin);
-      attachHelloDefaultAction(cli, helloCmd, plugin);
-      attachHelloStrangerAction(cli);
-
-      return undefined;
-    },
-  });
-  return plugin;
-};
-
-export type HelloPlugin = ReturnType<typeof helloPlugin>;

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

@@ -1,31 +0,0 @@
-import type { GetDotenvCliPublic } from '@karmaniverous/get-dotenv/cliHost';
-
-import type { HelloPlugin } from '.';
-import type { HelloPluginConfig } from './types';
-
-export function attachHelloOptions(
-  cli: GetDotenvCliPublic,
-  plugin: HelloPlugin,
-) {
-  const loudOn = plugin
-    .createPluginDynamicOption(
-      cli,
-      '-l, --loud',
-      (_bag, pluginCfg: Readonly<HelloPluginConfig>) =>
-        `print greeting in ALL CAPS${pluginCfg.loud ? ' (default)' : ''}`,
-    )
-    .conflicts('loudOff');
-
-  const loudOff = plugin
-    .createPluginDynamicOption(
-      cli,
-      '-L, --loud-off',
-      (_bag, pluginCfg: Readonly<HelloPluginConfig>) =>
-        `print greeting in normal case${pluginCfg.loud ? '' : ' (default)'}`,
-    )
-    .conflicts('loud');
-
-  return cli.addOption(loudOn).addOption(loudOff);
-}
-
-export type HelloCommand = ReturnType<typeof attachHelloOptions>;

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

@@ -1,20 +0,0 @@
-import type { GetDotenvCliPublic } from '@karmaniverous/get-dotenv/cliHost';
-
-/**
- * Attach the `stranger` subcommand under `hello`.
- *
- * Reads `SECRET_IDENTITY` from the resolved get-dotenv context (`cli.getCtx().dotenv`).
- *
- * @param cli - The `hello` command mount.
- * @returns Nothing.
- */
-export function attachHelloStrangerAction(cli: GetDotenvCliPublic): void {
-  const really = cli
-    .ns('stranger')
-    .description('Print SECRET_IDENTITY from the resolved dotenv context');
-
-  really.action(() => {
-    const secretIdentity = really.getCtx().dotenv.SECRET_IDENTITY;
-    console.log(`My secret identity is ${secretIdentity ?? 'still a secret'}.`);
-  });
-}

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

@@ -1,13 +0,0 @@
-import { z } from 'zod';
-
-/**
- * Zod schema for hello plugin configuration.
- */
-export const helloPluginConfigSchema = z.object({
-  loud: z.boolean().optional().default(false),
-});
-
-/**
- * Hello plugin configuration object.
- */
-export type HelloPluginConfig = z.infer<typeof helloPluginConfigSchema>;

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

@@ -1,20 +0,0 @@
-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

@@ -1,7 +0,0 @@
-{
-  "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

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

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

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

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

@@ -1,28 +0,0 @@
-import { defineGetDotenvConfig } from '@karmaniverous/get-dotenv';
-
-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

@@ -1,7 +0,0 @@
-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

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

package/dist/templates/defaultAction.ts

@@ -1,27 +0,0 @@
-import {
-  type GetDotenvCliPublic,
-  getRootCommand,
-} from '@karmaniverous/get-dotenv/cliHost';
-
-import type { HelloPlugin } from '.';
-import type { HelloCommand } from './options';
-
-export function attachHelloDefaultAction(
-  cli: GetDotenvCliPublic,
-  cmd: HelloCommand,
-  plugin: HelloPlugin,
-) {
-  cmd.action((opts) => {
-    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 loud =
-      opts.loud === true ? true : opts.loudOff === true ? false : cfg.loud;
-
-    const keys = Object.keys(ctx.dotenv);
-    const label = `Hello, stranger!\n\n[${rootName}] dotenv keys (${String(keys.length)}):`;
-    console.log(loud ? label.toUpperCase() : label, keys.join(', '));
-  });
-}

package/dist/templates/getdotenv.config.js

@@ -1,20 +0,0 @@
-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

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

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

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

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

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

package/dist/templates/getdotenv.config.ts

@@ -1,28 +0,0 @@
-import { defineGetDotenvConfig } from '@karmaniverous/get-dotenv';
-
-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

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

package/dist/templates/hello/defaultAction.ts

@@ -1,27 +0,0 @@
-import {
-  type GetDotenvCliPublic,
-  getRootCommand,
-} from '@karmaniverous/get-dotenv/cliHost';
-
-import type { HelloPlugin } from '.';
-import type { HelloCommand } from './options';
-
-export function attachHelloDefaultAction(
-  cli: GetDotenvCliPublic,
-  cmd: HelloCommand,
-  plugin: HelloPlugin,
-) {
-  cmd.action((opts) => {
-    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 loud =
-      opts.loud === true ? true : opts.loudOff === true ? false : cfg.loud;
-
-    const keys = Object.keys(ctx.dotenv);
-    const label = `Hello, stranger!\n\n[${rootName}] dotenv keys (${String(keys.length)}):`;
-    console.log(loud ? label.toUpperCase() : label, keys.join(', '));
-  });
-}

package/dist/templates/hello/index.ts

@@ -1,26 +0,0 @@
-import { definePlugin } from '@karmaniverous/get-dotenv/cliHost';
-
-import { attachHelloDefaultAction } from './defaultAction';
-import { attachHelloOptions } from './options';
-import { attachHelloStrangerAction } from './strangerAction';
-import { helloPluginConfigSchema } from './types';
-
-export const helloPlugin = () => {
-  const plugin = definePlugin({
-    ns: 'hello',
-    configSchema: helloPluginConfigSchema,
-    setup(cli) {
-      // Keep description in the plugin “index” (this file), not in an options helper.
-      cli.description('Say hello with current dotenv context');
-
-      const helloCmd = attachHelloOptions(cli, plugin);
-      attachHelloDefaultAction(cli, helloCmd, plugin);
-      attachHelloStrangerAction(cli);
-
-      return undefined;
-    },
-  });
-  return plugin;
-};
-
-export type HelloPlugin = ReturnType<typeof helloPlugin>;

package/dist/templates/hello/options.ts

@@ -1,31 +0,0 @@
-import type { GetDotenvCliPublic } from '@karmaniverous/get-dotenv/cliHost';
-
-import type { HelloPlugin } from '.';
-import type { HelloPluginConfig } from './types';
-
-export function attachHelloOptions(
-  cli: GetDotenvCliPublic,
-  plugin: HelloPlugin,
-) {
-  const loudOn = plugin
-    .createPluginDynamicOption(
-      cli,
-      '-l, --loud',
-      (_bag, pluginCfg: Readonly<HelloPluginConfig>) =>
-        `print greeting in ALL CAPS${pluginCfg.loud ? ' (default)' : ''}`,
-    )
-    .conflicts('loudOff');
-
-  const loudOff = plugin
-    .createPluginDynamicOption(
-      cli,
-      '-L, --loud-off',
-      (_bag, pluginCfg: Readonly<HelloPluginConfig>) =>
-        `print greeting in normal case${pluginCfg.loud ? '' : ' (default)'}`,
-    )
-    .conflicts('loud');
-
-  return cli.addOption(loudOn).addOption(loudOff);
-}
-
-export type HelloCommand = ReturnType<typeof attachHelloOptions>;

package/dist/templates/hello/strangerAction.ts

@@ -1,20 +0,0 @@
-import type { GetDotenvCliPublic } from '@karmaniverous/get-dotenv/cliHost';
-
-/**
- * Attach the `stranger` subcommand under `hello`.
- *
- * Reads `SECRET_IDENTITY` from the resolved get-dotenv context (`cli.getCtx().dotenv`).
- *
- * @param cli - The `hello` command mount.
- * @returns Nothing.
- */
-export function attachHelloStrangerAction(cli: GetDotenvCliPublic): void {
-  const really = cli
-    .ns('stranger')
-    .description('Print SECRET_IDENTITY from the resolved dotenv context');
-
-  really.action(() => {
-    const secretIdentity = really.getCtx().dotenv.SECRET_IDENTITY;
-    console.log(`My secret identity is ${secretIdentity ?? 'still a secret'}.`);
-  });
-}

package/dist/templates/hello/types.ts

@@ -1,13 +0,0 @@
-import { z } from 'zod';
-
-/**
- * Zod schema for hello plugin configuration.
- */
-export const helloPluginConfigSchema = z.object({
-  loud: z.boolean().optional().default(false),
-});
-
-/**
- * Hello plugin configuration object.
- */
-export type HelloPluginConfig = z.infer<typeof helloPluginConfigSchema>;

package/dist/templates/index.ts

@@ -1,26 +0,0 @@
-import { definePlugin } from '@karmaniverous/get-dotenv/cliHost';
-
-import { attachHelloDefaultAction } from './defaultAction';
-import { attachHelloOptions } from './options';
-import { attachHelloStrangerAction } from './strangerAction';
-import { helloPluginConfigSchema } from './types';
-
-export const helloPlugin = () => {
-  const plugin = definePlugin({
-    ns: 'hello',
-    configSchema: helloPluginConfigSchema,
-    setup(cli) {
-      // Keep description in the plugin “index” (this file), not in an options helper.
-      cli.description('Say hello with current dotenv context');
-
-      const helloCmd = attachHelloOptions(cli, plugin);
-      attachHelloDefaultAction(cli, helloCmd, plugin);
-      attachHelloStrangerAction(cli);
-
-      return undefined;
-    },
-  });
-  return plugin;
-};
-
-export type HelloPlugin = ReturnType<typeof helloPlugin>;

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

@@ -1,20 +0,0 @@
-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

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

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

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

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

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

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

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

package/dist/templates/options.ts

@@ -1,31 +0,0 @@
-import type { GetDotenvCliPublic } from '@karmaniverous/get-dotenv/cliHost';
-
-import type { HelloPlugin } from '.';
-import type { HelloPluginConfig } from './types';
-
-export function attachHelloOptions(
-  cli: GetDotenvCliPublic,
-  plugin: HelloPlugin,
-) {
-  const loudOn = plugin
-    .createPluginDynamicOption(
-      cli,
-      '-l, --loud',
-      (_bag, pluginCfg: Readonly<HelloPluginConfig>) =>
-        `print greeting in ALL CAPS${pluginCfg.loud ? ' (default)' : ''}`,
-    )
-    .conflicts('loudOff');
-
-  const loudOff = plugin
-    .createPluginDynamicOption(
-      cli,
-      '-L, --loud-off',
-      (_bag, pluginCfg: Readonly<HelloPluginConfig>) =>
-        `print greeting in normal case${pluginCfg.loud ? '' : ' (default)'}`,
-    )
-    .conflicts('loud');
-
-  return cli.addOption(loudOn).addOption(loudOff);
-}
-
-export type HelloCommand = ReturnType<typeof attachHelloOptions>;

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

@@ -1,27 +0,0 @@
-import {
-  type GetDotenvCliPublic,
-  getRootCommand,
-} from '@karmaniverous/get-dotenv/cliHost';
-
-import type { HelloPlugin } from '.';
-import type { HelloCommand } from './options';
-
-export function attachHelloDefaultAction(
-  cli: GetDotenvCliPublic,
-  cmd: HelloCommand,
-  plugin: HelloPlugin,
-) {
-  cmd.action((opts) => {
-    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 loud =
-      opts.loud === true ? true : opts.loudOff === true ? false : cfg.loud;
-
-    const keys = Object.keys(ctx.dotenv);
-    const label = `Hello, stranger!\n\n[${rootName}] dotenv keys (${String(keys.length)}):`;
-    console.log(loud ? label.toUpperCase() : label, keys.join(', '));
-  });
-}