@putout/operator-filesystem 10.5.1 → 10.6.0

package/README.md

@@ -83,6 +83,8 @@ readDirectory(dirPath);
 
 ### `findFile(directoryPath: DirectoryPath, name: string | string[], exclude?: string[]): (FilePath | DirectoryPath)[]`
 
+Traverse filesystem to search one or more files:
+
 ```js
 const {operator} = require('putout');
 const {findFile} = operator;
@@ -115,7 +117,25 @@ And even search for a directory:
 import {operator} from 'putout';
 
 const {findFile} = operator;
-const coupleFiles = findFile(ast, ['/home/coderaiser', '/home/coderaiser/putout']);
+const coupleFiles = findFile(root, ['/home/coderaiser', '/home/coderaiser/putout']);
+```
+
+Each 🐊**Putout** plugin should use `findFile` independently since AST can change: files renamed, removed etc.
+Anyways inside one plugin while you applying changes related to one plugin you can speed things drastically crawling file system once. It works good if plugin do not mutates the file tree, only file content.
+
+☝️ *`findFile` expensive, when you need to call it often use `crawlDirectory()`*
+
+### `crawlDirectory(directoryPath: directoryPath): CrawledFilesystem`
+
+```js
+import {operator} from 'putout';
+
+const {findFile} = operator;
+const crawled = crawlDirectory(rootPath);
+
+const [file] = findFile(root, 'hello', {
+    crawled,
+});
 ```
 
 ### `getFile(directoryPath: DirectoryPath, name: string | string[], options?: Options): FilePath[]`

package/lib/filesystem.js

@@ -86,13 +86,31 @@ function isExcluded({name, base, exclude}) {
     return false;
 }
 
-export function findFile(node, name, exclude = []) {
+export const crawlDirectory = (a) => traverseProperties(a, 'filename');
+
+function parseFindFileOptions(options) {
+    if (!options)
+        return {
+            excluded: [],
+        };
+    
+    if (isArray(options))
+        return {
+            exclude: options,
+        };
+    
+    return options;
+}
+
+export function findFile(node, name, options) {
+    const {exclude = [], crawled = crawlDirectory(node)} = parseFindFileOptions(options);
+    
     checkName(name);
     
     const filePaths = [];
     const names = maybeArray(name);
     
-    for (const filenamePath of traverseProperties(node, 'filename')) {
+    for (const filenamePath of crawled) {
         const {value} = filenamePath.node.value;
         const base = basename(value);
         

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@putout/operator-filesystem",
-  "version": "10.5.1",
+  "version": "10.6.0",
   "type": "module",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "🐊Putout operator adds ability to filesystem referenced variables that was not defined",