envstash-cli 0.3.0 → 0.4.1

package/README.md

@@ -26,18 +26,19 @@ envs pull
 
 ## Commands
 
-| Command  | What it does                                      |
-| -------- | ------------------------------------------------- |
-| `login`  | Authorize this machine with a browser device code |
-| `logout` | Revoke this machine's token                       |
-| `whoami` | Show the signed-in account                        |
-| `init`   | Create a project and link this repo to it         |
-| `link`   | Link this repo to a project that already exists   |
-| `list`   | List every project in your account                |
-| `status` | Compare cloud files against local files           |
-| `diff`   | Show which keys differ, and how                   |
-| `pull`   | Write the cloud's version of each file to disk    |
-| `push`   | Send local files to the cloud                     |
+| Command   | What it does                                      |
+| --------- | ------------------------------------------------- |
+| `login`   | Authorize this machine with a browser device code |
+| `logout`  | Revoke this machine's token                       |
+| `whoami`  | Show the signed-in account                        |
+| `init`    | Create a project and link this repo to it         |
+| `link`    | Link this repo to a project that already exists   |
+| `list`    | List every project in your account                |
+| `status`  | Compare cloud files against local files           |
+| `diff`    | Show which keys differ, and how                   |
+| `pull`    | Write the cloud's version of each file to disk    |
+| `push`    | Send local files to the cloud                     |
+| `version` | Show the CLI version and its environment          |
 
 Run `envs help <command>` for details on any one of them.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "envstash-cli",
