@dotenvx/dotenvx 0.13.0 → 0.14.1

package/README.md

@@ -423,7 +423,7 @@ More examples
 
   </details>
 
-* <details><summary>Docker</summary><br>
+* <details><summary>Docker 🐳</summary><br>
 
   > Add the `dotenvx` binary to your Dockerfile
 
@@ -443,15 +443,27 @@ More examples
 
   </details>
 
-* <details><summary>Fly.io</summary><br>
+* <details><summary>Fly.io 🎈</summary><br>
+
+  > Add the `dotenvx` binary to your Dockerfile
 
   ```sh
-  coming soon
+  # Install dotenvx
+  RUN curl -fsS https://dotenvx.sh/ | sh
   ```
 
+  > Use it in your Dockerfile CMD
+
+  ```sh
+  # Prepend dotenvx run
+  CMD ["dotenvx", "run", "--", "node", "index.js"]
+  ```
+
+  see [fly guide](https://dotenvx.com/docs/platforms/fly)
+
   </details>
 
-* <details><summary>Heroku</summary><br>
+* <details><summary>Heroku 🟣</summary><br>
 
   > Add the buildpack, installing the `dotenvx` binary to your heroku deployment.
 
@@ -477,20 +489,47 @@ More examples
 
   </details>
 
-* <details><summary>Netlify</summary><br>
+* <details><summary>Netlify 🔷</summary><br>
+
+  > Add the `dotenvx` npm module
 
   ```sh
-  coming soon
+  npm install @dotenvx/dotenvx --save
   ```
 
+  > Use it in your `package.json scripts`
+
+  ```json
+  "scripts": {
+    "dotenvx": "dotenvx",
+    "dev": "dotenvx run -- next dev --turbo",
+    "build": "dotenvx run -- next build",
+    "start": "dotenvx run -- next start"
+  },
+  ```
+
+  see [netlify guide](https://dotenvx.com/docs/platforms/netlify)
+
   </details>
 
-* <details><summary>Railway</summary><br>
+* <details><summary>Railway 🚄</summary><br>
+
+  > Add the `dotenvx` binary to your Dockerfile
 
   ```sh
-  coming soon
+  # Install dotenvx
+  RUN curl -fsS https://dotenvx.sh/ | sh
   ```
 
+  > Use it in your Dockerfile CMD
+
+  ```sh
+  # Prepend dotenvx run
+  CMD ["dotenvx", "run", "--", "node", "index.js"]
+  ```
+
+  see [railway guide](https://dotenvx.com/docs/platforms/railway)
+
   </details>
 
 * <details><summary>Render</summary><br>
@@ -501,7 +540,7 @@ More examples
 
   </details>
 
-* <details><summary>Vercel</summary><br>
+* <details><summary>Vercel ▲</summary><br>
 
   > Add the `dotenvx` npm module
 
@@ -532,7 +571,7 @@ More examples
 
   </details>
 
-* <details><summary>GitHub Actions</summary><br>
+* <details><summary>GitHub Actions 🐙</summary><br>
 
   > Add the `dotenvx` binary to GitHub Actions
 
@@ -561,42 +600,38 @@ More examples
 
 ## Hub
 
-> Integrate tightly with [GitHub](https://github.com) 🐙
+> Integrate tightly with [GitHub](https://github.com) 🐙 and as a team
 ```sh
 $ dotenvx hub login
 $ dotenvx hub push
 ```
 
-more details coming soon.
+**beta**: more details coming soon.
 
 &nbsp;
 
-## Guides
+## More features
 
-* [dotenvx/docs](https://dotenvx.com/docs)
-* [quickstart guide](https://dotenvx.com/docs/quickstart)
+> Keep your `.env` files safe
 
-&nbsp;
-
-## Pre-commit
-
-You can prevent `.env` files from being committed to code with this pre-commit hook.
-
-```
-dotenvx precommit --install
-```
-
-Run without the `--install` flag to preview output.
+* [`dotenvx genexample`](https://dotenvx.com/docs/features/genexample) – generate `.env.example` file
+* [`dotenvx gitignore`](https://dotenvx.com/docs/features/gitignore) – gitignore your `.env` files
+* [`dotenvx prebuild`](https://dotenvx.com/docs/features/prebuild) – prevent `.env` files from being built into your docker container
+* [`dotenvx precommit`](https://dotenvx.com/docs/features/precommit) – prevent `.env` files from being committed to code
 
-```
-dotenvx precommit
-```
+&nbsp;
 
-To ignore the pre-commit hook run your git commit with the `--no-verify` flag.
+## Guides
 
-```
-git commit -am "msg" --no-verify
-```
+* [quickstart guides](https://dotenvx.com/docs/quickstart)
+  * [run anywhere](https://dotenvx.com/docs/quickstart/run)
+  * [multi-environment](https://dotenvx.com/docs/quickstart/environments)
+  * [encrypted envs](https://dotenvx.com/docs/quickstart/encryption)
+* [dotenvx/docs](https://dotenvx.com/docs)
+  * [languages](https://dotenvx.com/docs#languages)
+  * [frameworks](https://dotenvx.com/docs#frameworks)
+  * [platforms](https://dotenvx.com/docs#platforms)
+  * [ci/cd](https://dotenvx.com/docs#cis)
 
 &nbsp;
 

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.13.0",
+  "version": "0.14.1",
   "name": "@dotenvx/dotenvx",
   "description": "a better dotenv–from the creator of `dotenv`",
   "author": "@motdotla",

package/src/cli/actions/genexample.js

@@ -0,0 +1,92 @@
+const fs = require('fs')
+const helpers = require('./../helpers')
+const main = require('./../../lib/main')
+const logger = require('./../../shared/logger')
+const createSpinner = require('./../../shared/createSpinner')
+
+const spinner = createSpinner('generating')
+
+const ENCODING = 'utf8'
+
+async function genexample () {
+  spinner.start()
+  await helpers.sleep(500) // better dx
+
+  const options = this.opts()
+  logger.debug(`options: ${JSON.stringify(options)}`)
+
+  let optionEnvFile = options.envFile
+  if (!Array.isArray(optionEnvFile)) {
+    optionEnvFile = [optionEnvFile]
+  }
+
+  // must be at least one .env* file
+  if (optionEnvFile.length < 1) {
+    spinner.fail('no .env* files found')
+    logger.help('? add one with [echo "HELLO=World" > .env] and then run [dotenvx genexample]')
+    process.exit(1)
+  }
+
+  const keys = new Set()
+  const addedKeys = new Set()
+
+  for (const envFilepath of optionEnvFile) {
+    const filepath = helpers.resolvePath(envFilepath)
+
+    logger.verbose(`loading env from ${filepath}`)
+
+    try {
+      const src = fs.readFileSync(filepath, { encoding: ENCODING })
+      const parsed = main.parse(src)
+      Object.keys(parsed).forEach(key => { keys.add(key) })
+    } catch (e) {
+      // calculate development help message depending on state of repo
+      const vaultFilepath = helpers.resolvePath('.env.vault')
+      let developmentHelp = '? in development: add one with [echo "HELLO=World" > .env] and re-run [dotenvx genexample]'
+      if (fs.existsSync(vaultFilepath)) {
+        developmentHelp = '? in development: use [dotenvx decrypt] to decrypt .env.vault to .env and then re-run [dotenvx genexample]'
+      }
+
+      switch (e.code) {
+        // missing .env
+        case 'ENOENT':
+          logger.warn(`missing ${envFilepath} file (${filepath})`)
+          logger.help(developmentHelp)
+          break
+
+        // unhandled error
+        default:
+          logger.warn(e)
+          break
+      }
+    }
+  }
+
+  const exampleFilename = '.env.example'
+  const exampleFilepath = helpers.resolvePath(exampleFilename)
+  if (!fs.existsSync(exampleFilepath)) {
+    logger.verbose(`creating ${exampleFilename}`)
+    fs.writeFileSync(exampleFilename, `# ${exampleFilename}\n`)
+  }
+
+  const currentEnvExample = (main.configDotenv({ path: exampleFilepath }).parsed || {})
+  const keysArray = Array.from(keys)
+
+  keysArray.forEach(key => {
+    if (key in currentEnvExample) {
+      logger.verbose(`pre-existing ${key} in ${exampleFilename}`)
+    } else {
+      addedKeys.add(key)
+      logger.verbose(`appending ${key} to ${exampleFilename}`)
+      fs.appendFileSync('.env.example', `${key}=""\n`, ENCODING)
+    }
+  })
+
+  if (addedKeys.size > 0) {
+    spinner.succeed(`updated ${exampleFilename} (${addedKeys.size})`)
+  } else {
+    spinner.done(`no changes (${exampleFilename})`)
+  }
+}
+
+module.exports = genexample

package/src/cli/actions/gitignore.js

@@ -38,24 +38,28 @@ class Generic {
 
 class Git {
   run () {
+    logger.verbose('appending to .gitignore')
     new Generic('.gitignore', true).run()
   }
 }
 
 class Docker {
   run () {
+    logger.verbose('appending to .dockerignore (if existing)')
     new Generic('.dockerignore').run()
   }
 }
 
 class Npm {
   run () {
+    logger.verbose('appending to .npmignore (if existing)')
     new Generic('.npmignore').run()
   }
 }
 
 class Vercel {
   run () {
+    logger.verbose('appending to .vercelignore (if existing)')
     new Generic('.vercelignore').run()
   }
 }
@@ -64,16 +68,9 @@ function gitignore () {
   const options = this.opts()
   logger.debug(`options: ${JSON.stringify(options)}`)
 
-  logger.verbose('appending to .gitignore')
   new Git().run()
-
-  logger.verbose('appending to .dockerignore (if existing)')
   new Docker().run()
-
-  logger.verbose('appending to .npmignore (if existing)')
   new Npm().run()
-
-  logger.verbose('appending to .vercelignore (if existing)')
   new Vercel().run()
 
   logger.success('done')

package/src/cli/dotenvx.js

@@ -69,9 +69,14 @@ program.command('encrypt')
 // dotenvx decrypt
 program.command('decrypt')
   .description('decrypt .env.vault to .env*')
-  .addHelpText('after', examples.encrypt)
   .action(require('./actions/decrypt'))
 
+// dotenvx gitignore
+program.command('gitignore')
+  .description('append to .gitignore file (and if existing, .dockerignore, .npmignore, and .vercelignore)')
+  .addHelpText('after', examples.gitignore)
+  .action(require('./actions/gitignore'))
+
 // dotenvx precommit
 program.command('precommit')
   .description('prevent committing .env files to code')
@@ -85,11 +90,11 @@ program.command('prebuild')
   .addHelpText('after', examples.prebuild)
   .action(require('./actions/prebuild'))
 
-// dotenvx gitignore
-program.command('gitignore')
-  .description('append to .gitignore file (and if existing, .dockerignore, .npmignore, and .vercelignore)')
-  .addHelpText('after', examples.gitignore)
-  .action(require('./actions/gitignore'))
+// dotenvx genexample
+program.command('genexample')
+  .description('generate .env.example')
+  .option('-f, --env-file <paths...>', 'path(s) to your env file(s)', '.env')
+  .action(require('./actions/genexample'))
 
 // dotenvx hub
 program.addCommand(require('./commands/hub'))