@dotenvx/dotenvx 0.5.0 → 0.6.1

package/README.md

@@ -72,6 +72,28 @@ More examples
   Hello World
   ```
 
+  </details>
+* <details><summary>Java ☕️</summary><br>
+
+  ```sh
+  $ echo 'public class Index { public static void main(String[] args) { System.out.println("Hello " + System.getenv("HELLO")); } }' > index.java
+
+  $ dotenvx run -- java index.java
+  Hello World
+  ```
+
+  </details>
+* <details><summary>.NET 🔵</summary><br>
+
+  ```sh
+  $ dotnet new console -n HelloWorld -o HelloWorld
+  $ cd HelloWorld
+  $ echo 'Console.WriteLine($"Hello {Environment.GetEnvironmentVariable("HELLO")}");' > Program.cs && echo "HELLO=World" > .env
+
+  $ dotenvx run -- dotnet run
+  Hello World
+  ```
+
   </details>
 * <details><summary>Frameworks ▲</summary><br>
 
@@ -124,6 +146,35 @@ More examples
   ```
 
   </details>
+* <details><summary>npm</summary><br>
+
+  ```sh
+  $ npm install @dotenvx/dotenvx --save
+  ```
+
+  ```json
+  {
+    "scripts": {
+      "start": "./node_modules/.bin/dotenvx run -- node index.js"
+    },
+    "dependencies": {
+      "@dotenvx/dotenvx": "^0.5.0"
+    }
+  }
+  ```
+
+  ```sh
+  $ npm run start
+
+  > start
+  > ./node_modules/.bin/dotenvx run -- node index.js
+
+  [dotenvx][INFO] injecting 1 environment variable from .env
+  Hello World
+  ```
+
+  </details>
+
 * <details><summary>Git</summary><br>
 
   ```sh
@@ -143,14 +194,14 @@ Pass the `--env-file` flag (shorthand `-f`) to run any environment from a `.env.
 
 ```sh
 $ dotenvx run --env-file=.env.production -- node index.js
-[dotenvx][INFO] Injecting 12 production environment variables into your application process
+[dotenvx][INFO] injecting 12 environment variables from .env.production
 ```
 
 Combine multiple `.env` files if you like.
 
 ```
 $ dotenvx run --env-file=.env.local --env-file=.env -- node index.js
-[dotenvx][INFO] Injecting 12 local, 1 development environment variables into your application process
+[dotenvx][INFO] injecting 13 environment variables from .env.local,.env
 ```
 
 &nbsp;
@@ -188,7 +239,7 @@ Run it with `dotenvx`.
 
 ```sh
 $ dotenvx run -- node index.js
-[dotenvx@x.x.x][WARN] ENOENT: no such file or directory, open '/../../.env'
+[dotenvx][WARN] ENOENT: no such file or directory, open '/../../.env'
 Hello undefined
 ```
 
@@ -205,7 +256,7 @@ Run it again.
 
 ```sh
 $ dotenvx run -- node index.js
-[dotenvx@x.x.x][INFO] Injecting 0 environment variables into your application process
+[dotenvx][INFO] injecting 0 environment variables from .env
 Hello undefined
 ```
 
@@ -213,10 +264,10 @@ Hrm, still undefined. Pass the `--debug` flag to debug the issue. I'll give you
 
 ```sh
 $ dotenvx run --debug -- node index.js
-[dotenvx@x.x.x][VERBOSE] Loading env from /../../.env
-[dotenvx@x.x.x][DEBUG] Reading env from /../../.env
-[dotenvx@x.x.x][DEBUG] Parsing env from /../../.env
-[dotenvx@x.x.x][DEBUG] {"JELLO":"World"}
+[dotenvx][VERBOSE] Loading env from /../../.env
+[dotenvx][DEBUG] Reading env from /../../.env
+[dotenvx][DEBUG] Parsing env from /../../.env
+[dotenvx][DEBUG] {"JELLO":"World"}
 
 # Oops, HELLO not JELLO ^^
 ```
