@danixl30/file-explorer-cli 1.0.0

package/dist/file-display/logic/operations.manager.js

@@ -0,0 +1,103 @@
+export const operationsManager = (fileManager, clipboard, pasteOperation, deleteNode, renameNode, createDir, executeCommandSync, executeCommandAsync, moveToTrash) => {
+    const paste = async (replace) => {
+        if (!clipboard.item.value)
+            return;
+        if (fileManager.files.value?.some((e) => e.type === 'DRIVE'))
+            throw new Error(`Can't past outside a drive`);
+        await pasteOperation(clipboard.item.value, fileManager.path.value, replace);
+        clipboard.removeItem();
+        fileManager.cleanNodeSelected();
+        fileManager.refresh();
+    };
+    const copy = (node) => {
+        if (node.type === 'DRIVE')
+            return;
+        clipboard.setItem({
+            items: fileManager.selections.value.length === 0
+                ? [node]
+                : fileManager.selections.value,
+            opeation: 'COPY',
+        });
+    };
+    const cut = (node) => {
+        if (node.type === 'DRIVE')
+            return;
+        clipboard.setItem({
+            items: fileManager.selections.value.length === 0
+                ? [node]
+                : fileManager.selections.value,
+            opeation: 'COPY',
+        });
+    };
+    const removeNode = async (node) => {
+        const clipboardItem = clipboard.item.value;
+        if (fileManager.selections.value.length > 0) {
+            if (clipboardItem?.items.some((e) => fileManager.selections.value.some((node) => e.path === node.path)))
+                throw new Error(`Can't delete the item that you set on clipboard`);
+            if (fileManager.selections.value.some((e) => e.type === 'DRIVE'))
+                throw new Error('you can not remove a drive');
+            await Promise.all(fileManager.selections.value.map((node) => deleteNode(node)));
+            fileManager.refresh();
+            return;
+        }
+        if (clipboardItem?.items.some((e) => e.path === node.path))
+            throw new Error(`Can't delete the item that you set on clipboard`);
+        if (node.type === 'DRIVE')
+            throw new Error('you can not remove a drive');
+        await deleteNode(node);
+        fileManager.cleanNodeSelected();
+        fileManager.refresh();
+    };
+    const moveNodeToTrash = async (node) => {
+        const clipboardItem = clipboard.item.value;
+        if (fileManager.selections.value.length > 0) {
+            if (clipboardItem?.items.some((e) => fileManager.selections.value.some((node) => e.path === node.path)))
+                throw new Error(`Can't delete the item that you set on clipboard`);
+            if (fileManager.selections.value.some((e) => e.type === 'DRIVE'))
+                throw new Error('you can not remove a drive');
+            await Promise.all(fileManager.selections.value.map((node) => moveNodeToTrash(node)));
+            fileManager.refresh();
+            return;
+        }
+        if (clipboardItem?.items.some((e) => e.path === node.path))
+            throw new Error(`Can't delete the item that you set on clipboard`);
+        if (node.type === 'DRIVE')
+            throw new Error('you can not remove a drive');
+        await moveToTrash(node);
+        fileManager.cleanNodeSelected();
+        fileManager.refresh();
+    };
+    const rename = async (node, newName) => {
+        const clipboardItem = clipboard.item.value;
+        if (clipboardItem?.items.some((e) => e.path === node.path))
+            throw new Error(`Can't rename item that you set on clipboard`);
+        if (node.type === 'DRIVE')
+            throw new Error('you can not rename a drive');
+        await renameNode(node, newName);
+        fileManager.cleanNodeSelected();
+        fileManager.refresh();
+    };
+    const createDirectory = async (name) => {
+        if (fileManager.files.value?.some((e) => e.type === 'DRIVE'))
+            throw new Error(`Can't create a folder outside a drive`);
+        await createDir(fileManager.path.value, name);
+        fileManager.refresh();
+    };
+    const runCommandAsync = async (command) => executeCommandAsync(fileManager.path.value, command);
+    const runCommandSync = async (command) => {
+        const data = await executeCommandSync(fileManager.path.value, command);
+        fileManager.refresh();
+        return data;
+    };
+    return {
+        paste,
+        copy,
+        rename,
+        removeNode,
+        createDirectory,
+        cut,
+        runCommandAsync,
+        runCommandSync,
+        moveNodeToTrash,
+    };
+};

