@putout/operator-filesystem 10.6.0 → 11.0.0

package/README.md

@@ -125,7 +125,7 @@ Anyways inside one plugin while you applying changes related to one plugin you c
 
 ☝️ *`findFile` expensive, when you need to call it often use `crawlDirectory()`*
 
-### `crawlDirectory(directoryPath: directoryPath): CrawledFilesystem`
+### `crawlDirectory(directoryPath: directoryPath): Crawled`
 
 ```js
 import {operator} from 'putout';
@@ -295,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

@@ -103,7 +103,10 @@ function parseFindFileOptions(options) {
 }
 
 export function findFile(node, name, options) {
-    const {exclude = [], crawled = crawlDirectory(node)} = parseFindFileOptions(options);
+    const {
+        exclude = [],
+        crawled = crawlDirectory(node),
+    } = parseFindFileOptions(options);
     
     checkName(name);
     
@@ -490,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.6.0",
+  "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,