file-set - npm Package Compare versions

Comparing version 3.0.0 to 4.0.0

index.js

 /**
- * Breaks an input list of file paths and glob expressions into three categories: files, directories and not existing.
  * @module file-set
- * @example
- * ```js
- * const FileSet = require('file-set')
- * ```
  */
@@ -9,0 +4,0 @@

package.json

 {
   "name": "file-set",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "description": "Expands file paths and glob expressions, returning matched and unmatched files and directories",
@@ -11,3 +11,3 @@ "license": "MIT",
   "engines": {
-    "node": ">=8"
+    "node": ">=10"
   },
@@ -20,9 +20,9 @@ "scripts": {
   "devDependencies": {
-    "jsdoc-to-markdown": "^5.0.2",
-    "test-runner": "^0.6.0"
+    "jsdoc-to-markdown": "^5.0.3",
+    "test-runner": "^0.8.13"
   },
   "dependencies": {
-    "array-back": "^4.0.0",
-    "glob": "^7.1.5"
+    "array-back": "^4.0.1",
+    "glob": "^7.1.6"
   }
 }

README.md

@@ -1,3 +0,3 @@
-[![view on npm](http://img.shields.io/npm/v/file-set.svg)](https://www.npmjs.org/package/file-set)
-[![npm module downloads](http://img.shields.io/npm/dt/file-set.svg)](https://www.npmjs.org/package/file-set)
+[![view on npm](https://badgen.net/npm/v/file-set)](https://www.npmjs.org/package/file-set)
+[![npm module downloads](https://badgen.net/npm/dt/file-set)](https://www.npmjs.org/package/file-set)
 [![Build Status](https://travis-ci.org/75lb/file-set.svg?branch=master)](https://travis-ci.org/75lb/file-set)
@@ -9,26 +9,22 @@ [![Dependency Status](https://badgen.net/david/dep/75lb/file-set)](https://david-dm.org/75lb/file-set)
 
-Breaks an input list of file paths and glob expressions into three categories: files, directories and not existing.
+Expands a list of paths and glob expressions into three sets: "files", "directories" and "not existing". Each set in the output is a list of unique paths.
 
-**Example**  
+## Usage
+
+Expand two glob expressions ('\*' and 'not/existing/\*').
+
 ```js
 const FileSet = require('file-set')
+const fileSet = new FileSet([ '*', 'not/existing/*' ])
+console.log(fileSet)
 ```
 
+The output has been organised into sets.
 
-## Install
-
-```sh
-$ npm install file-set
 ```
-
-## Usage
-
-```js
-> const FileSet = require('file-set');
-
-> new FileSet([ '*', 'not/existing/*' ])
 FileSet {
   files: [ 'LICENSE', 'package.json', 'README.md' ],
   dirs: [ 'jsdoc2md/', 'lib/', 'node_modules/', 'test/' ],
-  notExisting: [ 'not/existing/*' ] }
+  notExisting: [ 'not/existing/*' ]
+}
 ```
@@ -38,8 +34,5 @@
 
-Breaks an input list of file paths and glob expressions into three categories: files, directories and not existing.
+<a name="module_file-set"></a>
 
-**Example**  
-```js
-const FileSet = require('file-set')
-```
+## file-set
 
@@ -98,2 +91,2 @@ * [file-set](#module_file-set)
 
-&copy; 2014-19 Lloyd Brookes \<[e-mail]\>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).
+&copy; 2014-20 Lloyd Brookes \<[e-mail]\>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).

No alert changes

Worsened metrics

Total package byte prevSize

7887

-1.82%

Lines of code

65

-7.14%

Number of lines in readme file

90

-7.22%

Dependency changes

• Updated

  array-back@^4.0.1

• Updated

  glob@^7.1.6