package/dist/file-display/services/create.dir.js

@@ -0,0 +1 @@
+export {};

package/dist/file-display/services/delete.js

@@ -0,0 +1 @@
+export {};

package/dist/file-display/services/execute.command.async.js

@@ -0,0 +1 @@
+export {};

package/dist/file-display/services/execute.command.sync.js

@@ -0,0 +1 @@
+export {};

package/dist/file-display/services/execute.file.js

@@ -0,0 +1 @@
+export {};

package/dist/file-display/services/filter.glob.js

@@ -0,0 +1 @@
+export {};

package/dist/file-display/services/get.all.files.js

@@ -0,0 +1 @@
+export {};

package/dist/file-display/services/get.directory.js

@@ -0,0 +1 @@
+export {};

package/dist/file-display/services/get.upper.directory.js

@@ -0,0 +1 @@
+export {};

package/dist/file-display/services/move.trash.js

@@ -0,0 +1 @@
+export {};

package/dist/file-display/services/node.details.js

@@ -0,0 +1 @@
+export {};

package/dist/file-display/services/paste.operation.js

@@ -0,0 +1 @@
+export {};

package/dist/file-display/services/remane.js

@@ -0,0 +1 @@
+export {};

package/dist/file-display/types/node.details.js

@@ -0,0 +1 @@
+export {};

package/dist/file-display/types/node.js

@@ -0,0 +1 @@
+export {};

package/dist/file-display/utils/icon.parser.js

