@dotenvx/dotenvx - npm Package Compare versions

Comparing version 0.13.0 to 0.14.0

package.json

 {
-  "version": "0.13.0",
+  "version": "0.14.0",
   "name": "@dotenvx/dotenvx",
@@ -39,3 +39,3 @@ "description": "a better dotenv–from the creator of `dotenv`",
     "qrcode-terminal": "^0.12.0",
-    "update-notifier": "^5.1.0",
+    "update-notifier": "^7.0.0",
     "winston": "^3.11.0",
@@ -42,0 +42,0 @@ "xxhashjs": "^0.2.2"

README.md

@@ -426,3 +426,3 @@ ![dotenvx](https://dotenvx.com/better-banner.png)
 
-* <details><summary>Docker</summary><br>
+* <details><summary>Docker 🐳</summary><br>
 
@@ -447,11 +447,23 @@ > Add the `dotenvx` binary to your Dockerfile
 
-* <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>
 
@@ -482,16 +494,43 @@ > Add the buildpack, installing the `dotenvx` binary to your heroku deployment.
 
-* <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>
@@ -507,3 +546,3 @@
 
-* <details><summary>Vercel</summary><br>
+* <details><summary>Vercel ▲</summary><br>
 
@@ -539,3 +578,3 @@ > Add the `dotenvx` npm module
 
-* <details><summary>GitHub Actions</summary><br>
+* <details><summary>GitHub Actions 🐙</summary><br>
 
@@ -569,3 +608,3 @@ > Add the `dotenvx` binary to GitHub Actions
 
-> Integrate tightly with [GitHub](https://github.com) 🐙
+> Integrate tightly with [GitHub](https://github.com) 🐙 and as a team
 ```sh
@@ -576,33 +615,29 @@ $ dotenvx hub login
 
-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
 
+* [`dotenvx gitignore`](https://dotenvx.com/docs/features/gitignore) – gitignore your `.env` files
+* [`dotenvx precommit`](https://dotenvx.com/docs/features/precommit) – prevent `.env` files from being committed to code
+* [`dotenvx prebuild`](https://dotenvx.com/docs/features/prebuild) – prevent `.env` files from being built into your docker container
+* `dotenvx genexample` – generate `.env.example` file (coming soon)
+
 &nbsp;
 
-## Pre-commit
+## Guides
 
-You can prevent `.env` files from being committed to code with this pre-commit hook.
+* [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)
 
-```
-dotenvx precommit --install
-```
-
-Run without the `--install` flag to preview output.
-
-```
-dotenvx precommit
-```
-
-To ignore the pre-commit hook run your git commit with the `--no-verify` flag.
-
-```
-git commit -am "msg" --no-verify
-```
-
 &nbsp;
@@ -609,0 +644,0 @@

src/cli/actions/gitignore.js

@@ -41,2 +41,3 @@ const fs = require('fs')
   run () {
+    logger.verbose('appending to .gitignore')
     new Generic('.gitignore', true).run()
@@ -48,2 +49,3 @@ }
   run () {
+    logger.verbose('appending to .dockerignore (if existing)')
     new Generic('.dockerignore').run()
@@ -55,2 +57,3 @@ }
   run () {
+    logger.verbose('appending to .npmignore (if existing)')
     new Generic('.npmignore').run()
@@ -62,2 +65,3 @@ }
   run () {
+    logger.verbose('appending to .vercelignore (if existing)')
     new Generic('.vercelignore').run()
@@ -71,12 +75,5 @@ }
 
-  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()
@@ -83,0 +80,0 @@

src/cli/dotenvx.js

@@ -72,5 +72,10 @@ #!/usr/bin/env node
   .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
@@ -89,7 +94,7 @@ program.command('precommit')
 
-// 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'))
 
@@ -96,0 +101,0 @@ // dotenvx hub

No alert changes

Improved metrics

Total package byte prevSize

69192

increased by7.05%

Number of package files

25

increased by4.17%

Lines of code

1490

increased by5.6%

Number of lines in readme file

644

increased by5.75%

Worsened metrics

Number of low supply chain risk alerts

19

increased by5.56%

Dependency changes

• + Added@pnpm/config.env-replace@1.1.0(transitive)

• + Added@pnpm/network.ca-file@1.0.2(transitive)

• + Added@pnpm/npm-conf@2.3.1(transitive)

• + Addedansi-regex@6.1.0(transitive)

• + Addedansi-styles@6.2.1(transitive)

• + Addedatomically@2.0.3(transitive)

• + Addedboxen@8.0.1(transitive)

• + Addedcamelcase@8.0.0(transitive)

• + Addedchalk@5.4.1(transitive)

• + Addedcli-boxes@3.0.0(transitive)

• + Addedconfig-chain@1.1.13(transitive)

• + Addedconfigstore@7.0.0(transitive)

• + Addeddot-prop@9.0.0(transitive)

• + Addedemoji-regex@10.4.0(transitive)

• + Addedescape-goat@4.0.0(transitive)

• + Addedget-east-asian-width@1.3.0(transitive)

• + Addedglobal-directory@4.0.1(transitive)

• + Addedgraceful-fs@4.2.10(transitive)

• + Addedini@4.1.1(transitive)

• + Addedis-in-ci@1.0.0(transitive)

• + Addedis-installed-globally@1.0.0(transitive)

• + Addedis-npm@6.0.0(transitive)

• + Addedis-path-inside@4.0.0(transitive)

• + Addedky@1.7.4(transitive)

• + Addedlatest-version@9.0.0(transitive)

• + Addedpackage-json@10.0.1(transitive)

• + Addedproto-list@1.2.4(transitive)

• + Addedpupa@3.1.0(transitive)

• + Addedregistry-auth-token@5.0.3(transitive)

• + Addedregistry-url@6.0.1(transitive)

• + Addedstring-width@7.2.0(transitive)

• + Addedstrip-ansi@7.1.0(transitive)

• + Addedstubborn-fs@1.2.5(transitive)

• + Addedtype-fest@4.33.0(transitive)

• + Addedupdate-notifier@7.3.1(transitive)

• + Addedwhen-exit@2.1.4(transitive)

• + Addedwidest-line@5.0.0(transitive)

• + Addedwrap-ansi@9.0.0(transitive)

• + Addedxdg-basedir@5.1.0(transitive)

• - Removed@sindresorhus/is@0.14.0(transitive)

• - Removed@szmarczak/http-timer@1.1.2(transitive)

• - Removedboxen@5.1.2(transitive)

• - Removedcacheable-request@6.1.0(transitive)

• - Removedcamelcase@6.3.0(transitive)

• - Removedci-info@2.0.0(transitive)

• - Removedcli-boxes@2.2.1(transitive)

• - Removedclone-response@1.0.3(transitive)

• - Removedconfigstore@5.0.1(transitive)

• - Removedcrypto-random-string@2.0.0(transitive)

• - Removeddecompress-response@3.3.0(transitive)

• - Removeddefer-to-connect@1.1.3(transitive)

• - Removeddot-prop@5.3.0(transitive)

• - Removedduplexer3@0.1.5(transitive)

• - Removedescape-goat@2.1.1(transitive)

• - Removedget-stream@5.2.0(transitive)

• - Removedglobal-dirs@3.0.1(transitive)

• - Removedgot@9.6.0(transitive)

• - Removedhas-yarn@2.1.0(transitive)

• - Removedhttp-cache-semantics@4.1.1(transitive)

• - Removedimport-lazy@2.1.0(transitive)

• - Removedimurmurhash@0.1.4(transitive)

• - Removedini@2.0.0(transitive)

• - Removedis-ci@2.0.0(transitive)

• - Removedis-installed-globally@0.4.0(transitive)

• - Removedis-npm@5.0.0(transitive)

• - Removedis-path-inside@3.0.3(transitive)

• - Removedis-typedarray@1.0.0(transitive)

• - Removedis-yarn-global@0.3.0(transitive)

• - Removedjson-buffer@3.0.0(transitive)

• - Removedkeyv@3.1.0(transitive)

• - Removedlatest-version@5.1.0(transitive)

• - Removedlowercase-keys@1.0.12.0.0(transitive)

• - Removedmake-dir@3.1.0(transitive)

• - Removedmimic-response@1.0.1(transitive)

• - Removednormalize-url@4.5.1(transitive)

• - Removedp-cancelable@1.1.0(transitive)

• - Removedpackage-json@6.5.0(transitive)

• - Removedprepend-http@2.0.0(transitive)

• - Removedpupa@2.1.1(transitive)

• - Removedregistry-auth-token@4.2.2(transitive)

• - Removedregistry-url@5.1.0(transitive)

• - Removedresponselike@1.0.2(transitive)

• - Removedsemver@6.3.1(transitive)

• - Removedsemver-diff@3.1.1(transitive)

• - Removedto-readable-stream@1.0.0(transitive)

• - Removedtype-fest@0.20.2(transitive)

• - Removedtypedarray-to-buffer@3.1.5(transitive)

• - Removedunique-string@2.0.0(transitive)

• - Removedupdate-notifier@5.1.0(transitive)

• - Removedurl-parse-lax@3.0.0(transitive)

• - Removedwidest-line@3.1.0(transitive)

• - Removedwrap-ansi@7.0.0(transitive)

• - Removedwrite-file-atomic@3.0.3(transitive)

• - Removedxdg-basedir@4.0.0(transitive)

• Updatedupdate-notifier@^7.0.0