filehound 1.17.3 → 1.17.6

package/docs/filehound.js.html

@@ -421,8 +421,22 @@ class FileHound extends EventEmitter {
   }
 
   /**
-   * Same as glob
-   * @see glob
+   * Filter by a file glob
+   *
+   * @memberOf FileHound
+   * @instance
+   * @method
+   * match
+   * @param {array} glob - array of globs
+   * @return a FileHound instance
+   * @example
+   * import FileHound from 'filehound';
+   *
+   * const filehound = FileHound.create();
+   * filehound
+   *   .match(['*tmp*']) // .match('*tmp*')
+   *   .find()
+   *   .each(console.log); // array of files names all containing 'tmp'
    */
   match(globPatterns) {
     if (_.isArray(globPatterns)) {
@@ -727,6 +741,7 @@ class FileHound extends EventEmitter {
         let isDir = false;
         try {
           isDir = file.isDirectorySync();
+          // eslint-disable-next-line no-empty
         } catch (e) { }
 
         if (isDir) {
@@ -744,7 +759,7 @@ class FileHound extends EventEmitter {
       return {
         path: file.getName(),
         stats: file._getStatsSync()
-      }
+      };
     }
     return file.getName();
   }
@@ -769,7 +784,7 @@ export default FileHound;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Jan 28 2019 16:48:23 GMT+0000 (GMT) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.5</a> on Wed Aug 05 2020 13:26:06 GMT+0200 (Central European Summer Time) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/index.html

@@ -48,11 +48,13 @@
 
 
     <section class="readme">
-        <article><h1>Filehound</h1><p><a href="https://travis-ci.org/nspragg/filehound"><img src="https://travis-ci.org/nspragg/filehound.svg" alt="Build Status"></a> <a href="https://coveralls.io/github/nspragg/filehound?branch=master"><img src="https://coveralls.io/repos/github/nspragg/filehound/badge.svg?branch=master" alt="Coverage Status"></a></p>
+        <article><h1>Filehound</h1>
+<p><a href="https://travis-ci.org/nspragg/filehound"><img src="https://travis-ci.org/nspragg/filehound.svg" alt="Build Status"></a> <a href="https://coveralls.io/github/nspragg/filehound?branch=master"><img src="https://coveralls.io/repos/github/nspragg/filehound/badge.svg?branch=master" alt="Coverage Status"></a></p>
 <blockquote>
 <p>Flexible and fluent interface for searching the file system</p>
 </blockquote>
-<h2>Common examples</h2><p>The example below prints all of the files in a directory that have the <code>.json</code> file extension:</p>
+<h2>Common examples</h2>
+<p>The example below prints all of the files in a directory that have the <code>.json</code> file extension:</p>
 <pre class="prettyprint source lang-js"><code>const FileHound = require('filehound');
 
 const files = FileHound.create()
@@ -60,11 +62,17 @@ const files = FileHound.create()
   .ext('json')
   .find();
 
-files.then(console.log);</code></pre><h4>Matching the filename</h4><p>Find all the files that start with <code>dev</code>:</p>
+files.then(console.log);
+</code></pre>
+<h4>Matching the filename</h4>
+<p>Find all the files that start with <code>dev</code>:</p>
 <pre class="prettyprint source lang-js"><code>const files = FileHound.create()
   .paths('/etc/pki/')
   .match('dev*')
-  .find();</code></pre><h4>Filtering by file size</h4><p>Find all of the files in a directory that are larger than 1024 bytes:</p>
+  .find();
+</code></pre>
+<h4>Filtering by file size</h4>
+<p>Find all of the files in a directory that are larger than 1024 bytes:</p>
 <pre class="prettyprint source lang-js"><code>const files = FileHound.create()
   .paths('/some/dir')
   .size('>1024')
@@ -73,20 +81,32 @@ files.then(console.log);</code></pre><h4>Matching the filename</h4><p>Find all t
 const files = FileHound.create()
   .paths('/some/dir')
   .size('&lt;=1mb')
-  .find();</code></pre><h4>Combining filters</h4><p>Find all the <code>.txt</code> files that are larger than 1024 bytes <em>and</em> start with <code>note</code>:</p>
+  .find();
+</code></pre>
+<h4>Combining filters</h4>
+<p>Find all the <code>.txt</code> files that are larger than 1024 bytes <em>and</em> start with <code>note</code>:</p>
 <pre class="prettyprint source lang-js"><code>const files = FileHound.create()
   .paths('/etc/pki/')
   .match('note*')
   .ext('txt')
   .size('>1024')
-  .find();</code></pre><h4>Inverse filtering</h4><p>Find all of the files that <em>don't</em> have the <code>.json</code> extension:</p>
+  .find();
+</code></pre>
+<h4>Inverse filtering</h4>
+<p>Find all of the files that <em>don't</em> have the <code>.json</code> extension:</p>
 <pre class="prettyprint source lang-js"><code>const files = FileHound.create()
   .ext('json')
   .not()
-  .find();</code></pre><h4>Limiting the depth of a recursive search</h4><p>Find all files but <em>only</em> in the current directory (recursion off):</p>
+  .find();
+</code></pre>
+<h4>Limiting the depth of a recursive search</h4>
+<p>Find all files but <em>only</em> in the current directory (recursion off):</p>
 <pre class="prettyprint source lang-js"><code>const files = FileHound.create()
   .depth(0)
-  .find();</code></pre><h4>Combining multiple searches</h4><p>Find all the files that are <em>either</em> over 1K _or_ have the <code>.json</code> file extension:</p>
+  .find();
+</code></pre>
+<h4>Combining multiple searches</h4>
+<p>Find all the files that are <em>either</em> over 1K <em>or</em> have the <code>.json</code> file extension:</p>
 <pre class="prettyprint source lang-js"><code>const filesOverOneK = FileHound.create()
   .paths('/some/dir')
   .size('>1k')
@@ -97,7 +117,10 @@ const jsonFiles = FileHound.create()
   .ext('json')
   .find();
 
-const files = FileHound.any(filesOverOneK, jsonFiles);</code></pre><h4>Defining multiple search locations</h4><p>Find all JSON files in '/some/dir1' and '/some/dir2'</p>
+const files = FileHound.any(filesOverOneK, jsonFiles);
+</code></pre>
+<h4>Defining multiple search locations</h4>
+<p>Find all JSON files in '/some/dir1' and '/some/dir2'</p>
 <pre class="prettyprint source lang-js"><code>const jsonFiles = FileHound.create()
   .paths('/some/dir1', '/some/dir2')
   .ext('json')
@@ -107,25 +130,37 @@ const myPaths = ['/some/dir1', '/some/dir2'];
 const jsonFiles = FileHound.create()
   .paths(myPaths)
   .ext('json')
-  .find();</code></pre><h4>Search synchronously</h4><p>Find all JSON files in '/tmp' synchronously</p>
+  .find();
+</code></pre>
+<h4>Search synchronously</h4>
+<p>Find all JSON files in '/tmp' synchronously</p>
 <pre class="prettyprint source lang-js"><code>const jsonFiles = FileHound.create()
   .paths('/tmp')
   .ext('json')
-  .findSync();</code></pre><h4>Using callbacks</h4><p>Find all empty text files in /tmp:</p>
+  .findSync();
+</code></pre>
+<h4>Using callbacks</h4>
+<p>Find all empty text files in /tmp:</p>
 <pre class="prettyprint source lang-js"><code>FileHound.create()
   .paths('/tmp')
   .ext('txt')
   .isEmpty()
   .find((err, emptyTextFiles) => {
     console.log(emptyTextFiles);
-  });</code></pre><h4>Including file stats information</h4><p>Configure file objects, containing <code>path</code> and <code>stats</code>:</p>
+  });
+</code></pre>
+<h4>Including file stats information</h4>
+<p>Configure file objects, containing <code>path</code> and <code>stats</code>:</p>
 <pre class="prettyprint source lang-js"><code>const results = FileHound.create()
   .paths('/tmp')
   .ext('txt')
   .includeFileStats()
   .find();
 
