1use std::fmt;
2use std::fs;
3use std::path::Path;
4
5use indexmap::IndexMap;
6use serde::de;
7use serde::{Deserialize, Deserializer};
8
9#[derive(Debug, Clone, PartialEq, Eq)]
14pub enum ToolSetting {
15 Named(String),
16 Disabled,
17}
18
19impl ToolSetting {
20 pub fn resolve<'a>(setting: Option<&'a Self>, default: &'a str) -> Option<&'a str> {
22 match setting {
23 None => Some(default),
24 Some(ToolSetting::Named(s)) => Some(s.as_str()),
25 Some(ToolSetting::Disabled) => None,
26 }
27 }
28}
29
30impl<'de> Deserialize<'de> for ToolSetting {
31 fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
32 where
33 D: Deserializer<'de>,
34 {
35 let value = serde_json::Value::deserialize(deserializer).map_err(de::Error::custom)?;
36 match value {
37 serde_json::Value::String(s) => Ok(ToolSetting::Named(s)),
38 serde_json::Value::Bool(false) => Ok(ToolSetting::Disabled),
39 serde_json::Value::Bool(true) => {
40 Err(de::Error::custom(
42 "use `false` to disable or a string to name the tool; `true` is treated as default (omit the field)",
43 ))
44 }
45 _ => Err(de::Error::custom(
46 "expected a tool name string or `false` to disable",
47 )),
48 }
49 }
50}
51
52#[derive(Debug, Clone)]
54pub struct OagConfig {
55 pub input: String,
56 pub naming: NamingConfig,
57 pub generators: IndexMap<GeneratorId, GeneratorConfig>,
58}
59
60impl Default for OagConfig {
61 fn default() -> Self {
62 Self {
63 input: "openapi.yaml".to_string(),
64 naming: NamingConfig::default(),
65 generators: IndexMap::new(),
66 }
67 }
68}
69
70#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
72pub enum GeneratorId {
73 NodeClient,
74 ReactSwrClient,
75 FastapiServer,
76}
77
78impl GeneratorId {
79 pub fn as_str(&self) -> &'static str {
80 match self {
81 GeneratorId::NodeClient => "node-client",
82 GeneratorId::ReactSwrClient => "react-swr-client",
83 GeneratorId::FastapiServer => "fastapi-server",
84 }
85 }
86}
87
88impl fmt::Display for GeneratorId {
89 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
90 write!(f, "{}", self.as_str())
91 }
92}
93
94impl<'de> Deserialize<'de> for GeneratorId {
95 fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
96 where
97 D: Deserializer<'de>,
98 {
99 let s = String::deserialize(deserializer)?;
100 match s.as_str() {
101 "node-client" => Ok(GeneratorId::NodeClient),
102 "react-swr-client" => Ok(GeneratorId::ReactSwrClient),
103 "fastapi-server" => Ok(GeneratorId::FastapiServer),
104 other => Err(de::Error::unknown_variant(
105 other,
106 &["node-client", "react-swr-client", "fastapi-server"],
107 )),
108 }
109 }
110}
111
112#[derive(Debug, Clone, Deserialize)]
114#[serde(default)]
115pub struct GeneratorConfig {
116 pub output: String,
117 pub layout: OutputLayout,
118 pub split_by: Option<SplitBy>,
119 pub base_url: Option<String>,
120 pub no_jsdoc: Option<bool>,
121 pub scaffold: Option<serde_json::Value>,
123}
124
125impl Default for GeneratorConfig {
126 fn default() -> Self {
127 Self {
128 output: "src/generated".to_string(),
129 layout: OutputLayout::Modular,
130 split_by: None,
131 base_url: None,
132 no_jsdoc: None,
133 scaffold: None,
134 }
135 }
136}
137
138#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize)]
140#[serde(rename_all = "snake_case")]
141pub enum OutputLayout {
142 Bundled,
144 Modular,
146 Split,
148}
149
150#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize)]
152#[serde(rename_all = "snake_case")]
153pub enum SplitBy {
154 Operation,
156 Tag,
158 Route,
160}
161
162#[derive(Debug, Clone, Deserialize)]
164#[serde(default)]
165pub struct NamingConfig {
166 pub strategy: NamingStrategy,
167 #[serde(default)]
169 pub aliases: IndexMap<String, String>,
170}
171
172impl Default for NamingConfig {
173 fn default() -> Self {
174 Self {
175 strategy: NamingStrategy::UseOperationId,
176 aliases: IndexMap::new(),
177 }
178 }
179}
180
181#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Deserialize)]
183#[serde(rename_all = "snake_case")]
184pub enum NamingStrategy {
185 #[default]
186 UseOperationId,
187 UseRouteBased,
188}
189
190#[derive(Deserialize)]
197struct LegacyConfig {
198 #[serde(default = "default_input")]
199 input: String,
200 #[serde(default = "default_output")]
201 output: String,
202 #[serde(default)]
203 target: LegacyTargetKind,
204 #[serde(default)]
205 naming: NamingConfig,
206 #[serde(default)]
207 output_options: LegacyOutputOptions,
208 #[serde(default)]
209 client: LegacyClientConfig,
210}
211
212fn default_input() -> String {
213 "openapi.yaml".to_string()
214}
215fn default_output() -> String {
216 "src/generated".to_string()
217}
218
219#[derive(Debug, Clone, Copy, Default, Deserialize, PartialEq, Eq)]
220#[serde(rename_all = "snake_case")]
221enum LegacyTargetKind {
222 Typescript,
223 React,
224 #[default]
225 All,
226}
227
228#[derive(Debug, Clone, Deserialize)]
229#[serde(default)]
230struct LegacyOutputOptions {
231 layout: LegacyOutputLayout,
232 index: bool,
233 biome: bool,
234 tsdown: bool,
235 package_name: Option<String>,
236 repository: Option<String>,
237}
238
239impl Default for LegacyOutputOptions {
240 fn default() -> Self {
241 Self {
242 layout: LegacyOutputLayout::Single,
243 index: true,
244 biome: true,
245 tsdown: true,
246 package_name: None,
247 repository: None,
248 }
249 }
250}
251
252#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Deserialize)]
253#[serde(rename_all = "snake_case")]
254enum LegacyOutputLayout {
255 #[default]
256 Single,
257 Split,
258}
259
260#[derive(Debug, Clone, Default, Deserialize)]
261#[serde(default)]
262struct LegacyClientConfig {
263 base_url: Option<String>,
264 no_jsdoc: bool,
265}
266
267#[derive(Deserialize)]
269struct NewConfig {
270 #[serde(default = "default_input")]
271 input: String,
272 #[serde(default)]
273 naming: NamingConfig,
274 generators: IndexMap<GeneratorId, GeneratorConfig>,
275}
276
277impl<'de> Deserialize<'de> for OagConfig {
278 fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
279 where
280 D: Deserializer<'de>,
281 {
282 let value = serde_json::Value::deserialize(deserializer).map_err(de::Error::custom)?;
284
285 if value.get("generators").is_some() {
287 let new_cfg: NewConfig = serde_json::from_value(value).map_err(de::Error::custom)?;
288 Ok(OagConfig {
289 input: new_cfg.input,
290 naming: new_cfg.naming,
291 generators: new_cfg.generators,
292 })
293 } else {
294 let legacy: LegacyConfig = serde_json::from_value(value).map_err(de::Error::custom)?;
296 Ok(convert_legacy(legacy))
297 }
298 }
299}
300
301fn convert_legacy(legacy: LegacyConfig) -> OagConfig {
302 let scaffold = Some(serde_json::json!({
303 "package_name": legacy.output_options.package_name,
304 "repository": legacy.output_options.repository,
305 "index": legacy.output_options.index,
306 "formatter": if legacy.output_options.biome { serde_json::Value::String("biome".into()) } else { serde_json::Value::Bool(false) },
307 "bundler": if legacy.output_options.tsdown { serde_json::Value::String("tsdown".into()) } else { serde_json::Value::Bool(false) },
308 "test_runner": serde_json::Value::String("vitest".into()),
309 }));
310
311 let base_gen_config = |output: String| GeneratorConfig {
312 output,
313 layout: OutputLayout::Modular,
314 split_by: None,
315 base_url: legacy.client.base_url.clone(),
316 no_jsdoc: Some(legacy.client.no_jsdoc),
317 scaffold: scaffold.clone(),
318 };
319
320 let mut generators = IndexMap::new();
321
322 match (&legacy.target, &legacy.output_options.layout) {
323 (LegacyTargetKind::Typescript, _) => {
324 generators.insert(
325 GeneratorId::NodeClient,
326 base_gen_config(legacy.output.clone()),
327 );
328 }
329 (LegacyTargetKind::React, _) => {
330 generators.insert(
331 GeneratorId::ReactSwrClient,
332 base_gen_config(legacy.output.clone()),
333 );
334 }
335 (LegacyTargetKind::All, LegacyOutputLayout::Single) => {
336 generators.insert(
340 GeneratorId::ReactSwrClient,
341 base_gen_config(legacy.output.clone()),
342 );
343 }
344 (LegacyTargetKind::All, LegacyOutputLayout::Split) => {
345 let ts_output = format!("{}/typescript", legacy.output);
346 let react_output = format!("{}/react", legacy.output);
347 generators.insert(GeneratorId::NodeClient, base_gen_config(ts_output));
348 generators.insert(GeneratorId::ReactSwrClient, base_gen_config(react_output));
349 }
350 }
351
352 OagConfig {
353 input: legacy.input,
354 naming: legacy.naming,
355 generators,
356 }
357}
358
359pub const CONFIG_FILE_NAME: &str = ".urmzd.oag.yaml";
361
362pub fn load_config(path: &Path) -> Result<Option<OagConfig>, String> {
364 if !path.exists() {
365 return Ok(None);
366 }
367 let content = fs::read_to_string(path)
368 .map_err(|e| format!("failed to read config {}: {}", path.display(), e))?;
369
370 let yaml_value: serde_json::Value = serde_yaml_ng::from_str(&content)
372 .map_err(|e| format!("failed to parse config {}: {}", path.display(), e))?;
373 let config: OagConfig = serde_json::from_value(yaml_value)
374 .map_err(|e| format!("failed to parse config {}: {}", path.display(), e))?;
375 Ok(Some(config))
376}
377
378pub fn default_config_content() -> &'static str {
380 r#"# oag configuration — https://github.com/urmzd/openapi-generator
381input: openapi.yaml
382
383naming:
384 strategy: use_operation_id # use_operation_id | use_route_based
385 aliases: {}
386 # createChatCompletion: chat # operationId → custom name
387 # listModels: models
388
389generators:
390 node-client:
391 output: src/generated/node
392 layout: modular # bundled | modular | split
393 # split_by: tag # operation | tag | route (only for split layout)
394 # base_url: https://api.example.com
395 # no_jsdoc: false
396 scaffold:
397 # package_name: my-api-client
398 # repository: https://github.com/you/your-repo
399 formatter: biome # biome | false
400 test_runner: vitest # vitest | false
401 bundler: tsdown # tsdown | false
402
403 # react-swr-client:
404 # output: src/generated/react
405 # layout: modular
406 # scaffold:
407 # formatter: biome
408 # test_runner: vitest
409 # bundler: tsdown
410
411 # fastapi-server:
412 # output: src/generated/server
413 # layout: modular
414 # scaffold:
415 # formatter: ruff # ruff | false
416 # test_runner: pytest # pytest | false
417"#
418}
419
420#[cfg(test)]
421mod tests {
422 use super::*;
423
424 #[test]
425 fn test_default_config() {
426 let config = OagConfig::default();
427 assert_eq!(config.input, "openapi.yaml");
428 assert_eq!(config.naming.strategy, NamingStrategy::UseOperationId);
429 assert!(config.naming.aliases.is_empty());
430 assert!(config.generators.is_empty());
431 }
432
433 #[test]
434 fn test_parse_new_format() {
435 let yaml = r#"
436input: spec.yaml
437
438naming:
439 strategy: use_route_based
440 aliases:
441 createChatCompletion: chat
442
443generators:
444 node-client:
445 output: out/node
446 layout: modular
447 base_url: https://api.example.com
448 scaffold:
449 package_name: "@myorg/client"
450 formatter: biome
451 bundler: tsdown
452 react-swr-client:
453 output: out/react
454 layout: split
455 split_by: tag
456"#;
457 let value: serde_json::Value = serde_yaml_ng::from_str(yaml).unwrap();
458 let config: OagConfig = serde_json::from_value(value).unwrap();
459 assert_eq!(config.input, "spec.yaml");
460 assert_eq!(config.naming.strategy, NamingStrategy::UseRouteBased);
461 assert_eq!(config.generators.len(), 2);
462
463 let node = &config.generators[&GeneratorId::NodeClient];
464 assert_eq!(node.output, "out/node");
465 assert_eq!(node.layout, OutputLayout::Modular);
466 assert_eq!(node.base_url, Some("https://api.example.com".to_string()));
467 assert!(node.scaffold.is_some());
468 let scaffold = node.scaffold.as_ref().unwrap();
469 assert_eq!(scaffold["package_name"], "@myorg/client");
470 assert_eq!(scaffold["formatter"], "biome");
471 assert_eq!(scaffold["bundler"], "tsdown");
472
473 let react = &config.generators[&GeneratorId::ReactSwrClient];
474 assert_eq!(react.output, "out/react");
475 assert_eq!(react.layout, OutputLayout::Split);
476 assert_eq!(react.split_by, Some(SplitBy::Tag));
477 }
478
479 #[test]
480 fn test_parse_legacy_typescript() {
481 let yaml = r#"
482input: spec.yaml
483output: out
484target: typescript
485naming:
486 strategy: use_operation_id
487 aliases: {}
488output_options:
489 layout: single
490 biome: true
491 tsdown: true
492client:
493 base_url: https://api.example.com
494 no_jsdoc: true
495"#;
496 let value: serde_json::Value = serde_yaml_ng::from_str(yaml).unwrap();
497 let config: OagConfig = serde_json::from_value(value).unwrap();
498 assert_eq!(config.input, "spec.yaml");
499 assert_eq!(config.generators.len(), 1);
500 assert!(config.generators.contains_key(&GeneratorId::NodeClient));
501
502 let node_gen = &config.generators[&GeneratorId::NodeClient];
503 assert_eq!(node_gen.output, "out");
504 assert_eq!(
505 node_gen.base_url,
506 Some("https://api.example.com".to_string())
507 );
508 assert_eq!(node_gen.no_jsdoc, Some(true));
509 }
510
511 #[test]
512 fn test_parse_legacy_react() {
513 let yaml = r#"
514input: spec.yaml
515output: out
516target: react
517"#;
518 let value: serde_json::Value = serde_yaml_ng::from_str(yaml).unwrap();
519 let config: OagConfig = serde_json::from_value(value).unwrap();
520 assert_eq!(config.generators.len(), 1);
521 assert!(config.generators.contains_key(&GeneratorId::ReactSwrClient));
522 }
523
524 #[test]
525 fn test_parse_legacy_all_single() {
526 let yaml = r#"
527input: spec.yaml
528output: out
529target: all
530output_options:
531 layout: single
532"#;
533 let value: serde_json::Value = serde_yaml_ng::from_str(yaml).unwrap();
534 let config: OagConfig = serde_json::from_value(value).unwrap();
535 assert_eq!(config.generators.len(), 1);
537 assert!(config.generators.contains_key(&GeneratorId::ReactSwrClient));
538 }
539
540 #[test]
541 fn test_parse_legacy_all_split() {
542 let yaml = r#"
543input: spec.yaml
544output: out
545target: all
546output_options:
547 layout: split
548"#;
549 let value: serde_json::Value = serde_yaml_ng::from_str(yaml).unwrap();
550 let config: OagConfig = serde_json::from_value(value).unwrap();
551 assert_eq!(config.generators.len(), 2);
552 assert!(config.generators.contains_key(&GeneratorId::NodeClient));
553 assert!(config.generators.contains_key(&GeneratorId::ReactSwrClient));
554 assert_eq!(
555 config.generators[&GeneratorId::NodeClient].output,
556 "out/typescript"
557 );
558 assert_eq!(
559 config.generators[&GeneratorId::ReactSwrClient].output,
560 "out/react"
561 );
562 }
563
564 #[test]
565 fn test_tool_setting_resolve() {
566 assert_eq!(ToolSetting::resolve(None, "biome"), Some("biome"));
567 assert_eq!(
568 ToolSetting::resolve(Some(&ToolSetting::Named("ruff".into())), "biome"),
569 Some("ruff")
570 );
571 assert_eq!(
572 ToolSetting::resolve(Some(&ToolSetting::Disabled), "biome"),
573 None
574 );
575 }
576
577 #[test]
578 fn test_tool_setting_deserialize() {
579 let named: ToolSetting = serde_json::from_value(serde_json::json!("biome")).unwrap();
580 assert_eq!(named, ToolSetting::Named("biome".into()));
581
582 let disabled: ToolSetting = serde_json::from_value(serde_json::json!(false)).unwrap();
583 assert_eq!(disabled, ToolSetting::Disabled);
584
585 let err = serde_json::from_value::<ToolSetting>(serde_json::json!(true));
586 assert!(err.is_err());
587 }
588
589 #[test]
590 fn test_parse_minimal_config() {
591 let yaml = "input: api.yaml\n";
592 let value: serde_json::Value = serde_yaml_ng::from_str(yaml).unwrap();
593 let config: OagConfig = serde_json::from_value(value).unwrap();
594 assert_eq!(config.input, "api.yaml");
595 assert_eq!(config.generators.len(), 1);
597 }
598}