mirror of
https://github.com/softinio/Fishee.git
synced 2025-02-22 13:36:04 -08:00
Update README and update tests that need to run sequencially
This commit is contained in:
parent
1039b04378
commit
794c99a71c
3 changed files with 46 additions and 2 deletions
45
README.md
45
README.md
|
@ -1,3 +1,46 @@
|
||||||
# Fishee
|
# Fishee
|
||||||
|
|
||||||
Fishee CLI Tool for Fish Shell
|
Fishee CLI Tool for Fish Shell
|
||||||
|
|
||||||
|
## About Fishee
|
||||||
|
|
||||||
|
So I have been a user of Fish Shell for quite a while now and really enjoy using it.
|
||||||
|
|
||||||
|
So I decided to write this CLI tool for Fish Shell that helps me manage my fish history.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- Print my fish history
|
||||||
|
- Merge two history files into one
|
||||||
|
- Useful for when you want to add fish history from one computer to another
|
||||||
|
- remove duplicates from history file when merging
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
In terminal run:
|
||||||
|
|
||||||
|
```
|
||||||
|
fishee --help
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
USAGE: fishee [--history-file <history-file>] [--merge-file <merge-file>] [--output-file <output-file>] [--dry-run] [--remove-duplicates] [--backup] [--no-backup]
|
||||||
|
|
||||||
|
OPTIONS:
|
||||||
|
-f, --history-file <history-file>
|
||||||
|
Location of your fish history file. Will default to
|
||||||
|
~/.local/share/fish/fish_history
|
||||||
|
-m, --merge-file <merge-file>
|
||||||
|
File path to file to merge with history file.
|
||||||
|
-w, --output-file <output-file>
|
||||||
|
File to write to. Default: same as current history
|
||||||
|
file.
|
||||||
|
-d, --dry-run Dry run. Will only print to the console without
|
||||||
|
actually modifying the history file.
|
||||||
|
-r, --remove-duplicates Remove duplicates from combined history. Default:
|
||||||
|
false
|
||||||
|
-b, --backup/--no-backup
|
||||||
|
Backup fish history file given before writing.
|
||||||
|
(default: --backup)
|
||||||
|
-h, --help
|
||||||
|
```
|
||||||
|
|
|
@ -19,6 +19,7 @@ import Testing
|
||||||
@testable import Fishee
|
@testable import Fishee
|
||||||
|
|
||||||
|
|
||||||
|
@Suite(.serialized)
|
||||||
final class FileHelpersTests {
|
final class FileHelpersTests {
|
||||||
let filePath = FileManager.default.homeDirectoryForCurrentUser.appendingPathComponent("myfile.txt")
|
let filePath = FileManager.default.homeDirectoryForCurrentUser.appendingPathComponent("myfile.txt")
|
||||||
|
|
||||||
|
|
|
@ -18,7 +18,7 @@ import Foundation
|
||||||
import Testing
|
import Testing
|
||||||
@testable import Fishee
|
@testable import Fishee
|
||||||
|
|
||||||
@Suite
|
@Suite(.serialized)
|
||||||
final class ParserTests {
|
final class ParserTests {
|
||||||
let fishHistoryFile = Bundle.module.path(forResource: "fish_history_test", ofType: "txt")
|
let fishHistoryFile = Bundle.module.path(forResource: "fish_history_test", ofType: "txt")
|
||||||
let historyItem = FishHistoryEntry(cmd: "cd Projects/Fishee/", when: 1727545693, paths: ["Projects/Fishee/"])
|
let historyItem = FishHistoryEntry(cmd: "cd Projects/Fishee/", when: 1727545693, paths: ["Projects/Fishee/"])
|
||||||
|
|
Loading…
Reference in a new issue