@@ -0,0 +1,144 @@
+const dirIcons = (node) => {
+    if (node.name === 'test' || node.name === 'tests')
+        return '󰙨 ';
+    if (node.name === 'node_modules')
+        return ' ';
+    if (node.name === '.git')
+        return ' ';
+    if (node.name === 'src')
+        return ' ';
+    if (node.name === '.vscode')
+        return ' ';
+    if (node.name === '.aws')
+        return ' ';
+    if (node.name === '.docker')
+        return ' ';
+    if (node.name === '.config')
+        return ' ';
+    if (node.name === 'Documents' || node.name === 'docs')
+        return ' ';
+    if (node.name === 'Downloads')
+        return '󰉍 ';
+    if (node.name === 'Desktop')
+        return '󰧨 ';
+    if (node.name.toLowerCase() === 'music')
+        return '󱍙 ';
+    if (node.name.toLowerCase() === 'pictures' ||
+        node.name.toLowerCase() === 'picture')
+        return '󰉏 ';
+    if (node.name.toLowerCase() === 'videos' ||
+        node.name.toLowerCase() === 'video')
+        return ' ';
+    if (node.name === 'bin')
+        return ' ';
+    return ' ';
+};
+const fileIcons = (node) => {
+    if (node.name === 'package.json' ||
+        node.name === '.nvmrc' ||
+        node.name === '.node-version')
+        return ' ';
+    if (node.name === 'Dockerfile' ||
+        node.name === '.dockerignore' ||
+        node.name === 'docker-compose.yml')
+        return ' ';
+    if (node.name === '.gitignore' || node.name === '.gitattributes')
+        return ' ';
+    if (node.name.toLowerCase() === 'readme.md')
+        return ' ';
+    if (node.name.endsWith('.key') || node.name.endsWith('.gpg'))
+        return ' ';
+    if (node.name.endsWith('.ts'))
+        return ' ';
+    if (node.name.endsWith('.c'))
+        return ' ';
+    if (node.name.endsWith('.exe'))
+        return 'ﬓ ';
+    if (node.name.endsWith('.sln'))
+        return ' ';
+    if (node.name.endsWith('.cs'))
+        return ' ';
+    if (node.name.endsWith('.js'))
+        return ' ';
+    if (node.name.endsWith('.txt'))
+        return ' ';
+    if (node.name.endsWith('.zip') ||
+        node.name.endsWith('.rar') ||
+        node.name.endsWith('.7z'))
+        return ' ';
+    if (node.name.endsWith('.cpp'))
+        return ' ';
+    if (node.name.endsWith('.html'))
+        return ' ';
+    if (node.name.endsWith('.png') ||
+        node.name.endsWith('.jpg') ||
+        node.name.endsWith('.jpeg') ||
+        node.name.endsWith('.gif') ||
+        node.name.endsWith('.bmp') ||
+        node.name.endsWith('.cur') ||
+        node.name.endsWith('.tiff') ||
+        node.name.endsWith('.svg'))
+        return ' ';
+    if (node.name.endsWith('.java'))
+        return ' ';
+    if (node.name.endsWith('.bat'))
+        return ' ';
+    if (node.name.endsWith('.md'))
+        return ' ';
+    if (node.name.endsWith('.kt'))
+        return ' ';
+    if (node.name.endsWith('.php'))
+        return ' ';
+    if (node.name.endsWith('.json'))
+        return ' ';
+    if (node.name.endsWith('.py'))
+        return ' ';
+    if (node.name.endsWith('.lock'))
+        return ' ';
+    if (node.name.endsWith('.toml') || node.name.endsWith('.ini'))
+        return ' ';
+    if (node.name.endsWith('.rs'))
+        return ' ';
+    if (node.name.endsWith('.sql'))
+        return '.sql';
+    if (node.name.endsWith('.zig'))
+        return ' ';
+    if (node.name.endsWith('.tsx') || node.name.endsWith('.jsx'))
+        return ' ';
+    if (node.name.endsWith('.pdf'))
+        return ' ';
+    if (node.name.endsWith('.docx'))
+        return ' ';
+    if (node.name.endsWith('.doc'))
+        return '󱎒 ';
+    if (node.name.endsWith('.xls') || node.name.endsWith('.xlsx'))
+        return '󱎒 ';
+    if (node.name.endsWith('.ppt') || node.name.endsWith('.pptx'))
+        return '󱎐 ';
+    if (node.name.endsWith('.psd'))
+        return ' ';
+    if (node.name.endsWith('.css'))
+        return ' ';
+    if (node.name.endsWith('.dll'))
+        return ' ';
+    if (node.name.endsWith('.mp3') ||
+        node.name.endsWith('.ma4') ||
+        node.name.endsWith('.wav') ||
+        node.name.endsWith('.mp3'))
+        return ' ';
+    if (node.name.endsWith('.mkv') ||
+        node.name.endsWith('.mp4') ||
+        node.name.endsWith('.avi'))
+        return ' ';
+    if (node.name.endsWith('.log'))
+        return ' ';
+    return ' ';
+};
+const driveIcon = (_node) => {
+    return ' ';
+};
+export const getNodeIcon = (node) => node.type === 'DIR'
+    ? dirIcons(node)
+    : node.type === 'FILE'
+        ? fileIcons(node)
+        : driveIcon(node);

package/dist/input-capture/InputCapureWrapper.js

@@ -0,0 +1,10 @@
+import { Box, Text } from 'ink';
+import React, { useContext } from 'react';
+import { InputContextCapture } from './InputContextCapture.js';
+export const InputCaptureWarpper = () => {
+    const inputCapture = useContext(InputContextCapture);
+    if (!inputCapture.isInputEnabled)
+        return React.createElement(React.Fragment, null);
+    return (React.createElement(Box, { borderStyle: "classic" },
+        React.createElement(Text, null, inputCapture.text)));
+};

package/dist/input-capture/InputContextCapture.js

@@ -0,0 +1,26 @@
+import { useInput } from 'ink';
+import React, { createContext, useRef, useState } from 'react';
+export const InputContextCapture = createContext(undefined);
+export const InputContextCaptureProvider = (props) => {
+    const callback = useRef(undefined);
+    const [isInputEnabled, setInputEnable] = useState(false);
+    const [text, setText] = useState('');
+    const addCallback = (c, text) => {
+        callback.current = c;
+        setInputEnable(true);
+        setText(text);
+    };
+    useInput((input) => {
+        if (!isInputEnabled)
+            return;
+        callback.current?.(input);
+        callback.current = undefined;
+        setInputEnable(false);
+        setText('');
+    });
+    return (React.createElement(InputContextCapture.Provider, { value: {
+            addCallback,
+            text,
+            isInputEnabled,
+        } }, props.children));
+};

