Skip to content

Commit d27307a

Browse files
LuckiLucki
committed
Add edit command option
This commit adds an "edit" subcommand for Mod Manager that allows users to create or edit a configuration file for a game with their preferred text editor.
1 parent 2c21354 commit d27307a

File tree

3 files changed

+101
-61
lines changed

3 files changed

+101
-61
lines changed

‎Readme.md

+7-9
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,9 @@ Usage: mod-manager <COMMAND>
5959
Commands:
6060
activate Activate a mod by mounting the OverlayFS inplace
6161
deactivate Deactivate an already activated mod by unmounting the OverlayFS
62-
wrap Wrap an external command in between an activation and deactivation
62+
edit Edit or create a configuration file for a game with $EDITOR
6363
setup Setup and collect changes for a new mod by making changes to the game
64+
wrap Wrap an external command in between an activation and deactivation
6465
help Print this message or the help of the given subcommand(s)
6566
6667
Options:
@@ -97,21 +98,18 @@ Options:
9798
-h, --help Print help
9899
~~~
99100
</details>
100-
<details><summary>Wrap</summary>
101+
<details><summary>Edit</summary>
101102

102103
~~~
103-
Wrap an external command in between an activation and deactivation
104+
Edit or create a configuration file for a game with $EDITOR
104105
105-
Usage: mod-manager wrap [OPTIONS] <GAME> -- [COMMAND]...
106+
Usage: mod-manager edit <GAME>
106107
107108
Arguments:
108-
<GAME> Identifier matching the config file
109-
[COMMAND]... Command to wrap around to
109+
<GAME> Identifier matching the config file. Can be a new identifier if PATH is also available
110110
111111
Options:
112-
--set <SET> Override the "active_set" of the config file
113-
--writable Mount with write access
114-
-h, --help Print help
112+
-h, --help Print help
115113
~~~
116114
</details>
117115
<details><summary>Setup</summary>

‎dist/_mod-manager

+37-23
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,9 @@ __mod-manager() {
88
commands=(
99
'activate:Activate a game or mod'
1010
'deactivate:Deactivate a game or mod'
11-
'wrap:Wrap a command around a game'
11+
'edit:Edit or create a config file'
1212
'setup:Set up a new game or mod'
13+
'wrap:Wrap a command around a game'
1314
'help:Print help message'
1415
)
1516

@@ -19,25 +20,28 @@ __mod-manager() {
1920
'*:: :->args'
2021

2122
case $state in
22-
command)
23-
_describe 'command' commands
24-
;;
25-
args)
23+
command)
24+
_describe 'command' commands
25+
;;
26+
args)
2627
case ${words[1]} in
27-
activate)
28-
__mod-manager-activate
28+
activate)
29+
__mod-manager-activate
30+
;;
31+
deactivate)
32+
__mod-manager-deactivate
2933
;;
30-
deactivate)
31-
__mod-manager-deactivate
34+
edit)
35+
__mod-manager-edit
3236
;;
33-
wrap)
34-
__mod-manager-wrap
37+
setup)
38+
__mod-manager-setup
3539
;;
36-
setup)
37-
__mod-manager-setup
40+
wrap)
41+
__mod-manager-wrap
3842
;;
39-
help)
40-
_message "command options"
43+
help)
44+
_message "command options"
4145
;;
4246
esac
4347
;;
@@ -56,16 +60,16 @@ __mod-manager-deactivate() {
5660
_arguments \
5761
{-h,--help}'[show help message and exit]' \
5862
'1: :__mod-manager-game-identifier'
63+
64+
_message 'New game identifier'
5965
}
6066

