2.0.0

CHANGELOG.md

@@ -1,10 +1,13 @@
-## next
+## 2.0.0 (2022-04-26)
 
-- Boosted performance up to 3 times
+- Boosted performance up to 3-4 times
+- Changed bahaviour of `basedir` to use a single include path when `include` is not provided
+- Changed `extract` option for a file rule to not accept an array of functions
+- Removed exclusion for `node_modules` and `.git` paths by default
 - Added `symlinks` and `errors` fields to result
 - Removed `size` field in a file entry
 - Various fixes and improvements
 
-## 1.0.0 (07-09-2019)
+## 1.0.0 (2019-09-07)
 
 - Initial release

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Roman Dvornov
+Copyright (c) 2019-2022 Roman Dvornov
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -109,16 +109,13 @@ A **rule** is an object with following fields (all are optional):
 
 - **extract**
 
-  Type: `function(file, content, context)` or `Array.<function(file, content, context)>`  
+  Type: `function(file, content, rule)`  
   Default: `[]`
 
   A list of function that extract some data from a file content. Such function takes three arguments:
   - `file` – an instance of File
   - `content` – a buffer contains content of a file
-  - `meta` – object with useful context data:
-    - `basedir` – a value of `options.basedir`
-    - `stats` – `fs.stats()` result object for processing file
-    - `rule` – a normalized rule config that applied
+  - `rule` – rule object with normalized options and `basedir` (as a value of `options.basedir`)
 
 - **only**
 

package.json

@@ -1,15 +1,14 @@
 {
      "name": "@discoveryjs/scan-fs",
-     "version": "1.0.0",
+     "version": "2.0.0",
      "description": "An utility for seeking files by file system scanning and optionally populating file info with processing their content",
      "author": "Roman Dvornov <[email protected]>",
      "license": "MIT",
      "repository": "discoveryjs/scan-fs",
      "keywords": [
           "fs",
-          "files",
           "scan",
-          "preprocessing",
+          "files",
           "rules"
      ],
      "main": "index.js",