package/dist/tabs/TabsContext.js

@@ -0,0 +1,17 @@
+import React, { createContext, useContext } from 'react';
+import { EventContext } from '../core/infraestructure/event-handler/context/EventProvider.js';
+import { useEffectOnInit } from '../core/infraestructure/on-init/useEffectOnInit.js';
+import { useRefStateFactory } from '../core/infraestructure/state/useRefStateProvider.js';
+import { useRefValueProvider } from '../core/infraestructure/value-provider/useRefValueProvider.js';
+import { tabsManagerLogic } from './logic/tabsManagerLogic.js';
+export const TabsContext = createContext(undefined);
+export const TabsContextProvider = (props) => {
+    const data = tabsManagerLogic(useRefStateFactory(), useRefValueProvider(), () => ({
+        path: props.defaultPath,
+        history: {
+            previous: [],
+            forward: [],
+        },
+    }), useEffectOnInit, useContext(EventContext));
+    return (React.createElement(TabsContext.Provider, { value: data }, props.children));
+};

package/dist/tabs/events/update.tab.data.js

@@ -0,0 +1,8 @@
+import { randomUUID } from 'node:crypto';
+export const UPDATE_TAB_DATA = 'UPDATE_TAB_DATA';
+export const createUpdateTabDataEvent = (data) => ({
+    ...data,
+    id: randomUUID(),
+    name: UPDATE_TAB_DATA,
+    timestamp: new Date(),
+});

package/dist/tabs/events/update.tab.selection.js

@@ -0,0 +1,8 @@
+import { randomUUID } from 'node:crypto';
+export const createUpdateTabSelectionEvent = (selection) => ({
+    selection,
+    id: randomUUID(),
+    name: UPDATE_TAB_SELECTION,
+    timestamp: new Date(),
+});
+export const UPDATE_TAB_SELECTION = 'UPDATE_TAB_SELECTION';

package/dist/tabs/logic/tabsManagerLogic.js

@@ -0,0 +1,58 @@
+import { UPDATE_TAB_DATA } from '../events/update.tab.data.js';
+import { UPDATE_TAB_SELECTION, } from '../events/update.tab.selection.js';
+export const tabsManagerLogic = (stateFactory, valueProvider, createTab, onInit, eventHandler) => {
+    const tabsState = stateFactory([createTab()]);
+    const selectionInTabs = valueProvider([]);
+    const indexState = stateFactory(0);
+    const updateTabData = (tabData) => {
+        tabsState.setState(tabsState.state.value.map((e, index) => indexState.state.value === index ? tabData : e));
+    };
+    const addTab = (tab) => {
+        selectionInTabs.value.push([]);
+        tabsState.setState([...tabsState.state.value, tab ?? createTab()]);
+        indexState.setState(tabsState.state.value.length - 1);
+    };
+    const removeTab = (index) => {
+        selectionInTabs.value = selectionInTabs.value.filter((_e, i) => index !== i);
+        tabsState.setState(tabsState.state.value.filter((_e, i) => index !== i));
+        if (index >= tabsState.state.value.length)
+            indexState.setState(tabsState.state.value.length - 1);
+    };
+    const moveToNext = () => {
+        if (tabsState.state.value.length === 1)
+            return;
+        if (indexState.state.value === tabsState.state.value.length - 1)
+            indexState.setState(0);
+        else
+            indexState.setState(indexState.state.value + 1);
+    };
+    const moveToPrev = () => {
+        if (tabsState.state.value.length === 1)
+            return;
+        if (indexState.state.value === 0)
+            indexState.setState(tabsState.state.value.length - 1);
+        else
+            indexState.setState(indexState.state.value - 1);
+    };
+    onInit(() => {
+        eventHandler.subscribe(UPDATE_TAB_DATA, (data) => {
+            updateTabData({
+                path: data.path,
+                history: data.history,
+            });
+        });
+        eventHandler.subscribe(UPDATE_TAB_SELECTION, (data) => {
+            selectionInTabs.value[indexState.state.value] = data.selection;
+        });
+    });
+    return {
+        moveToPrev,
+        moveToNext,
+        removeTab,
+        addTab,
+        updateTabData,
+        index: indexState.state,
+        tabs: tabsState.state,
+        selectionInTabs,
+    };
+};