61-
__mod-manager-wrap() {
62-
_arguments -S \
67+
__mod-manager-edit() {
68+
_arguments \
6369
{-h,--help}'[show help message and exit]' \
64-
'--set=::Override the "active_set" of the config file:__mod-manager-set-identifier' \
65-
'--writable[Mount with write access]' \
66-
'1: :__mod-manager-game-identifier' \
67-
'2: :__mod-manager-command-separator' \
68-
'*:: :_complete' # FIXME: Doesn't work, should complete fresh here again.
70+
'1: :__mod-manager-game-identifier'
71+
72+
_message "New game identifier"
6973
}
7074

7175
__mod-manager-setup() {
@@ -77,6 +81,16 @@ __mod-manager-setup() {
7781
'2: :__mod-manager-mod-identifier'
7882
}
7983

84+
__mod-manager-wrap() {
85+
_arguments -S \
86+
{-h,--help}'[show help message and exit]' \
87+
'--set=::Override the "active_set" of the config file:__mod-manager-set-identifier' \
88+
'--writable[Mount with write access]' \
89+
'1: :__mod-manager-game-identifier' \
90+
'2: :__mod-manager-command-separator'
91+
# '*:: :_complete' # FIXME: Doesn't work, should complete fresh here again.
92+
}
93+
8094
__mod-manager-game-identifier() {
8195
local XDG_CONFIG_HOME="${XDG_CONFIG_HOME:-$HOME/.config}"
8296
local available=()
@@ -85,7 +99,7 @@ __mod-manager-game-identifier() {
8599
available+=("$(basename "$config")")
86100
done
87101

88-
# shellcheck disable=2068
102+
# shellcheck disable=SC2068
89103
_values game ${available[@]%.toml}
90104
}
91105

‎src/main.rs

+57-29
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
use std::env;
12
use std::{path::PathBuf, vec};
23
use clap::Parser;
34
use xdg::BaseDirectories;
@@ -42,22 +43,11 @@ enum Action {
4243
game: Option<String>,
4344
},
4445

45-
/// Wrap an external command in between an activation and deactivation
46-
#[clap(name = "wrap")]
47-
Wrap {
48-
/// Identifier matching the config file.
46+
/// Edit or create a configuration file for a game with $EDITOR
47+
#[clap(name = "edit")]
48+
Edit {
49+
/// Identifier matching the config file. Can be a new identifier.
4950
game: String,
50-
51-
/// Command to wrap around to.
52-
command: Vec<String>,
53-
54-
/// Override the "active_set" of the config file.
55-
#[clap(long = "set")]
56-
set: Option<String>,
57-
58-
/// Mount with write access.
59-
#[clap(long = "writable")]
60-
writable: bool,
6151
},
6252

6353
/// Setup and collect changes for a new mod by making changes to the game
@@ -78,6 +68,24 @@ enum Action {
7868
#[clap(long = "set")]
7969
set: Option<String>,
8070
},
71+
72+
/// Wrap an external command in between an activation and deactivation
73+
#[clap(name = "wrap")]
74+
Wrap {
75+
/// Identifier matching the config file.
76+
game: String,
77+
78+
/// Command to wrap around to.
79+
command: Vec<String>,
80+
81+
/// Override the "active_set" of the config file.
82+
#[clap(long = "set")]
83+
set: Option<String>,
84+
85+
/// Mount with write access.
86+
#[clap(long = "writable")]
87+
writable: bool,
88+
},
8189
}
8290

8391
fn main() {
@@ -163,16 +171,36 @@ fn main() {
163171
}
164172
}
165173
},
166-
Action::Wrap { game: game_id, command, set, writable } => {
167-
if command.is_empty() {
168-
panic!("Missing command for wrapping game");
169-
}
174+
Action::Edit { game } => {
175+
let mut arguments: Vec<String> = vec![];
170176

171-
let game = Game::from_config(game_id, set).unwrap();
172-
match game.wrap(ExternalCommand::new("wrap_command".to_string(), command, Some(true), None), writable) {
177+
let editor = match env::var("EDITOR") {
178+
Ok(value) => value,
179+
Err(_) => "vi".to_owned(),
180+
};
181+
182+
arguments.push(editor);
183+
arguments.push(xdg_dirs
184+
.place_config_file(format!("{}.toml", game))
185+
.expect("Unable to place config file.")
186+
.to_str()
187+
.expect("Failed converting config path to string.")
188+
.to_owned());
189+
190+
ExternalCommand::new("editor".to_owned(), arguments, Some(true), None)
191+
.run()
192+
.unwrap();
193+
},
194+
Action::Setup { game: game_id, mod_id, path: game_path, set } => {
195+
let game = match game_path {
196+
Some(game_path) => Game::new(game_id, game_path).unwrap(),
197+
None => Game::from_config(game_id, set).unwrap(),
198+
};
199+
200+
match game.setup(mod_id) {
173201
Ok(()) => (),
174202
Err(error) => {
175-
println!("Failed wrapping game overlay '{}': {}", game.id, error);
203+
println!("Failed setup game overlay '{}': {}", game.id, error);
176204
match game.deactivate() {
177205
Ok(()) => (),
178206
Err(error) => {
@@ -182,16 +210,16 @@ fn main() {
182210
}
183211
}
184212
},
185-
Action::Setup { game: game_id, mod_id, path: game_path, set } => {
186-
let game = match game_path {
187-
Some(game_path) => Game::new(game_id, game_path).unwrap(),
188-
None => Game::from_config(game_id, set).unwrap(),
189-
};
213+
Action::Wrap { game: game_id, command, set, writable } => {
214+
if command.is_empty() {
215+
panic!("Missing command for wrapping game");
216+
}
190217

191-
match game.setup(mod_id) {
218+
let game = Game::from_config(game_id, set).unwrap();
219+
match game.wrap(ExternalCommand::new("wrap_command".to_string(), command, Some(true), None), writable) {
192220
Ok(()) => (),
193221
Err(error) => {
194-
println!("Failed setup game overlay '{}': {}", game.id, error);
222+
println!("Failed wrapping game overlay '{}': {}", game.id, error);
195223
match game.deactivate() {
196224
Ok(()) => (),
197225
Err(error) => {

0 commit comments

Comments
 (0)