@@ -232,7 +283,7 @@ One last time. [Le tired](https://youtu.be/kCpjgl2baLs?t=45).
 
 ```sh
 $ dotenvx run -- node index.js
-[dotenvx@x.x.x][INFO] Injecting 1 environment variable into your application process
+[dotenvx][INFO] injecting 1 environment variable from .env
 Hello World
 ```
 
@@ -251,51 +302,41 @@ brew install dotenvx/brew/dotenvx
 
 ### Other Ways to Install
 
-1. After `brew`, installing globally using [`npm`](https://www.npmjs.com/package/@dotenvx/dotenvx) is easiest:
+#### 1. global npm
+
+After `brew`, installing globally using [`npm`](https://www.npmjs.com/package/@dotenvx/dotenvx) is easiest:
 
 ```sh
 npm install @dotenvx/dotenvx --global
 ```
 
-2. Or use with [`npx`](https://www.npmjs.com/package/npx):
+#### 2. local npm
 
-```sh
-npx @dotenvx/dotenvx help
-```
-
-3. Or install in your `package.json`
+Or install in your `package.json`:
 
 ```sh
 npm i @dotenvx/dotenvx --save
 ```
 ```json
-// package.json
-"scripts": {
-  "start": "./node_modules/.bin/dotenvx run -- nodex index.js"
+{
+  "scripts": {
+    "start": "./node_modules/.bin/dotenvx run -- node index.js"
+  },
+  "dependencies": {
+    "@dotenvx/dotenvx": "^0.6.0"
+  }
 }
 ```
 
-3. Or download it directly as a standalone binary:
+#### 3. standalone binary
 
-```sh
-curl -fsS https://dotenvx.sh/ | sh
-```
+Or download it directly as a standalone binary:
 
 ```sh
-# download it to `./dotenvx`
+# download it to `/user/local/bin/dotenvx`
 curl -fsS https://dotenvx.sh/ | sh
 
 # check it works
-./dotenvx help
-
-# move it to `/usr/local/bin/dotenvx`
-sudo install -m 755 dotenvx /usr/local/bin
-
-# check it still works
-/usr/local/bin/dotenvx help
-
-# check it is in your path
-which dotenv
 dotenvx help
 ```
 

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.5.0",
+  "version": "0.6.1",
   "name": "@dotenvx/dotenvx",
   "description": "a better dotenv–from the creator of `dotenv`",
   "author": "@motdotla",
@@ -21,7 +21,7 @@
   "scripts": {
     "standard": "standard",
     "standard:fix": "standard --fix",
-    "test": "jest"
+    "test": "jest --verbose"
   },
   "dependencies": {
     "commander": "^11.1.0",

package/src/cli/dotenvx.js

@@ -9,6 +9,7 @@ const ENCODING = 'utf8'
 
 const logger = require('./../shared/logger')
 const helpers = require('./helpers')
+const { AppendToIgnores } = require('./ignores')
 const packageJson = require('./../shared/packageJson')
 const main = require('./../lib/main')
 
@@ -19,6 +20,8 @@ program
   .option('-v, --verbose', 'sets log level to verbose')
   .option('-d, --debug', 'sets log level to debug')
   .hook('preAction', (thisCommand, actionCommand) => {
+    new AppendToIgnores().run()
+
     const options = thisCommand.opts()
 
     if (options.logLevel) {

package/src/cli/ignores.js

@@ -0,0 +1,67 @@
+const fs = require('fs')
+
+const FORMATS = ['.env*', '!.env.vault', '.flaskenv*']
+
+class Generic {
+  constructor (filename, touchFile = false) {
+    this.filename = filename
+    this.formats = FORMATS
+    this.touchFile = touchFile
+  }
+
+  append (str) {
+    fs.appendFileSync(this.filename, `\n${str}`)
+  }
+
+  run () {
+    if (!fs.existsSync(this.filename)) {
+      if (this.touchFile === true) {
+        fs.writeFileSync(this.filename, '')
+      } else {
+        return
+      }
+    }
+
+    const lines = fs.readFileSync(this.filename, 'utf8').split(/\r?\n/)
+    this.formats.forEach(format => {
+      if (!lines.includes(format.trim())) {
+        this.append(format)
+      }
+    })
+  }
+}
+
+class Git {
+  run () {
+    new Generic('.gitignore', true).run()
+  }
+}
+
+class Docker {
+  run () {
+    new Generic('.dockerignore').run()
+  }
+}
+
+class Npm {
+  run () {
+    new Generic('.npmignore').run()
+  }
+}
+
+class Vercel {
+  run () {
+    new Generic('.vercelignore').run()
+  }
+}
+
+class AppendToIgnores {
+  run () {
+    new Docker().run()
+    new Git().run()
+    new Npm().run()
+    new Vercel().run()
+  }
+}
+
+module.exports = { AppendToIgnores, Generic }

package/src/shared/logger.js

@@ -7,14 +7,10 @@ const transports = winston.transports
 
 const packageJson = require('./packageJson')
 
-function pad (word) {
-  return word.padEnd(9, ' ')
-}
-
 const dotenvxFormat = printf(({ level, message, label, timestamp }) => {
   const formattedMessage = typeof message === 'object' ? JSON.stringify(message) : message
 
-  return `[dotenvx@${packageJson.version}]${pad(`[${level.toUpperCase()}]`)} ${formattedMessage}`
+  return `[dotenvx@${packageJson.version}][${level.toUpperCase()}] ${formattedMessage}`
 })
 
 const logger = createLogger({