-  console.log(results) // `results` is an array of file objects</code></pre><h4>Binding to match, error and end events</h4><p>Bind to a 'match' event to process each file on match:</p>
+  console.log(results) // `results` is an array of file objects
+</code></pre>
+<h4>Binding to match, error and end events</h4>
+<p>Bind to a 'match' event to process each file on match:</p>
 <pre class="prettyprint source lang-js"><code>const filehound = FileHound.create();
   filehound.find();
 
@@ -139,7 +174,10 @@ const jsonFiles = FileHound.create()
 
   filehound.on('end', (file) => {
     console(`search complete`);
-  });</code></pre><h4>Find files by matching content</h4><p>See <a href="https://github.com/nspragg/filesniffer">FileSniffer</a></p></article>
+  });
+</code></pre>
+<h4>Find files by matching content</h4>
+<p>See <a href="https://github.com/nspragg/filesniffer">FileSniffer</a></p></article>
     </section>
 
 
@@ -152,7 +190,7 @@ const jsonFiles = FileHound.create()
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Jan 28 2019 16:48:23 GMT+0000 (GMT) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.5</a> on Wed Aug 05 2020 13:26:06 GMT+0200 (Central European Summer Time) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

package/index.d.ts

@@ -1,5 +1,5 @@
 import { EventEmitter } from "events";