package/dist/tabs/wrapper/tabs.wrapper.js

@@ -0,0 +1,38 @@
+import { Box, Text, useInput } from 'ink';
+import React, { useContext, useEffect, useState } from 'react';
+import { Bookmark } from '../../bookmark/Bookmark.js';
+import FileDisplay from '../../file-display/FileDisplay.js';
+import { InputContextCapture } from '../../input-capture/InputContextCapture.js';
+import { TextFieldContextCapture } from '../../text-field/TextFieldCaptureContext.js';
+import { TabsContext } from '../TabsContext.js';
+export default function TabsWrapper() {
+    const tabs = useContext(TabsContext);
+    const inputCapture = useContext(InputContextCapture);
+    const textField = useContext(TextFieldContextCapture);
+    const [childKey, setChildKey] = useState(0);
+    useInput((input, key) => {
+        if (inputCapture.isInputEnabled || textField.isInputEnabled)
+            return;
+        if (key.tab)
+            tabs.moveToNext();
+        if (key.tab && key.shift)
+            tabs.moveToPrev();
+        if (input === 't' && key.ctrl)
+            tabs.addTab();
+        if (input === 'w' && key.ctrl)
+            tabs.removeTab(tabs.index.value);
+    });
+    useEffect(() => {
+        setChildKey((prev) => ++prev);
+    }, [tabs.tabs.value, tabs.index.value]);
+    return (React.createElement(React.Fragment, null,
+        React.createElement(Box, { flexDirection: "row" },
+            React.createElement(Bookmark, null),
+            React.createElement(Box, { height: "100%", flexDirection: "column" },
+                tabs.tabs.value.length > 1 && (React.createElement(Box, { width: "100%", flexDirection: "row" }, tabs.tabs.value.map((_e, index) => (React.createElement(Box, { borderStyle: "round", borderColor: index === tabs.index.value
+                        ? 'blue'
+                        : 'white' },
+                    React.createElement(Text, null, `Tab: ${index + 1}`)))))),
+                tabs.index.value < tabs.tabs.value.length &&
+                    tabs.index.value !== -1 && (React.createElement(FileDisplay, { selection: tabs.selectionInTabs.value[tabs.index.value] ?? [], key: childKey, initialData: tabs.tabs.value[tabs.index.value] }))))));
+}

package/dist/text-field/TextFieldCaptureContext.js

@@ -0,0 +1,24 @@
+import React, { createContext, useRef, useState } from 'react';
+export const TextFieldContextCapture = createContext(undefined);
+export const TextFieldContextCaptureProvider = (props) => {
+    const textFieldData = useRef(undefined);
+    const [isInputEnabled, setInputEnable] = useState(false);
+    const [error, setError] = useState('');
+    const addCallback = (data) => {
+        textFieldData.current = data;
+        setInputEnable(true);
+    };
+    const cleanUp = () => {
+        textFieldData.current = undefined;
+        setInputEnable(false);
+        setError('');
+    };
+    return (React.createElement(TextFieldContextCapture.Provider, { value: {
+            addCallback,
+            isInputEnabled,
+            error,
+            setError,
+            data: textFieldData.current,
+            cleanUp,
+        } }, props.children));
+};

package/dist/text-field/TextFieldWrapper.js

