@putout/operator-filesystem 10.5.1 → 11.0.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): Crawled`
+
+```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[]`
@@ -275,6 +295,54 @@ Since `basename` is used.
 
 To move file use [`moveFile()`](#movefilefilepath-filepath-dirpath-filepath).
 
+### `inject`
+
+Inject filesystem API with methods:
+
+- ✅ `renameFile`;
+- ✅ `copyFile`;
+- ✅ `removeFile;
+- ✅ `createDirectory;
+- ✅ `readFileContent;
+- ✅ `writeFileContent;
+
+To have ability to interact with any kind of filesystem representation.
+
+```js
+import {inject} from '@putout/operator-filesystem/maybe';
+import * as filesystemCLI from '@putout/cli-filesystem';
+
+inject(filesystemCLI);
+```
+
+### `eject`
+
+```js
+import {eject} from '@putout/operator-filesystem/maybe';
+
+eject();
+```
+
+### `pause`
+
+Pause currently injected filesystem API
+
+```js
+import {pause} from '@putout/operator-filesystem/maybe';
+
+pause();
+```
+
+### `start`
+
+Start currently paused injected filesystem API.
+
+```js
+import {start} from '@putout/operator-filesystem/maybe';
+
+start();
+```
+
 ## Example
 
 ```js

package/lib/filesystem.js

@@ -86,13 +86,34 @@ 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);
         
@@ -472,10 +493,3 @@ export function getFile(directoryPath, name, {type} = {}) {
     
     return files.values();
 }
-
-export const {
-    init,
-    deinit,
-    pause,
-    start,
-} = maybeFS;

package/lib/maybe-fs.js

@@ -41,19 +41,19 @@ export const writeFileContent = (name, content) => {
     maybeFS.writeFileContent(name, content);
 };
 
-export function init(fsDriver) {
+export const inject = (fsDriver) => {
     assign(maybeFS, fsDriver);
-}
+};
 
 export const pause = () => {
     driverStore(maybeFS);
-    deinit();
+    eject();
 };
 
 export const start = () => {
-    init(driverStore());
+    inject(driverStore());
 };
 
-export function deinit() {
+export function eject() {
     assign(maybeFS, defaultFS);
 }

package/package.json

@@ -1,11 +1,15 @@
 {
   "name": "@putout/operator-filesystem",
-  "version": "10.5.1",
+  "version": "11.0.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",
   "homepage": "https://github.com/coderaiser/putout/tree/master/packages/operator-filesystem#readme",
   "main": "lib/filesystem.js",
+  "exports": {
+    ".": "./lib/filesystem.js",
+    "./maybe": "./lib/maybe-fs.js"
+  },
   "release": false,
   "tag": false,
   "changelog": false,