-
Notifications
You must be signed in to change notification settings - Fork 79
/
Copy pathsettings.rs
374 lines (340 loc) · 13 KB
/
settings.rs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
use std::{collections::HashMap, fs, path::PathBuf, str::FromStr};
#[cfg(unix)]
use std::{fs::Permissions, os::unix::prelude::PermissionsExt};
use async_openai::config::OPENAI_API_BASE;
use config::{
builder::DefaultState, Config, ConfigBuilder, ConfigError, Environment, File, Source,
};
use serde::Serialize;
use serde_derive::Deserialize;
use strum_macros::EnumString;
// You need to bring the ToString trait into scope to use it
use std::string::ToString;
use strum_macros::{Display, IntoStaticStr};
use crate::{
git::get_hooks_path,
prompt::{
PROMPT_TO_CONVENTIONAL_COMMIT_PREFIX, PROMPT_TO_SUMMARIZE_DIFF,
PROMPT_TO_SUMMARIZE_DIFF_SUMMARIES, PROMPT_TO_SUMMARIZE_DIFF_TITLE, PROMPT_TO_TRANSLATE,
},
};
static DEFAULT_OPENAI_MODEL: &str = "gpt-3.5-turbo-16k";
static DEFAULT_FILES_TO_IGNORE: &[&str; 8] = &[
"bun.lockb",
"Cargo.lock",
"composer.lock",
"Gemfile.lock",
"package-lock.json",
"pnpm-lock.yaml",
"poetry.lock",
"yarn.lock",
];
#[derive(Debug, Clone, Display, Serialize, Default, EnumString)]
pub(crate) enum ModelProvider {
#[default]
#[strum(serialize = "openai")]
#[serde(rename = "openai")]
OpenAI,
#[strum(serialize = "tester-foobar")]
#[serde(rename = "tester-foobar")]
TesterFoobar,
}
// implement the trait `From<ModelProvider>` for `ValueKind`
impl From<ModelProvider> for config::ValueKind {
fn from(model_provider: ModelProvider) -> Self {
Self::String(model_provider.to_string())
}
}
impl<'de> serde::Deserialize<'de> for ModelProvider {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
struct ModelProviderVisitor;
impl serde::de::Visitor<'_> for ModelProviderVisitor {
type Value = ModelProvider;
fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(formatter, "an string representing a ModelProvider")
}
fn visit_str<E: serde::de::Error>(self, s: &str) -> Result<ModelProvider, E> {
ModelProvider::from_str(s)
.map_err(|_| E::invalid_value(serde::de::Unexpected::Str(s), &self))
}
}
deserializer.deserialize_any(ModelProviderVisitor)
}
}
#[derive(Default, Serialize, Deserialize, Clone)]
pub(crate) struct OpenAISettings {
pub api_base: Option<String>,
pub api_key: Option<String>,
pub model: Option<String>,
pub retries: Option<u16>,
pub proxy: Option<String>,
}
impl std::fmt::Debug for OpenAISettings {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("OpenAISettings")
.field("api_base", &self.api_base)
.field(
"api_key",
// obfuscate the api key
&self.api_key.as_ref().map(|_| "********"),
)
.field("model", &self.model)
.field("retries", &self.retries)
.field("proxy", &self.proxy)
.finish()
}
}
// implement the trait `From<OpenAISettings>` for `ValueKind`
impl From<OpenAISettings> for config::ValueKind {
fn from(settings: OpenAISettings) -> Self {
let mut properties = HashMap::new();
properties.insert(
"api_base".to_string(),
config::Value::from(settings.api_base),
);
properties.insert("api_key".to_string(), config::Value::from(settings.api_key));
properties.insert("model".to_string(), config::Value::from(settings.model));
properties.insert("retries".to_string(), config::Value::from(settings.retries));
properties.insert("proxy".to_string(), config::Value::from(settings.proxy));
Self::Table(properties)
}
}
#[derive(Debug, Default, Serialize, Deserialize, Clone)]
pub(crate) struct PromptSettings {
pub conventional_commit_prefix: Option<String>,
pub commit_summary: Option<String>,
pub commit_title: Option<String>,
pub file_diff: Option<String>,
pub translation: Option<String>,
}
// implement the trait `From<PromptSettings>` for `ValueKind`
impl From<PromptSettings> for config::ValueKind {
fn from(settings: PromptSettings) -> Self {
let mut properties = HashMap::new();
properties.insert(
"conventional_commit_prefix".to_string(),
config::Value::from(settings.conventional_commit_prefix),
);
properties.insert(
"commit_summary".to_string(),
config::Value::from(settings.commit_summary),
);
properties.insert(
"commit_title".to_string(),
config::Value::from(settings.commit_title),
);
properties.insert(
"file_diff".to_string(),
config::Value::from(settings.file_diff),
);
properties.insert(
"translation".to_string(),
config::Value::from(settings.translation),
);
Self::Table(properties)
}
}
#[derive(Debug, Default, Clone, Copy, PartialEq, Display, EnumString, IntoStaticStr)]
#[strum(serialize_all = "kebab-case")]
pub enum Language {
#[default]
#[strum(serialize = "en")]
#[strum(to_string = "English")]
En,
#[strum(serialize = "zh-cn")]
#[strum(to_string = "Simplified Chinese")]
ZhCn,
#[strum(serialize = "zh-tw")]
#[strum(to_string = "Traditional Chinese")]
ZhTw,
#[strum(serialize = "ja")]
#[strum(to_string = "Japanese")]
Ja,
}
#[derive(Debug, Default, Serialize, Deserialize, Clone)]
pub struct OutputSettings {
/// Whether to add a conventional commit tag to the commit message
pub conventional_commit: Option<bool>,
/// The format of the conventional commit tag
pub conventional_commit_prefix_format: Option<String>,
/// Output language of the commit message
pub lang: Option<String>,
/// Whether to show the summary of each file in the commit
pub show_per_file_summary: Option<bool>,
}
// implement the trait `From<OutputSettings>` for `ValueKind`
impl From<OutputSettings> for config::ValueKind {
fn from(settings: OutputSettings) -> Self {
let mut properties = HashMap::new();
properties.insert(
"conventional_commit".to_string(),
config::Value::from(settings.conventional_commit),
);
properties.insert(
"conventional_commit_prefix_format".to_string(),
config::Value::from(settings.conventional_commit_prefix_format),
);
properties.insert("lang".to_string(), config::Value::from(settings.lang));
properties.insert(
"show_per_file_summary".to_string(),
config::Value::from(settings.show_per_file_summary),
);
Self::Table(properties)
}
}
#[derive(Debug, Default, Serialize, Deserialize, Clone)]
pub(crate) struct Settings {
pub model_provider: Option<ModelProvider>,
pub openai: Option<OpenAISettings>,
pub prompt: Option<PromptSettings>,
pub output: Option<OutputSettings>,
/// Whether to run githook when amending the commit
pub allow_amend: Option<bool>,
/// Files to ignore, format similar to gitignore
pub file_ignore: Option<Vec<String>>,
}
impl Settings {
pub fn from_clear(key: &str) -> Result<Self, ConfigError> {
let mut settings = Self::get_config_builder()?;
settings = settings.set_override(key, None::<Option<String>>)?;
settings.build()?.try_deserialize()
}
pub fn from_set_override(key: &str, value: &str) -> Result<Self, ConfigError> {
if key == "output.lang" && Language::from_str(value).is_err() {
return Err(ConfigError::Message(format!("Invalid language: {value}.",)));
}
let mut settings = Self::get_config_builder()?;
settings = settings.set_override(key, value)?;
settings.build()?.try_deserialize()
}
pub fn new() -> Result<Self, ConfigError> {
let settings = Self::get_config_builder()?;
settings.build()?.try_deserialize()
}
fn get_config_builder() -> Result<ConfigBuilder<DefaultState>, ConfigError> {
let mut settings = Config::builder()
.set_default("allow_amend", false)?
.set_default(
"file_ignore",
DEFAULT_FILES_TO_IGNORE
.to_vec()
.iter()
.map(|s| s.to_string())
.collect::<Vec<_>>(),
)?
.set_default("model_provider", ModelProvider::OpenAI)?
.set_default(
"openai",
Some(OpenAISettings {
api_base: Some(OPENAI_API_BASE.to_string()),
api_key: None,
model: Some(DEFAULT_OPENAI_MODEL.to_string()),
retries: Some(2),
proxy: Some("".to_string()),
}),
)?
.set_default(
"prompt",
Some(PromptSettings {
conventional_commit_prefix: Some(
PROMPT_TO_CONVENTIONAL_COMMIT_PREFIX.to_string(),
),
file_diff: Some(PROMPT_TO_SUMMARIZE_DIFF.to_string()),
commit_summary: Some(PROMPT_TO_SUMMARIZE_DIFF_SUMMARIES.to_string()),
commit_title: Some(PROMPT_TO_SUMMARIZE_DIFF_TITLE.to_string()),
translation: Some(PROMPT_TO_TRANSLATE.to_string()),
}),
)?
.set_default(
"output",
Some(OutputSettings {
conventional_commit: Some(true),
conventional_commit_prefix_format: Some("{{ prefix }}: ".to_string()),
lang: Some("en".to_string()),
show_per_file_summary: Some(false),
}),
)?;
if let Some(home_dir) = dirs::home_dir() {
debug!("Using home dir at {}", home_dir.display());
let config_dir = home_dir.join(".config").join(APP_NAME);
if config_dir.is_dir() {
debug!("Found config dir at {}", config_dir.display());
let config_path = config_dir.join("config.toml");
if config_path.is_file() {
debug!("Applying config file at {}", config_path.display());
settings = settings.add_source(File::from(config_path));
} else {
debug!("Config file at {} is not a file", config_path.display());
}
} else {
debug!("Config dir at {} is not a dir", config_dir.display());
}
}
// Add repo-local config
// Find git repo
if let Ok(hooks_path) = get_hooks_path() {
let config_path = hooks_path.join("../gptcommit.toml");
settings = settings.add_source(File::from(config_path).required(false));
}
// Add in settings from the environment (with a prefix of GPTCOMMIT)
// Eg.. `GPTCOMMIT__DEBUG=1 ./target/app` would set the `debug` key
let app_env = Environment::with_prefix(APP_NAME).separator("__");
debug!(
"Applying config from GPTCOMMIT__*: {:?}",
app_env.collect()
);
settings = settings.add_source(app_env);
// add custom override
if let Ok(openai_api_base) = std::env::var("OPENAI_API_BASE") {
if !openai_api_base.is_empty() {
debug!("Applying OPENAI_API_BASE envvar: {}", openai_api_base);
settings = settings.set_override("openai.api_base", Some(openai_api_base))?;
}
}
if let Ok(openai_api_key) = std::env::var("OPENAI_API_KEY") {
if !openai_api_key.is_empty() {
debug!("Applying OPENAI_API_KEY envvar: {}", openai_api_key);
settings = settings.set_override("openai.api_key", Some(openai_api_key))?;
}
}
Ok(settings)
}
}
pub fn get_local_config_path() -> Option<PathBuf> {
if let Ok(config_dir) = get_hooks_path() {
if !config_dir.is_dir() {
fs::create_dir_all(&config_dir).ok()?;
}
let config_path = config_dir
.parent()
.unwrap_or(&config_dir)
.join("gptcommit.toml");
if !config_path.exists() {
fs::write(&config_path, "").ok()?;
#[cfg(unix)]
fs::set_permissions(&config_path, Permissions::from_mode(0o600)).unwrap();
}
return Some(config_path);
}
None
}
pub fn get_user_config_path() -> Option<PathBuf> {
if let Some(home_dir) = dirs::home_dir() {
let config_dir = home_dir.join(".config").join(APP_NAME);
if !config_dir.is_dir() {
fs::create_dir_all(&config_dir).ok()?;
}
let config_path = config_dir.join("config.toml");
if !config_path.exists() {
fs::write(&config_path, "").ok()?;
#[cfg(unix)]
fs::set_permissions(&config_path, Permissions::from_mode(0o600)).unwrap();
}
return Some(config_path);
}
None
}
const APP_NAME: &str = "gptcommit";