envstash-cli 0.7.0 → 0.8.0

package/README.md

@@ -406,6 +406,10 @@ second-guessed.
   regenerated rather than reproduced byte for byte: keys come back sorted, and
   comments and blank lines are not preserved. The values themselves round-trip
   exactly, including multi-line values such as PEM keys.
+- `envs push` also sends the file's text, encrypted like the values, so the
+  dashboard's raw view shows the file as you wrote it — comments, blank lines
+  and key order — with the current values in place. An edit that touches only
+  comments is pushed too.
 
 ## License
 

package/package.json

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

package/src/api.mjs

@@ -325,11 +325,13 @@ export const api = {
       headers: { 'x-envstash-file-kinds': 'env,file' },
     }),
 
-  putFile: (host, token, project, file, entries, prune) =>
+  // `layout` is the file's own text, kept server-side so the dashboard can
+  // show the file with its comments and key order. Older servers ignore it.
+  putFile: (host, token, project, file, entries, prune, layout) =>
     request(host, `/api/cli/projects/${encodeURIComponent(project)}/files/${encodePath(file)}`, {
       method: 'PUT',
       token,
-      body: { entries, prune },
+      body: layout === undefined ? { entries, prune } : { entries, prune, layout },
     }),
 
   putBlob: (host, token, project, file, contentBase64) =>

package/src/commands/push.mjs

@@ -1,7 +1,7 @@
-import { statSync } from 'node:fs'
+import { readFileSync, statSync } from 'node:fs'
 
 import { api, ApiError } from '../api.mjs'
-import { formatSize, MAX_BLOB_BYTES } from '../blob.mjs'
+import { digestFileBytes, formatSize, MAX_BLOB_BYTES } from '../blob.mjs'
 import {
   cloudKinds,
   loadLocalFiles,
@@ -87,10 +87,20 @@ export async function push(flags, args) {
 
   out()
 
+  const cloudByName = new Map(cloudFiles.map(file => [file.name, file]))
   let pushed = 0
 
   for (const file of comparison) {
-    if (file.state === FILE_STATE.IN_SYNC && !flags.force) {
+    // A dotenv file's text travels with its keys, so the dashboard can show it
+    // as written — comments, order and all. Read here rather than threaded
+    // through `loadLocalFiles`, whose entries every other command consumes.
+    const layout =
+      file.kind === 'file'
+        ? undefined
+        : readFileSync(resolveRepoFile(context.repoRoot, file.name), 'utf8')
+    const layoutStale = isLayoutStale(cloudByName.get(file.name), layout)
+
+    if (file.state === FILE_STATE.IN_SYNC && !layoutStale && !flags.force) {
       out(`  ${style.dim('=')} ${file.name} ${style.dim('already up to date')}`)
       continue
     }
@@ -119,7 +129,8 @@ export async function push(flags, args) {
       scope,
       file.name,
       entries,
-      Boolean(flags.prune)
+      Boolean(flags.prune),
+      layout
     )
 
     pushed += 1
@@ -145,7 +156,7 @@ export async function push(flags, args) {
     }
 
     if (parts.length === 0) {
-      parts.push(style.dim('no changes'))
+      parts.push(style.dim(layoutStale ? 'comments and layout updated' : 'no changes'))
     }
 
     out(`  ${style.green('✓')} ${file.name}  ${parts.join(style.dim(', '))}`)
@@ -293,6 +304,22 @@ export async function pushOneBlob(flags, context, scope, file, local) {
   return 1
 }
 
+/**
+ * True when the server keeps layouts and its copy of this file's text is not
+ * the local one — a comment or a reordering, which moves no value and so
+ * leaves the file "in sync" by the key comparison alone.
+ *
+ * A server without `layoutDigest` in its listing (before migration 0010)
+ * keeps no layouts, and re-pushing for one would never settle.
+ */
+export function isLayoutStale(cloudFile, layout) {
+  if (layout === undefined || !cloudFile || !('layoutDigest' in cloudFile)) {
+    return false
+  }
+
+  return cloudFile.layoutDigest !== digestFileBytes(Buffer.from(layout, 'utf8'))
+}
+
 export async function fetchCloudFiles(context, scope) {
   try {
     const response = await api.projectStatus(context.host, context.token, scope)

package/src/commands/sync.mjs

@@ -1,4 +1,4 @@
-import { readFileSync } from 'node:fs'
+import { existsSync, readFileSync } from 'node:fs'
 
 import { api } from '../api.mjs'
 import { formatSize } from '../blob.mjs'
@@ -187,6 +187,13 @@ async function pullWholeFile(flags, context, scope, plan) {
   return { changed: true, pulled: count, pushed: 0, detail }
 }
 
+/** A dotenv file's text on disk, sent with its keys as the server's layout —
+ *  or nothing, for a file that is not there to read. */
+function localText(context, name) {
+  const path = resolveRepoFile(context.repoRoot, name)
+  return existsSync(path) ? readFileSync(path, 'utf8') : undefined
+}
+
 /** A file on disk the cloud has never seen — or one `--prefer local` settles. */
 async function pushWholeFile(flags, context, scope, plan, file, local) {
   if (plan.kind === 'file') {
@@ -202,7 +209,15 @@ async function pushWholeFile(flags, context, scope, plan, file, local) {
   if (!flags['dry-run']) {
     // Never prune. Sync's whole contract is that it does not delete, and this
     // path also runs for `--prefer local` on a file that already exists.
-    await api.putFile(context.host, context.token, scope, plan.name, entries, false)
+    await api.putFile(
+      context.host,
+      context.token,
+      scope,
+      plan.name,
+      entries,
+      false,
+      localText(context, plan.name)
+    )
   }
 
   return {
@@ -257,7 +272,17 @@ async function mergeOneFile(flags, context, scope, plan, local) {
       .map(key => ({ key, value: localValues.get(key) }))
 
     if (entries.length > 0 && !flags['dry-run']) {
-      await api.putFile(context.host, context.token, scope, plan.name, entries, false)
+      // The text as it stands after the download half rewrote it, so the
+      // server's layout is the merged file, not the pre-merge one.
+      await api.putFile(
+        context.host,
+        context.token,
+        scope,
+        plan.name,
+        entries,
+        false,
+        localText(context, plan.name)
+      )
     }
 
     pushed = entries.length