@dotenvx/dotenvx 0.10.2 → 0.10.4

package/README.md

@@ -32,6 +32,8 @@ Hello World
 > :-D
 ```
 
+see [extended quickstart guide](https://dotenvx.com/docs/quickstart)
+
 More examples
 
 * <details><summary>Python 🐍</summary><br>
@@ -44,6 +46,8 @@ More examples
   Hello World
   ```
 
+  see [extended python guide](https://dotenvx.com/docs/quickstart)
+
   </details>
 * <details><summary>PHP 🐘</summary><br>
 
@@ -55,6 +59,8 @@ More examples
   Hello World
   ```
 
+  see [extended php guide](https://dotenvx.com/docs/quickstart)
+
   </details>
 * <details><summary>Ruby 💎</summary><br>
 
@@ -66,6 +72,8 @@ More examples
   Hello World
   ```
 
+  see [extended ruby guide](https://dotenvx.com/docs/quickstart)
+
   </details>
 * <details><summary>Go 🐹</summary><br>
 
@@ -77,6 +85,8 @@ More examples
   Hello World
   ```
 
+  see [extended go guide](https://dotenvx.com/docs/quickstart)
+
   </details>
 * <details><summary>Rust 🦀</summary><br>
 
@@ -88,6 +98,8 @@ More examples
   Hello World
   ```
 
+  see [extended rust guide](https://dotenvx.com/docs/quickstart)
+
   </details>
 * <details><summary>Java ☕️</summary><br>
 
@@ -132,6 +144,8 @@ More examples
   $ dotenvx run -- php artisan serve
   ```
 
+  see [framework guides](https://dotenvx.com/docs#frameworks)
+
   </details>
 * <details><summary>Docker 🐳</summary><br>
 
@@ -148,21 +162,47 @@ More examples
   CMD ["dotenvx", "run", "--", "echo", "Hello $HELLO"]
   ```
 
+  see [docker guide](https://dotenvx.com/docs/platforms/docker)
+
   </details>
 
 * <details><summary>CI/CDs 🐙</summary><br>
 
-  ```sh
-  examples coming soon
-  ```
+  ```yaml
+  name: build
+  on: [push]
+  jobs:
+    build:
+      runs-on: ubuntu-latest
+      steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+      - run: curl -fsS https://dotenvx.sh/ | sh
+      - run: dotenvx run -- node build.js
+        env:
+          DOTENV_KEY: ${{ secrets.DOTENV_KEY }}
+  ```
+
+  see [github actions guide](https://dotenvx.com/docs/cis/github-actions)
 
   </details>
 * <details><summary>Platforms</summary><br>
 
   ```sh
-  examples coming soon
+  # heroku
+  heroku buildpacks:add https://github.com/dotenvx/heroku-buildpack-dotenvx
+
+  # docker
+  RUN curl -fsS https://dotenvx.sh/ | sh
+
+  # vercel
+  npm install @dotenvx/dotenvx --save
   ```
 
+  see [platform guides](https://dotenvx.com/docs#platforms)
+
   </details>
 * <details><summary>npx</summary><br>
 
@@ -330,12 +370,23 @@ More examples
 
 * <details><summary>Docker</summary><br>
 
+  > Add the `dotenvx` binary to your Dockerfile
+
   ```sh
-  coming soon
+  # Install dotenvx
+  RUN curl -fsS https://dotenvx.sh/ | sh
   ```
 
-  </details>
+  > Use it in your Dockerfile CMD
 
+  ```sh
+  # Prepend dotenvx run
+  CMD ["dotenvx", "run", "--", "node", "index.js"]
+  ```
+
+  see [docker guide](https://dotenvx.com/docs/platforms/docker)
+
+  </details>
 
 * <details><summary>Fly.io</summary><br>
 
@@ -359,7 +410,7 @@ More examples
   web: dotenvx run -- node index.js
   ```
 
-  [see heroku guide](https://dotenvx.com/docs/platforms/heroku)
+  see [heroku guide](https://dotenvx.com/docs/platforms/heroku)
 
   </details>
 
@@ -397,10 +448,25 @@ More examples
 
 * <details><summary>Vercel</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 [vercel guide](https://dotenvx.com/docs/platforms/vercel)
+
   </details>
 
 * <details><summary>CircleCI</summary><br>
@@ -413,19 +479,50 @@ More examples
 
 * <details><summary>GitHub Actions</summary><br>
 
+  > Add the `dotenvx` binary to GitHub Actions
+
   ```sh
-  coming soon
+  name: build
+  on: [push]
+  jobs:
+    build:
+      runs-on: ubuntu-latest
+      steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+      - run: curl -fsS https://dotenvx.sh/ | sh
+      - run: dotenvx run -- node build.js
+        env:
+          DOTENV_KEY: ${{ secrets.DOTENV_KEY }}
   ```
 
+  see [github actions guide](https://dotenvx.com/docs/cis/github-actions)
+
   </details>
 
 &nbsp;
 
+## Hub
+
+> Integrate tightly with [GitHub](https://github.com) 🐙
+```sh
+$ dotenvx hub login
+$ dotenvx hub push
+```
+
+more details coming soon.
+
+&nbsp;
+
 ## Guides
 
 * [dotenvx/docs](https://dotenvx.com/docs)
 * [quickstart guide](https://dotenvx.com/docs/quickstart)
 
+&nbsp;
+
 ## Pre-commit
 
 You can prevent `.env` files from being committed to code with this pre-commit hook.
@@ -446,6 +543,8 @@ To ignore the pre-commit hook run your git commit with the `--no-verify` flag.
 git commit -am "msg" --no-verify
 ```
 
+&nbsp;
+
 ## Contributing
 
 You can fork this repo and create [pull requests](https://github.com/dotenvx/dotenvx/pulls) or if you have questions or feedback:

package/package.json

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

package/src/cli/actions/precommit.js

@@ -69,7 +69,17 @@ function precommit () {
 }
 
 function installPrecommitHook () {
-  const hookScript = '#!/bin/sh\ndotenvx precommit\n'
+  const hookScript = `#!/bin/sh
+
+if ! command -v dotenvx &> /dev/null
+then
+  echo "[dotenvx][precommit] 'dotenvx' command not found"
+  echo "[dotenvx][precommit] ? install it with [brew install dotenvx/brew/dotenvx]"
+  echo "[dotenvx][precommit] ? other install options [https://dotenvx.com/docs/install]"
+  exit 1
+fi
+
+dotenvx precommit`
   const hookPath = path.join('.git', 'hooks', 'pre-commit')
 
   try {

package/src/cli/actions/predockerbuild.js

@@ -0,0 +1,64 @@
+const fs = require('fs')
+
+const ignore = require('ignore')
+
+const logger = require('./../../shared/logger')
+const helpers = require('./../helpers')
+
+function predockerbuild () {
+  const options = this.opts()
+  logger.debug(`options: ${JSON.stringify(options)}`)
+
+  // 1. check for .dockerignore file
+  if (!fs.existsSync('.dockerignore')) {
+    logger.errorvpd('.dockerignore missing')
+    logger.help2('? add it with [touch .dockerignore]')
+    process.exit(1)
+  }
+
+  // 2. check .env* files against .dockerignore file
+  let warningCount = 0
+  const ig = ignore().add(fs.readFileSync('.dockerignore').toString())
+  const files = fs.readdirSync(process.cwd())
+  const dotenvFiles = files.filter(file => file.match(/^\.env(\..+)?$/))
+  dotenvFiles.forEach(file => {
+    // check if that file is being ignored
+    if (ig.ignores(file)) {
+      switch (file) {
+        case '.env.example':
+          warningCount += 1
+          logger.warnv(`${file} (currently ignored but should not be)`)
+          logger.help2(`? add !${file} to .dockerignore with [echo "!${file}" >> .dockerignore]`)
+          break
+        case '.env.vault':
+          warningCount += 1
+          logger.warnv(`${file} (currently ignored but should not be)`)
+          logger.help2(`? add !${file} to .dockerignore with [echo "!${file}" >> .dockerignore]`)
+          break
+        default:
+          break
+      }
+    } else {
+      switch (file) {
+        case '.env.example':
+          break
+        case '.env.vault':
+          break
+        default:
+          logger.errorvpd(`${file} not properly dockerignored`)
+          logger.help2(`? add ${file} to .dockerignore with [echo ".env*" >> .dockerignore]`)
+          process.exit(1) // 3.1 exit early with error code
+          break
+      }
+    }
+  })
+
+  // 3. outpout success
+  if (warningCount > 0) {
+    logger.successvpd(`success (with ${helpers.pluralize('warning', warningCount)})`)
+  } else {
+    logger.successvpd('success')
+  }
+}
+
+module.exports = predockerbuild

package/src/cli/actions/run.js

@@ -93,6 +93,7 @@ async function run () {
             logger.warnv(`missing ${envFilepath} file (${filepath})`)
             logger.help(`? in development: add one with [echo "HELLO=World" > .env] and re-run [dotenvx run -- ${commandArgs.join(' ')}]`)
             logger.help('? for production: set [DOTENV_KEY] on your server and re-deploy')
+            logger.help('? for ci: set [DOTENV_KEY] on your ci and re-build')
             break
 
           // unhandled error

package/src/cli/dotenvx.js

@@ -68,11 +68,17 @@ program.command('encrypt')
 
 // dotenvx precommit
 program.command('precommit')
-  .description('dotenvx precommit check')
+  .description('prevent committing .env files to code')
   .addHelpText('after', examples.precommit)
   .option('-i, --install', 'install to .git/hooks/pre-commit')
   .action(require('./actions/precommit'))
 
+// dotenvx predockerbuild
+program.command('predockerbuild')
+  .description('prevent including .env files in docker build')
+  .addHelpText('after', examples.predockerbuild)
+  .action(require('./actions/predockerbuild'))
+
 // dotenvx hub
 program.addCommand(require('./commands/hub'))
 

package/src/cli/examples.js

@@ -66,8 +66,26 @@ Try it:
   `
 }
 
+const predockerbuild = function () {
+  return `
+Examples:
+
+  \`\`\`
+  $ dotenvx predockerbuild
+  \`\`\`
+
+Try it:
+
+  \`\`\`
+  $ dotenvx predockerbuild
+  [dotenvx@0.10.0][predockerbuild] success
+  \`\`\`
+  `
+}
+
 module.exports = {
   run,
   encrypt,
-  precommit
+  precommit,
+  predockerbuild
 }

package/src/shared/logger.js

@@ -12,12 +12,15 @@ const levels = {
   error: 0,
   errorv: 0,
   errorvp: 0,
+  errorvpd: 0,
   warn: 1,
   warnv: 1,
   warnvp: 1,
+  warnvpd: 1,
   success: 2,
   successv: 2,
   successvp: 2,
+  successvpd: 2,
   info: 2,
   help: 2,
   help2: 2,
@@ -48,18 +51,24 @@ const dotenvxFormat = printf(({ level, message, label, timestamp }) => {
       return error(`[dotenvx@${packageJson.version}] ${formattedMessage}`)
     case 'errorvp':
       return error(`[dotenvx@${packageJson.version}][precommit] ${formattedMessage}`)
+    case 'errorvpd':
+      return error(`[dotenvx@${packageJson.version}][predockerbuild] ${formattedMessage}`)
     case 'warn':
       return warn(formattedMessage)
     case 'warnv':
       return warn(`[dotenvx@${packageJson.version}] ${formattedMessage}`)
     case 'warnvp':
       return warn(`[dotenvx@${packageJson.version}][precommit] ${formattedMessage}`)
+    case 'warnvpd':
+      return warn(`[dotenvx@${packageJson.version}][predockerbuild] ${formattedMessage}`)
     case 'success':
       return success(formattedMessage)
     case 'successv': // success with 'version'
       return successv(`[dotenvx@${packageJson.version}] ${formattedMessage}`)
     case 'successvp': // success with 'version' and precommit
       return success(`[dotenvx@${packageJson.version}][precommit] ${formattedMessage}`)
+    case 'successvpd': // success with 'version' and precommit
+      return success(`[dotenvx@${packageJson.version}][predockerbuild] ${formattedMessage}`)
     case 'info':
       return formattedMessage
     case 'help':