@rpcbase/cli 0.36.0 → 0.37.0

package/bin.js

@@ -11,6 +11,8 @@ const {hideBin} = require("yargs/helpers")
 const start_command = require("./src/start_command")
 const print_versions = require("./src/print_versions")
 const update = require("./src/update")
+const sync_dotenv = require("./src/sync-dotenv")
+
 
 yargs(hideBin(process.argv))
   .command(["start", "*"], "Starts client, server, and infrastructure", (yargs) => {
@@ -32,6 +34,7 @@ yargs(hideBin(process.argv))
         description: "Run with debug logging"
       })
   }, (argv) => {
+    console.log("IS start")
     if (argv.version) return print_versions()
     start_command(argv)
   })
@@ -47,6 +50,18 @@ yargs(hideBin(process.argv))
     if (argv.version) return print_versions()
     await update()
   })
+  // sync-dotenv
+  .command(["sync-dotenv"], "Compare and sync dotenv files", (yargs) => {
+    yargs
+      .option("write", {
+        type: "boolean",
+        default: false,
+        description: "Write the ouput to dest env file"
+      })
+  }, async(argv) => {
+    if (argv.version) return print_versions()
+    await sync_dotenv()
+  })
   // Ping
   .command("ping", "Ping", () => {}, (argv) => {
     if (argv.version) return print_versions()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rpcbase/cli",
-  "version": "0.36.0",
+  "version": "0.37.0",
   "license": "SSPL-1.0",
   "bin": {
     "rb": "./bin.js"
@@ -13,9 +13,13 @@
     "concurrently": "8.2.1",
     "debug": "4.3.4",
     "dotenv": "16.3.1",
+    "parse-dotenv": "2.1.0",
     "picocolors": "1.0.0",
     "semver": "7.5.4",
     "validator": "13.11.0",
     "yargs": "17.7.2"
+  },
+  "devDependencies": {
+    "jest": "29.7.0"
   }
 }

package/src/helpers/get_run_configs.js

@@ -7,11 +7,11 @@ const exit_with_message = require("./exit_with_message")
 
 const {CONTAINER_MODE} = process.env
 
-if (!["docker", "native"].includes(CONTAINER_MODE.trim()))
-  throw new Error("expected CONTAINER_MODE to be native|docker")
-
 // run type is client | server | both
 const get_run_configs = () => {
+  if (!["docker", "native"].includes(CONTAINER_MODE.trim()))
+    throw new Error("expected CONTAINER_MODE to be native|docker")
+
   const cwd = process.cwd()
 
   // check if running parent of rb project

package/src/helpers/tailscale_tunnel.js

@@ -14,7 +14,6 @@ const has_tailscale = process.platform === "darwin" && fs.existsSync(TAILSCALE_P
 const get_port = (run_configs) => {
   const project_root_dir = get_root_dir(run_configs)
 
-  // TODO: should join w/ .env.base
   const server_env_path = path.join(project_root_dir, "./server/server/.env")
 
   const server_env_buf = fs.readFileSync(server_env_path)

package/src/sync-dotenv/.env.sample

@@ -0,0 +1,3 @@
+DOMAIN=localhost3
+GHEllo=
+# yo

package/src/sync-dotenv/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2019 Luqman Olushi O.
+Copyright (c) 2023 rpcbase
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/src/sync-dotenv/index.js

@@ -0,0 +1,138 @@
+const path = require("path")
+const fs = require("fs")
+const os = require('os')
+const parseEnv = require("parse-dotenv")
+const dotenv = require("dotenv")
+
+const DEFAULT_ENV_PATH = path.resolve(process.cwd(), ".env")
+const DEFAULT_SAMPLE_ENV = path.resolve(process.cwd(), ".env.sample")
+
+const envToString = (parsed) =>
+  Object.keys(parsed)
+    .map(key => `${key}=${parsed[key] || ""}`)
+    .join(os.EOL)
+    .replace(/(__\w+_\d+__=)/g, "")
+
+const writeToSampleEnv = (path, parsedEnv) => {
+  try {
+    fs.writeFileSync(path, envToString(parsedEnv))
+  } catch (e) {
+    throw new Error(`Sync failed. ${e.message}`)
+  }
+}
+
+const emptyObjProps = (obj) => {
+  const objCopy = { ...obj }
+  Object.keys(objCopy).forEach(key => {
+    if (objCopy[key].includes("#")) {
+      if (objCopy[key].match(/(".*"|'.*')/g)) {
+        const objArr = objCopy[key].split(/(".*"|'.*')/)
+        objCopy[key] = objArr.slice(-1)[0].trim()
+      } else {
+        const objArr = objCopy[key].split("#")
+        objCopy[key] = `#${objArr.slice(-1)[0]}`
+      }
+
+      return
+    }
+
+    if (!key.startsWith("__COMMENT_")) {
+      objCopy[key] = ""
+    }
+  })
+
+  return objCopy
+}
+
+const getUniqueVarsFromEnvs = (
+  env,
+  envExample,
+  config = {}
+) => {
+  const ignoreKeys = config.preserve || []
+
+  const uniqueKeys = new Set(Object.keys(env))
+  const uniqueKeysArray = Array.from(uniqueKeys)
+
+  const uniqueFromSource = uniqueKeysArray.map((key) => {
+    if (key.startsWith("__COMMENT_")) return { [key]: env[key] }
+    return { [key]: envExample[key] || "" }
+  })
+
+  const presevedVars = Object.keys(envExample)
+    .map(key => ({ [key]: envExample[key] }))
+    // .filter(env => {
+    //   console.log("ICICIC", env)
+    //   return ignoreKeys.length && ignoreKeys.includes(Object.keys(env)[0])
+    // })
+
+  return [...uniqueFromSource, ...presevedVars]
+}
+
+
+const syncWithSampleEnv = (
+  envPath,
+  envExamplePath
+) => {
+  const config = { emptyLines: true, comments: true }
+
+  const sourceEnv = emptyObjProps(
+    parseEnv(envPath, config)
+  )
+  const targetEnv = parseEnv(envExamplePath)
+
+  const uniqueVars = getUniqueVarsFromEnvs(sourceEnv, targetEnv, config)
+  const envCopy = {}
+  uniqueVars.forEach(env => {
+    const [key] = Object.keys(env)
+    envCopy[key] = env[key]
+  })
+
+  writeToSampleEnv(envExamplePath, envCopy)
+}
+
+
+const sync_dotenv = (
+  source,
+  sample_env,
+  samples
+) => {
+  if (sample_env && (sample_env === ".env" || path.basename(sample_env) === ".env")) {
+    throw new Error("Cannot sync .env with .env")
+  }
+
+  const sample_env_paths = !samples
+    ? [path.resolve(process.cwd(), sample_env || DEFAULT_SAMPLE_ENV)]
+    : globby
+      .sync(samples)
+      .map((sample) => path.resolve(process.cwd(), sample))
+
+  const envPath = source
+    ? fs.existsSync(source)
+      ? source
+      : null
+    : DEFAULT_ENV_PATH
+
+  if (envPath === null) throw new Error(`${source} not found`)
+
+  if (!source && !fs.existsSync(envPath)) throw new Error(".env doesn't exists")
+
+  if (!sample_env_paths.length)
+    throw new Error(`${samples} did not match any file`)
+
+  if (!fs.existsSync(sample_env_paths[0])) {
+    fs.writeFileSync(sample_env_paths[0], "")
+    // throw new Error(`${sample_env || path.basename(DEFAULT_SAMPLE_ENV)} not found`)
+  }
+
+  const sourcePath = envPath
+
+  for (const samplePath of sample_env_paths) {
+    syncWithSampleEnv(sourcePath, samplePath)
+  }
+
+  return sample_env_paths.join(" ")
+}
+
+
+module.exports = sync_dotenv

package/src/sync-dotenv/test.js

@@ -0,0 +1,8 @@
+/* @flow */
+
+const {syncEnv} = require("./index")
+
+
+const res = syncEnv(".env", ".env.sample")
+
+// console.log("FNDE", res)