-import Bluebird from "bluebird";
+import * as Bluebird from "bluebird";
 
 declare module 'filehound' {
   class FileHound extends EventEmitter {
@@ -105,7 +105,7 @@ declare module 'filehound' {
      *  .find()
      *  .each(console.log);
      */
-    public addFilter(filter: (...any) => boolean): FileHound;
+    public addFilter(filter: (...args: any[]) => boolean): FileHound;
 
     /**
      * Defines the search paths
@@ -124,7 +124,7 @@ declare module 'filehound' {
      *  .find()
      *  .each(console.log);
      */
-    public paths(...paths: string[]): FileHound;
+    public paths(...paths: string[] | [string[]]): FileHound;
 
     /**
      * Define the search path

package/lib/filehound.js

@@ -415,8 +415,22 @@ var FileHound = function (_EventEmitter) {
     }
 
     /**
-     * Same as glob
-     * @see glob
+     * Filter by a file glob
+     *
+     * @memberOf FileHound
+     * @instance
+     * @method
+     * match
+     * @param {array} glob - array of globs
+     * @return a FileHound instance
+     * @example
+     * import FileHound from 'filehound';
+     *
+     * const filehound = FileHound.create();
+     * filehound
+     *   .match(['*tmp*']) // .match('*tmp*')
+     *   .find()
+     *   .each(console.log); // array of files names all containing 'tmp'
      */
 
   }, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "filehound",
-  "version": "1.17.3",
+  "version": "1.17.6",
   "description": "Find files the easy way",
   "main": "index.js",
   "scripts": {
@@ -48,7 +48,7 @@
     "eslint": "^4.18.2",
     "istanbul": "^0.4.4",
     "jsdoc": "^3.4.3",
-    "mocha": "^5.1.1",
+    "mocha": "^5.0.0",
     "sinon": "^5.0.2"
   },
   "eslintConfig": {
@@ -84,11 +84,11 @@
     }
   },
   "dependencies": {
-    "bluebird": "^3.5.1",
+    "bluebird": "^3.7.2",
     "file-js": "0.3.0",
-    "lodash": "^4.17.10",
-    "minimatch": "^3.0.4",
-    "moment": "^2.22.1",
+    "lodash": "^4.17.21",
+    "minimatch": "^5.0.0",
+    "moment": "^2.29.1",
     "unit-compare": "^1.0.1"
   }
 }

package/test/filehound.js

@@ -558,6 +558,18 @@ describe('FileHound', () => {
         });
     });
 
+    it('returns files for given match names', () => {
+      const query = FileHound.create()
+        .match(['*b.json', '*bcc.json'])
+        .paths(fixtureDir + '/mixed')
+        .find();
+
+      return query
+        .then((files) => {
+          assert.deepEqual(files.sort(), matchFiles);
+        });
+    });
+
     describe('.glob', () => {
       it('returns files using glob method with a single glob', () => {
         const query = FileHound.create()