harunire 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +72 -0
- package/dist/index.d.mts +2 -0
- package/dist/index.mjs +2122 -0
- package/package.json +43 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 shigurenimo
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
**harunire** (春楡) is a lightweight terminal file viewer with a built-in file tree. For developers running multiple terminal sessions who need quick file browsing without opening a heavy IDE. Not a Vim replacement.
|
|
2
|
+
|
|
3
|
+
> **Note:** This project is currently under development. APIs and features may change.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- **Fast startup** - Opens instantly, faster than launching a code editor
|
|
8
|
+
- **Built-in file tree** - No setup required, tree view is available from the start
|
|
9
|
+
- **Mouse support** - Click to navigate and select files
|
|
10
|
+
- **Compact layout** - File tree overlays the editor, works well in small terminal windows
|
|
11
|
+
- **Minimal design** - Simple viewer for quick file browsing, not a full-featured editor
|
|
12
|
+
|
|
13
|
+
## Quick Start
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
bunx harunire
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Installation
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
bun i -g harunire
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
After installation, use the `nire` command:
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
nire # Open current directory
|
|
29
|
+
nire /path # Open specific directory
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Keyboard Shortcuts
|
|
33
|
+
|
|
34
|
+
### Tree View
|
|
35
|
+
- `Tab` - Switch to editor
|
|
36
|
+
- `j/k` or `Arrow keys` - Navigate
|
|
37
|
+
- `Enter` or `Right` - Open file / Expand directory
|
|
38
|
+
- `Left` - Collapse directory
|
|
39
|
+
- `Esc` - Toggle mouse mode (for text selection)
|
|
40
|
+
- `Ctrl+C` - Quit
|
|
41
|
+
|
|
42
|
+
### Editor View
|
|
43
|
+
- `Tab` - Switch to tree
|
|
44
|
+
- `Arrow keys` - Move cursor
|
|
45
|
+
- `Ctrl+S` - Save
|
|
46
|
+
- `Esc` - Toggle mouse mode
|
|
47
|
+
|
|
48
|
+
### Mouse
|
|
49
|
+
- `Click` - Navigate tree / Move cursor
|
|
50
|
+
- `Scroll` - Vertical scroll
|
|
51
|
+
- `Shift+Scroll` - Horizontal scroll
|
|
52
|
+
- `Shift+Drag` - Select text (for copy)
|
|
53
|
+
|
|
54
|
+
> **Tip:** If `Shift+Drag` doesn't work in your terminal, press `Esc` to switch to KEY mode. This disables mouse tracking and allows normal text selection.
|
|
55
|
+
|
|
56
|
+
## Roadmap
|
|
57
|
+
|
|
58
|
+
- [x] Built-in file tree
|
|
59
|
+
- [x] Mouse support
|
|
60
|
+
- [x] Basic editing
|
|
61
|
+
- [x] IME support
|
|
62
|
+
- [ ] .gitignore support
|
|
63
|
+
- [ ] .vscode settings support
|
|
64
|
+
- [ ] Remember tree state and last opened file
|
|
65
|
+
- [ ] Vim-like keybindings
|
|
66
|
+
- [ ] Search in file tree
|
|
67
|
+
- [ ] Search in file content
|
|
68
|
+
- [ ] Syntax highlighting
|
|
69
|
+
|
|
70
|
+
## License
|
|
71
|
+
|
|
72
|
+
MIT
|
package/dist/index.d.mts
ADDED