@@ -0,0 +1,21 @@
+import { StatusMessage, TextInput } from '@inkjs/ui';
+import { Box, useInput } from 'ink';
+import React, { useContext } from 'react';
+import { TextFieldContextCapture } from './TextFieldCaptureContext.js';
+export const TextFieldWrapper = () => {
+    const textField = useContext(TextFieldContextCapture);
+    useInput((_input, key) => {
+        if (key.escape)
+            textField.cleanUp();
+    });
+    if (!textField.isInputEnabled)
+        return React.createElement(React.Fragment, null);
+    return (React.createElement(Box, { borderStyle: "classic", flexDirection: "column", gap: 1 },
+        React.createElement(TextInput, { defaultValue: textField.data?.defaultValue, onChange: textField.data?.callback.onChange, placeholder: textField.data?.placeHolder, onSubmit: (data) => {
+                textField.cleanUp();
+                if (!textField.error)
+                    textField.data?.callback.onSuccess(data);
+            } }),
+        textField.data?.text && !textField.error && (React.createElement(StatusMessage, { variant: "info" }, textField.data.text)),
+        textField.error && (React.createElement(StatusMessage, { variant: "error" }, textField.error))));
+};

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@danixl30/file-explorer-cli",
+  "version": "1.0.0",
+  "license": "MIT",
+  "bin": {
+    "files": "dist/cli.js"
+  },
+  "type": "module",
+  "engines": {
+    "node": ">=16"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@inkjs/ui": "^2.0.0",
+    "clipboardy": "^4.0.0",
+    "drivelist": "^12.0.2",
+    "fullscreen-ink": "^0.0.2",
+    "ink": "^4.1.0",
+    "lowdb": "^7.0.1",
+    "meow": "^11.0.0",
+    "minimatch": "^10.0.1",
+    "node-disk-info": "^1.3.0",
+    "react": "^18.2.0",
+    "trash": "^9.0.0"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^1.9.4",
+    "@sindresorhus/tsconfig": "^3.0.1",
+    "@types/node": "^22.9.0",
+    "@types/react": "^18.0.32",
+    "ava": "^5.2.0",
+    "chalk": "^5.2.0",
+    "ink-testing-library": "^3.0.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.3",
+    "xo": "^0.53.1"
+  },
+  "ava": {
+    "extensions": {
+      "ts": "module",
+      "tsx": "module"
+    },
+    "nodeArguments": [
+      "--loader=ts-node/esm"
+    ]
+  },
+  "xo": {
+    "extends": "xo-react",
+    "prettier": true,
+    "rules": {
+      "react/prop-types": "off"
+    }
+  },
+  "scripts": {
+    "lint": "pnpm biome check --write src/",
+    "build": "tsc",
+    "start": "tsc && node dist/cli",
+    "dev": "tsc --watch"
+  }
+}

package/readme.md

@@ -0,0 +1,57 @@
+# CLI file explorer
+
+Simple CLI file explorer with NodeJs
+
+## Install
+
+```bash
+$ npm install -g @danixl30/cli-file-explorer
+```
+
+## CLI
+
+```
+$ files --help
+```
+
+## Usage
+
+Use ```UP``` and ```DOWN``` key to move the cursor at the directory.
+
+Use ```CTRL + t``` to create a new tab. If the cursor in on a directory press ```t``` to create a new tab with that directory.
+
+User ```CRTL + w``` to close current tab.
+
+Use ```TAB``` and ```SHIFT + TAB``` to change tabs.
+
+Use ```RIGHT``` to select files or directories. ```SHIFT + RIGHT``` to unselect. ```SHIFT + i``` to invert selection. ```SHIFT + a``` to selcet all.
+
+Use ```c``` to copy the item in the cursor or copy current selection.
+
+Use ```SHIFT + c``` to cut the item in the cursor or cut current selection.
+
+Use ```p``` to paste items copied or cut. ```SHIFT + p``` to past and override if exist.
+
+Use ```d``` and confirm with ```y``` to move file or dir to trash. ```SHIFT + d``` to romeve item, confirm with ```SHIFT + y```.
+
+Use ```r``` to refresh current tab.
+
+Use ```SHIFT + r``` to rename file or dir that is on cursor.
+
+Use ```g``` to select items in dir by glob pattern.
+
+Use ```CTRL + l``` to set path o current tab.
+
+Use ```i``` to see details of item that is on cursor.
+
+Use ```CTRL + d``` to close details pane.
+
+Use ```;``` to set not blocking command.
+
+Use ```:``` to set blocking command.
+
+Use ```SHITF + s``` to add dir that is on cursor to bookmarks.
+
+Use ```s``` to switch to bookmarks pane.
+
+Use ```a``` to create a directory in current tab.