@dotenvx/dotenvx 1.10.4 → 1.11.0

package/CHANGELOG.md

@@ -2,7 +2,17 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-## [Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.10.4...main)
+## [Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.11.0...main)
+
+## 1.11.0
+
+### Added
+
+* add `--exclude-env-file (-ef)` to `ext ls` ([#356](https://github.com/dotenvx/dotenvx/pull/356))
+
+### Changed
+
+* `ext precommit` ignores `tests/` directory (and similar) ([#356](https://github.com/dotenvx/dotenvx/pull/356))
 
 ## 1.10.4
 

package/package.json

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

package/src/cli/actions/ext/ls.js

@@ -12,7 +12,7 @@ function ls (directory) {
   const options = this.opts()
   logger.debug(`options: ${JSON.stringify(options)}`)
 
-  const filepaths = main.ls(directory, options.envFile)
+  const filepaths = main.ls(directory, options.envFile, options.excludeEnvFile)
   logger.debug(`filepaths: ${JSON.stringify(filepaths)}`)
 
   const tree = new ArrayToTree(filepaths).run()

package/src/cli/commands/ext.js

@@ -25,6 +25,7 @@ ext.command('ls')
   .description('print all .env files in a tree structure')
   .argument('[directory]', 'directory to list .env files from', '.')
   .option('-f, --env-file <filenames...>', 'path(s) to your env file(s)', '.env*')
+  .option('-ef, --exclude-env-file <excludeFilenames...>', 'path(s) to exclude from your env file(s) (default: none)')
   .action(require('./../actions/ext/ls'))
 
 // dotenvx ext genexample

package/src/lib/main.d.ts

@@ -184,8 +184,13 @@ export function encrypt(
  *
  * @param directory - current working directory
  * @param envFile - glob pattern to match env files
+ * @param excludeEnvFile - glob pattern to exclude env files
  */
-export function ls(directory: string, envFile: string): string[];
+export function ls(
+  directory: string,
+  envFile: string | string[],
+  excludeEnvFile: string | string[]
+): string[];
 
 /**
  * Get the value of a key from the .env file

package/src/lib/main.js

@@ -173,8 +173,8 @@ const parse = function (src) {
 }
 
 /** @type {import('./main').ls} */
-const ls = function (directory, envFile) {
-  return new Ls(directory, envFile).run()
+const ls = function (directory, envFile, excludeEnvFile) {
+  return new Ls(directory, envFile, excludeEnvFile).run()
 }
 
 /** @type {import('./main').genexample} */

package/src/lib/services/ls.js

@@ -3,11 +3,12 @@ const path = require('path')
 const picomatch = require('picomatch')
 
 class Ls {
-  constructor (directory = './', envFile = '.env*') {
+  constructor (directory = './', envFile = ['.env*'], excludeEnvFile = []) {
     this.ignore = ['node_modules/**', '.git/**']
 
     this.cwd = path.resolve(directory)
     this.envFile = envFile
+    this.excludeEnvFile = excludeEnvFile
   }
 
   run () {
@@ -15,9 +16,9 @@ class Ls {
   }
 
   _filepaths () {
-    const exclude = picomatch(this.ignore)
+    const exclude = picomatch(this._exclude())
     const include = picomatch(this._patterns(), {
-      ignore: this.ignore
+      ignore: this._exclude()
     })
 
     return new Fdir()
@@ -35,6 +36,22 @@ class Ls {
 
     return this.envFile.map(part => `**/${part}`)
   }
+
+  _excludePatterns () {
+    if (!Array.isArray(this.excludeEnvFile)) {
+      return [`**/${this.excludeEnvFile}`]
+    }
+
+    return this.excludeEnvFile.map(part => `**/${part}`)
+  }
+
+  _exclude () {
+    if (this._excludePatterns().length > 0) {
+      return this.ignore.concat(this._excludePatterns())
+    } else {
+      return this.ignore
+    }
+  }
 }
 
 module.exports = Ls

package/src/lib/services/precommit.js

@@ -12,6 +12,7 @@ const MISSING_GITIGNORE = '.env.keys' // by default only ignore .env.keys. all o
 class Precommit {
   constructor (options = {}) {
     this.install = options.install
+    this.excludeEnvFile = ['test/**', 'tests/**', 'spec/**', 'specs/**', 'pytest/**', 'test_suite/**']
   }
 
   run () {
@@ -40,7 +41,7 @@ class Precommit {
 
       // 2. check .env* files against .gitignore file
       const ig = ignore().add(gitignore)
-      const lsService = new Ls(process.cwd())
+      const lsService = new Ls(process.cwd(), undefined, this.excludeEnvFile)
       const dotenvFiles = lsService.run()
       dotenvFiles.forEach(file => {
         // check if that file is being ignored