feat: added guessFile "exclude" option

Author: simlu

README.md

@@ -19,7 +19,7 @@ Drop in replacement for [fs](https://nodejs.org/api/fs.html).
 
 ## Functions
 
-### guessFile(filepath)
+### guessFile(filepath, { exclude = [] })
 
 Extends and returns filepath with the file extension as appropriate. Returns `null` if no good match was found.
 
@@ -28,6 +28,8 @@ A few notes:
   - Will prefer to match the exact file
   - Will return `null` when multiple possible extensions are found
 
+To exclude certain extensions from being matched provide them in the `exclude` option.
+
 ### walkDir(dirpath)
 
 Iteratively walk dirpath and return relative paths of all files contained.

src/logic/guess-file.js

@@ -1,15 +1,26 @@
+const assert = require('assert');
 const fs = require('fs');
 const path = require('path');
 
-module.exports = (filepath) => {
+module.exports = (filepath, options = {}) => {
+  assert(typeof filepath === 'string');
+  assert(options instanceof Object && !Array.isArray(options));
+
+  const ctx = {
+    exclude: [],
+    ...options
+  };
+  assert(Array.isArray(ctx.exclude));
+
   const dirname = path.dirname(filepath);
   const basename = path.basename(filepath);
   if (!fs.existsSync(dirname) || !fs.lstatSync(dirname).isDirectory()) {
     return null;
   }
   const relevantFiles = fs
     .readdirSync(dirname)
-    .filter((f) => f === basename || (f.startsWith(`${basename}.`) && f.lastIndexOf('.') <= basename.length));
+    .filter((f) => f === basename || (f.startsWith(`${basename}.`) && f.lastIndexOf('.') <= basename.length))
+    .filter((f) => !ctx.exclude.includes(f.slice(f.lastIndexOf('.') + 1)));
   if (relevantFiles.includes(basename)) {
     return filepath;
   }

test/logic/guess-file.spec.js

@@ -10,10 +10,10 @@ describe('Testing guessFile', { useTmpDir: true }, () => {
     tmpDir = dir;
   });
 
-  const executeTest = (files, input, expected) => {
+  const executeTest = (files, input, expected, opts = undefined) => {
     files.forEach((f) => fs.writeFileSync(path.join(tmpDir, f), ''));
     const filepath = path.join(tmpDir, input);
-    expect(guessFile(filepath)).to.equal(typeof expected === 'string' ? path.join(tmpDir, expected) : expected);
+    expect(guessFile(filepath, opts)).to.equal(typeof expected === 'string' ? path.join(tmpDir, expected) : expected);
   };
 
   it('Testing exact multi-match', () => {
@@ -35,6 +35,10 @@ describe('Testing guessFile', { useTmpDir: true }, () => {
     executeTest(['file.json', 'file.yml'], 'file', null);
   });
 
+  it('Testing partial multi but exclude has match', () => {
+    executeTest(['file.json', 'file.yml'], 'file', 'file.json', { exclude: ['yml'] });
+  });
+
   it('Testing double extension', () => {
     executeTest(['file.json.json'], 'file', null);
     executeTest(['file..json'], 'file', null);