-  "version": "0.3.0",
+  "version": "0.4.1",
   "description": "Git-style CLI for EnvStash — keep your .env files in sync with your cloud account.",
   "keywords": [
     "env",

package/src/commands/misc.mjs

@@ -1,5 +1,9 @@
+import { readFileSync } from 'node:fs'
+import { dirname, join } from 'node:path'
+import { fileURLToPath } from 'node:url'
+
 import { api } from '../api.mjs'
-import { getStoredEmail } from '../config.mjs'
+import { configDir, getStoredEmail } from '../config.mjs'
 import {
   discoverTrackedFiles,
   findRepoRoot,
@@ -7,9 +11,70 @@ import {
   resolveProject,
   writeLink,
 } from '../project.mjs'
-import { requireHostToken, resolveHostFor } from '../session.mjs'
+import { requireHostToken, resolveHostFor, resolveHostSource } from '../session.mjs'
 import { out, pad, pluralize, style } from '../ui.mjs'
 
+/**
+ * `envs version` — the version, and the environment it would act in.
+ *
+ * `--version` and `-v` stay a bare semver for scripts to parse; this command is
+ * the human-facing one. The host line goes through the same resolution the sync
+ * commands use, so "which server would this talk to" is answered by the same
+ * code that would talk to it.
+ */
+export async function version(flags) {
+  const packageRoot = join(dirname(fileURLToPath(import.meta.url)), '..', '..')
+
+  let manifest = {}
+  try {
+    manifest = JSON.parse(readFileSync(join(packageRoot, 'package.json'), 'utf8'))
+  } catch {
+    // A broken install still deserves an answer; every field below has a fallback.
+  }
+
+  const { host, source } = resolveHostSource(flags)
+  const details = {
+    name: manifest.name ?? 'envstash-cli',
+    version: manifest.version ?? '0.0.0',
+    node: process.version,
+    platform: `${process.platform} ${process.arch}`,
+    installed: packageRoot,
+    host,
+    hostSource: source,
+    configDir: configDir(),
+  }
+
+  if (flags.json) {
+    out(JSON.stringify(details, null, 2))
+    return 0
+  }
+
+  const width = 12
+
+  out()
+  out(`  ${style.bold(details.name)} ${style.dim(`v${details.version}`)}`)
+  out()
+  out(`  ${pad('node', width)}${style.dim(details.node)}`)
+  out(`  ${pad('platform', width)}${style.dim(details.platform)}`)
+  out(`  ${pad('installed', width)}${style.dim(details.installed)}`)
+  out(`  ${pad('host', width)}${style.dim(`${details.host} (${sourceLabel(source)})`)}`)
+  out(`  ${pad('config', width)}${style.dim(details.configDir)}`)
+  out()
+
+  return 0
+}
+
+function sourceLabel(source) {
+  return (
+    {
+      flag: 'from --host or --port',
+      env: 'from the environment',
+      link: 'from .envstash.json',
+      default: 'default',
+    }[source] ?? source
+  )
+}
+
 /** `envs whoami` — which account this machine is signed in as. */
 export async function whoami(flags) {
   const { host, token } = requireHostToken(flags)

package/src/index.mjs

@@ -4,7 +4,7 @@ import { fileURLToPath } from 'node:url'
 
 import { diff } from './commands/diff.mjs'
 import { login, logout } from './commands/login.mjs'
-import { init, link, list, whoami } from './commands/misc.mjs'
+import { init, link, list, version as versionCommand, whoami } from './commands/misc.mjs'
 import { pull } from './commands/pull.mjs'
 import { push } from './commands/push.mjs'
 import { status } from './commands/status.mjs'
@@ -22,7 +22,19 @@ const VALUE_FLAGS = new Set(['host', 'port', 'project', 'label', 'cwd'])
 const SHORT_VALUE_ALIASES = { C: 'cwd' }
 
 /** The implementation of each command, by name. */
-const HANDLERS = { login, logout, whoami, init, link, list, status, diff, pull, push }
+const HANDLERS = {
+  login,
+  logout,
+  whoami,
+  init,
+  link,
+  list,
+  status,
+  diff,
+  pull,
+  push,
+  version: versionCommand,
+}
 
 /**
  * Summaries and aliases come from the manifest rather than being repeated here,
@@ -127,7 +139,9 @@ export async function run(argv) {
   const { flags, args } = parseArgs(argv)
   const [name, ...rest] = args
 
-  if (flags.version || flags.v || name === 'version') {
+  // Bare semver only, for scripts to parse. `envs version` — the command — is
+  // the detailed, human-facing answer.
+  if (flags.version || flags.v) {
     out(version())
     return finish(0)
   }
@@ -242,7 +256,9 @@ function printHelp(topic) {
   out(`    --project <name>   ${style.dim('Target a project other than the linked one')}`)
   out(`    --host <url>       ${style.dim('Target another EnvStash server')}`)
   out(`    --port <n>         ${style.dim('Target a dev server on localhost at this port')}`)
-  out(`    --json             ${style.dim('Machine-readable output (status, list, whoami)')}`)
+  out(
+    `    --json             ${style.dim('Machine-readable output (status, list, whoami, version)')}`
+  )
   out(`    --exit-zero        ${style.dim('Always exit 0, even when out of sync (status, diff)')}`)
   out(`    --dry-run          ${style.dim('Show what would happen (pull, push)')}`)
   out(`    --dev              ${style.dim('Log in to a local dev server if one is running')}`)
@@ -338,6 +354,13 @@ const COMMAND_HELP = {
   link: ['Link this repo to a project that already exists.', '', '  envs link my-app'],
   list: ['List every project in your account.', '', '  envs list', '  envs list --json'],
   whoami: ['Show which account this machine is signed in as.', '', '  envs whoami'],
+  version: [
+    'Show the version, runtime, install path, and which server commands would',
+    'talk to. --version and -v print the bare version for scripts.',
+    '',
+    '  envs version',
+    '  envs version --json',
+  ],
 }
 
 function printCommandHelp(name) {

package/src/manifest.mjs

@@ -27,6 +27,7 @@ export const CLI_COMMANDS = [
   { name: 'diff', summary: 'Show which keys differ, and how' },
   { name: 'pull', summary: 'Write the cloud’s version of each file to disk' },
   { name: 'push', summary: 'Send local files to the cloud' },
+  { name: 'version', summary: 'Show the CLI version and its environment' },
 ]
 
 /**

package/src/ui.mjs

@@ -32,6 +32,22 @@ export const style = {
   cyan: wrap(36, 39),
 }
 
+/**
+ * `envs status | head` closes stdout after a few lines, and every write after
+ * that raises EPIPE — which Node treats as a crash, stack trace and all. A
+ * closed pipe is the reader saying "I have enough", not a failure, so leave
+ * the way a SIGPIPE-terminated process would: immediately and silently.
+ */
+for (const stream of [process.stdout, process.stderr]) {
+  stream.on('error', error => {
+    if (error?.code === 'EPIPE') {
+      process.exit(0)
+    }
+
+    throw error
+  })
+}
+
 export function out(message = '') {
   process.stdout.write(`${message}\n`)
 }