reviw 0.7.0 → 0.7.1
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/README.md +47 -13
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,16 +1,34 @@
|
|
|
1
1
|
# reviw
|
|
2
2
|
|
|
3
|
-
A lightweight browser-based tool for reviewing and annotating tabular data, text, and
|
|
3
|
+
A lightweight browser-based tool for reviewing and annotating tabular data, text, Markdown, and diff files. Supports CSV, TSV, plain text, Markdown, and unified diff formats. Comments are output as YAML to stdout.
|
|
4
4
|
|
|
5
5
|
## Features
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
- **
|
|
9
|
-
- **
|
|
7
|
+
### File Format Support
|
|
8
|
+
- **CSV/TSV**: View tabular data with sticky headers, column freezing, filtering, and column resizing
|
|
9
|
+
- **Markdown**: Side-by-side preview with synchronized scrolling
|
|
10
|
+
- **Diff/Patch**: GitHub-style diff view with syntax highlighting, collapsible large files (500+ lines), and binary files sorted to end
|
|
11
|
+
- **Text**: Line-by-line commenting for plain text files
|
|
12
|
+
|
|
13
|
+
### Mermaid.js Diagrams
|
|
14
|
+
- Auto-detect and render Mermaid diagrams in Markdown files
|
|
15
|
+
- Click any diagram to open fullscreen viewer
|
|
16
|
+
- Zoom with mouse wheel (centered on cursor position, up to 10x)
|
|
17
|
+
- Pan with mouse drag
|
|
18
|
+
- Minimap showing current viewport position
|
|
19
|
+
- Syntax error display in toast notifications
|
|
20
|
+
|
|
21
|
+
### UI Features
|
|
22
|
+
- **Theme toggle**: Switch between light and dark modes
|
|
10
23
|
- **Multi-file support**: Open multiple files simultaneously on separate ports
|
|
11
24
|
- **Drag selection**: Select rectangular regions or multiple rows for batch comments
|
|
12
|
-
- **Real-time**: Hot reload on file changes via SSE
|
|
13
|
-
- **
|
|
25
|
+
- **Real-time updates**: Hot reload on file changes via SSE
|
|
26
|
+
- **Comment persistence**: Auto-save comments to localStorage with recovery modal
|
|
27
|
+
- **Keyboard shortcuts**: Cmd/Ctrl+Enter to open submit modal
|
|
28
|
+
|
|
29
|
+
### Output
|
|
30
|
+
- YAML format with file, mode, row, col, value, and comment text
|
|
31
|
+
- Overall summary field for review notes
|
|
14
32
|
|
|
15
33
|
## Installation
|
|
16
34
|
|
|
@@ -32,24 +50,39 @@ reviw <file> [--port 3000] [--encoding utf8|shift_jis|...]
|
|
|
32
50
|
|
|
33
51
|
# Multiple files (each opens on consecutive ports)
|
|
34
52
|
reviw file1.csv file2.md file3.tsv --port 3000
|
|
53
|
+
|
|
54
|
+
# Diff from stdin
|
|
55
|
+
git diff HEAD | reviw
|
|
56
|
+
|
|
57
|
+
# Diff file
|
|
58
|
+
reviw changes.diff
|
|
35
59
|
```
|
|
36
60
|
|
|
37
|
-
|
|
38
|
-
-
|
|
39
|
-
-
|
|
40
|
-
-
|
|
41
|
-
|
|
61
|
+
### Options
|
|
62
|
+
- `--port <number>`: Specify starting port (default: 3000)
|
|
63
|
+
- `--encoding <encoding>`: Force specific encoding (auto-detected by default)
|
|
64
|
+
- `--no-open`: Prevent automatic browser opening
|
|
65
|
+
|
|
66
|
+
### Workflow
|
|
67
|
+
1. Browser opens automatically (macOS: `open` / Linux: `xdg-open` / Windows: `start`)
|
|
68
|
+
2. Click cells/lines to add comments, or drag to select multiple
|
|
69
|
+
3. Use Cmd/Ctrl+Enter or click "Submit & Exit" to output comments
|
|
70
|
+
4. Comments are printed as YAML to stdout
|
|
42
71
|
|
|
43
72
|
## Screenshots
|
|
44
73
|
|
|
45
74
|
### CSV View
|
|
46
|
-
|
|
47
75
|

|
|
48
76
|
|
|
49
77
|
### Markdown View
|
|
50
|
-
|
|
51
78
|

|
|
52
79
|
|
|
80
|
+
### Diff View
|
|
81
|
+

|
|
82
|
+
|
|
83
|
+
### Mermaid Fullscreen
|
|
84
|
+

|
|
85
|
+
|
|
53
86
|
## Output Example
|
|
54
87
|
|
|
55
88
|
```yaml
|
|
@@ -62,6 +95,7 @@ comments:
|
|
|
62
95
|
col: 3
|
|
63
96
|
text: This value needs review
|
|
64
97
|
value: '150'
|
|
98
|
+
summary: Overall the data looks good, minor issues noted above.
|
|
65
99
|
```
|
|
66
100
|
|
|
67
101
|
## Development
|