@karmaniverous/get-dotenv 6.1.0 → 6.1.1

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

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

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

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

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

@@ -0,0 +1,13 @@
+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/defaultAction.ts

@@ -0,0 +1,27 @@
+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/defaultAction.ts

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

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

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

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

@@ -0,0 +1,13 @@
+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,25 +1,26 @@
-#!/usr/bin/env node
+import { definePlugin } from '@karmaniverous/get-dotenv/cliHost';
 
-import { createCli } from '@karmaniverous/get-dotenv/cli';
-import {
-  awsPlugin,
-  awsWhoamiPlugin,
-  batchPlugin,
-  cmdPlugin,
-  initPlugin,
-} from '@karmaniverous/get-dotenv/plugins';
+import { attachHelloDefaultAction } from './defaultAction';
+import { attachHelloOptions } from './options';
+import { attachHelloStrangerAction } from './strangerAction';
+import { helloPluginConfigSchema } from './types';
 
-import { helloPlugin } from './plugins/hello';
+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');
 
-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()),
-})();
+      const helloCmd = attachHelloOptions(cli, plugin);
+      attachHelloDefaultAction(cli, helloCmd, plugin);
+      attachHelloStrangerAction(cli);
+
+      return undefined;
+    },
+  });
+  return plugin;
+};
+
+export type HelloPlugin = ReturnType<typeof helloPlugin>;

package/dist/templates/options.ts

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

@@ -0,0 +1,27 @@
+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/plugins/hello/index.ts

@@ -0,0 +1,26 @@
+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/plugins/hello/options.ts

@@ -0,0 +1,31 @@
+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/strangerAction.ts

@@ -0,0 +1,20 @@
+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/plugins/hello/types.ts

@@ -0,0 +1,13 @@
+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/strangerAction.ts

@@ -0,0 +1,20 @@
+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/types.ts

@@ -0,0 +1,13 @@
+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/package.json

@@ -213,7 +213,7 @@
     "release": "dotenvx run -f .env.local -- release-it",
     "release:pre": "dotenvx run -f .env.local -- release-it --no-git.requireBranch --github.prerelease --preRelease",
     "test": "vitest run",
-    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "typecheck": "tsc",
     "verify:types": "node tools/verify-types.js",
     "verify:package": "node tools/verify-package.js",
     "verify:smoke": "node tools/smoke.js",
@@ -222,5 +222,5 @@
   },
   "type": "module",
   "types": "dist/index.d.ts",
-  "version": "6.1.0"
+  "version": "6.1.1"
 }

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

@@ -0,0 +1,27 @@
+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/templates/cli/plugins/hello/index.ts

@@ -0,0 +1,26 @@
+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/templates/cli/plugins/hello/options.ts

@@ -0,0 +1,31 @@
+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/templates/cli/plugins/hello/strangerAction.ts

@@ -0,0 +1,20 @@
+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/templates/cli/plugins/hello/types.ts

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