-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathconfig.go
More file actions
816 lines (726 loc) · 23.8 KB
/
config.go
File metadata and controls
816 lines (726 loc) · 23.8 KB
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
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
package main
import (
"fmt"
"os"
"path/filepath"
"strings"
"github.com/gechr/clog"
goyaml "github.com/goccy/go-yaml"
goyamlast "github.com/goccy/go-yaml/ast"
goyamlparser "github.com/goccy/go-yaml/parser"
koanfyaml "github.com/knadh/koanf/parsers/yaml"
"github.com/knadh/koanf/providers/confmap"
"github.com/knadh/koanf/providers/env"
"github.com/knadh/koanf/providers/file"
"github.com/knadh/koanf/v2"
)
const envPrefix = "PRL_"
func configPath() (string, error) {
home, err := os.UserHomeDir()
if err != nil {
return "", err
}
return filepath.Join(home, ".config", "prl", "config.yaml"), nil
}
// Configuration key constants.
const (
keyAuthors = "authors"
keyDefaultAuthors = "default.authors"
keyDefaultBots = "default.bots"
keyDefaultLimit = "default.limit"
keyDefaultMatch = "default.match"
keyDefaultMergeMethod = "default.merge_method"
keyDefaultOwners = "default.owners"
keyDefaultOutput = "default.output"
keyDefaultReverse = "default.reverse"
keyDefaultSort = "default.sort"
keyDefaultState = "default.state"
keyPlugin = "plugin"
keyIgnoredOwners = "ignored_owners"
keyTeamAliases = "team_aliases"
keyTeams = "teams"
keySpinnerStyle = "spinner.style"
keySpinnerColors = "spinner.colors"
keyTUIAutoRefresh = "tui.refresh.enabled"
keyTUIReviewDefaultEff = "tui.review.default.effort"
keyTUIReviewDefaultModel = "tui.review.default.model"
keyTUIReviewDefaultProv = "tui.review.default.provider"
keyTUIReviewClaudePrompt = "tui.review.providers.claude.prompt"
keyTUIReviewCodexPrompt = "tui.review.providers.codex.prompt"
keyTUIReviewGeminiPrompt = "tui.review.providers.gemini.prompt"
keyTUIFilterArchived = "tui.filters.archived"
keyTUIFilterBots = "tui.filters.bots"
keyTUIFilterCI = "tui.filters.ci"
keyTUIFilterDraft = "tui.filters.draft"
keyTUIFilterReview = "tui.filters.review"
keyTUIFilterState = "tui.filters.state"
keyTUIScreenRepair = "tui.screen_repair"
keyTUISortKey = "tui.sort.key"
keyTUISortOrder = "tui.sort.order"
keyVCS = "vcs"
)
// Defaults holds default values that can be overridden by CLI flags.
type Defaults struct {
Authors []string `koanf:"authors"`
Bots bool `koanf:"bots"`
Limit int `koanf:"limit"`
Match string `koanf:"match"`
MergeMethod string `koanf:"merge_method"`
Owners []string `koanf:"owners"`
Output string `koanf:"output"`
Reverse bool `koanf:"reverse"`
Sort string `koanf:"sort"`
State string `koanf:"state"`
}
// SpinnerConfig holds spinner style configuration.
type SpinnerConfig struct {
Style string `koanf:"style"`
Colors []string `koanf:"colors"`
}
// TUIAutoRefreshConfig holds auto-refresh settings.
type TUIAutoRefreshConfig struct {
Enabled bool `koanf:"enabled"`
}
// TUISortConfig holds sort settings persisted between TUI runs.
type TUISortConfig struct {
Key string `koanf:"key"`
Order string `koanf:"order"`
}
// TUIFiltersConfig holds persisted filter overrides for TUI mode.
type TUIFiltersConfig struct {
State string `koanf:"state"`
Draft *bool `koanf:"draft"`
Bots *bool `koanf:"bots"`
Archived *bool `koanf:"archived"`
CI string `koanf:"ci"`
Review string `koanf:"review"`
}
type TUIReviewProviderConfig struct {
Prompt string `koanf:"prompt"`
Models []string `koanf:"models"`
Efforts []string `koanf:"efforts"`
}
type TUIReviewProvidersConfig struct {
Claude TUIReviewProviderConfig `koanf:"claude"`
Codex TUIReviewProviderConfig `koanf:"codex"`
Gemini TUIReviewProviderConfig `koanf:"gemini"`
}
type TUIReviewDefaultConfig struct {
Provider string `koanf:"provider"`
Model string `koanf:"model"`
Effort string `koanf:"effort"`
}
type TUIReviewConfig struct {
Default TUIReviewDefaultConfig `koanf:"default"`
Enabled []string `koanf:"enabled"`
Providers TUIReviewProvidersConfig `koanf:"providers"`
}
func (c TUIReviewConfig) providerConfig(provider reviewProvider) TUIReviewProviderConfig {
switch provider {
case reviewProviderCodex:
return c.Providers.Codex
case reviewProviderGemini:
return c.Providers.Gemini
case reviewProviderClaude, reviewProviderUnknown:
return c.Providers.Claude
}
return c.Providers.Claude
}
// TUIConfig holds TUI-specific configuration.
type TUIConfig struct {
AutoRefresh TUIAutoRefreshConfig `koanf:"refresh"`
Review TUIReviewConfig `koanf:"review"`
Filters TUIFiltersConfig `koanf:"filters"`
Sort TUISortConfig `koanf:"sort"`
ScreenRepair bool `koanf:"screen_repair"`
}
// Config holds all prl configuration.
type Config struct {
// Defaults
Default Defaults `koanf:"default"`
// Clone settings
VCS string `koanf:"vcs"`
// Spinner style
Spinner SpinnerConfig `koanf:"spinner"`
// TUI settings
TUI TUIConfig `koanf:"tui"`
// Plugin binary for completions and resolution (name or path).
// If empty, prl auto-discovers prl-plugin-* on PATH.
Plugin string `koanf:"plugin"`
// Owner exclusion
IgnoredOwners []string `koanf:"ignored_owners"`
// Team aliases
TeamAliases map[string]string `koanf:"team_aliases"`
// Teams maps team names to lists of GitHub usernames.
Teams map[string][]string `koanf:"teams"`
// Author display names (github_username -> Display Name)
Authors map[string]string `koanf:"authors"`
}
func defaultConfig() map[string]any {
return map[string]any{
keyAuthors: map[string]string{},
keyVCS: vcsGit,
keyDefaultAuthors: []string{valueAtMe},
keyDefaultBots: true,
keyDefaultLimit: defaultLimit,
keyDefaultMatch: "title",
keyDefaultMergeMethod: "squash",
keyDefaultOwners: []string{},
keyDefaultOutput: valueTable,
keyDefaultReverse: false,
keyDefaultSort: valueName,
keyDefaultState: valueOpen,
keyPlugin: "",
keyIgnoredOwners: []string{},
keyTeamAliases: map[string]string{},
keyTeams: map[string][]string{},
keySpinnerStyle: defaultSpinner,
keyTUIAutoRefresh: true,
keyTUIReviewDefaultEff: defaultReviewEffort(
nil,
defaultReviewProvider,
defaultReviewModel(nil, defaultReviewProvider),
),
keyTUIReviewDefaultProv: string(defaultReviewProvider),
keyTUIReviewDefaultModel: defaultReviewModel(nil, defaultReviewProvider),
keyTUIReviewClaudePrompt: defaultReviewPromptTemplate(reviewProviderClaude),
keyTUIReviewCodexPrompt: defaultReviewPromptTemplate(reviewProviderCodex),
keyTUIReviewGeminiPrompt: defaultReviewPromptTemplate(reviewProviderGemini),
keyTUIScreenRepair: false,
keyTUIFilterArchived: nil,
keyTUIFilterBots: nil,
keyTUIFilterCI: "",
keyTUIFilterDraft: nil,
keyTUIFilterReview: "",
keyTUIFilterState: "",
keyTUISortKey: "",
keyTUISortOrder: "",
keySpinnerColors: defaultSpinnerColors,
}
}
// loadConfig loads configuration with the following priority:
// 1. Hardcoded defaults
// 2. YAML file at ~/.config/prl/config.yaml (optional)
// 3. PRL_* env vars
func loadConfig() (*Config, error) {
k := koanf.New(".")
// 1. Hardcoded defaults
if err := k.Load(confmap.Provider(defaultConfig(), "."), nil); err != nil {
return nil, fmt.Errorf("loading defaults: %w", err)
}
// 2. YAML config file (optional)
if cp, cpErr := configPath(); cpErr != nil {
clog.Debug().Err(cpErr).Msg("Failed to determine config path")
} else if _, statErr := os.Stat(cp); statErr == nil {
if err := k.Load(file.Provider(cp), koanfyaml.Parser()); err != nil {
return nil, fmt.Errorf("loading config file %s: %w", cp, err)
}
}
// 3. PRL_* env vars
if err := k.Load(env.Provider(envPrefix, ".", func(s string) string {
return strings.ToLower(strings.TrimPrefix(s, envPrefix))
}), nil); err != nil {
return nil, fmt.Errorf("loading environment variables: %w", err)
}
if strings.EqualFold(k.String(keyDefaultOutput), "slack") {
clog.Warn().Msg(
`default.output=slack has been removed; using "table" (use --send to post via plugin)`,
)
if err := k.Set(keyDefaultOutput, valueTable); err != nil {
return nil, fmt.Errorf("migrating default.output: %w", err)
}
}
var cfg Config
if err := k.Unmarshal("", &cfg); err != nil {
return nil, fmt.Errorf("unmarshalling config: %w", err)
}
// Validate defaults
if cfg.Default.Limit <= 0 {
return nil, fmt.Errorf("default.limit must be > 0, got %d", cfg.Default.Limit)
}
if _, ok := parseOutputFormat(cfg.Default.Output); !ok {
return nil, fmt.Errorf("invalid default.output %q", cfg.Default.Output)
}
if _, ok := parseSortField(cfg.Default.Sort); !ok {
return nil, fmt.Errorf("invalid default.sort %q", cfg.Default.Sort)
}
if _, ok := parsePRState(cfg.Default.State); !ok {
return nil, fmt.Errorf("invalid default.state %q", cfg.Default.State)
}
if cfg.Default.Match != "" {
switch cfg.Default.Match {
case "title", "body", "comments":
default:
return nil, fmt.Errorf(
"invalid default.match %q (expected title, body, or comments)",
cfg.Default.Match,
)
}
}
// Validate tui.filters.*
if cfg.TUI.Filters.State != "" {
if _, ok := parsePRState(cfg.TUI.Filters.State); !ok {
return nil, fmt.Errorf("invalid tui.filters.state %q", cfg.TUI.Filters.State)
}
}
if cfg.TUI.Filters.CI != "" {
if _, ok := parseCIStatus(cfg.TUI.Filters.CI); !ok {
return nil, fmt.Errorf("invalid tui.filters.ci %q", cfg.TUI.Filters.CI)
}
}
if cfg.TUI.Filters.Review != "" {
switch cfg.TUI.Filters.Review {
case valueReviewFilterNone,
valueReviewFilterRequired,
valueReviewFilterApproved,
valueReviewFilterChanges:
default:
return nil, fmt.Errorf("invalid tui.filters.review %q", cfg.TUI.Filters.Review)
}
}
if len(cfg.TUI.Review.Enabled) > 0 {
normalized := make([]string, 0, len(cfg.TUI.Review.Enabled))
seen := map[string]struct{}{}
for _, raw := range cfg.TUI.Review.Enabled {
provider := normalizeReviewProvider(raw)
if provider == reviewProviderUnknown {
return nil, fmt.Errorf("invalid tui.review.enabled provider %q", raw)
}
name := string(provider)
if _, ok := seen[name]; ok {
continue
}
seen[name] = struct{}{}
normalized = append(normalized, name)
}
cfg.TUI.Review.Enabled = normalized
}
provider := normalizeReviewProvider(cfg.TUI.Review.Default.Provider)
if provider == reviewProviderUnknown {
return nil, fmt.Errorf(
"invalid tui.review.default.provider %q",
cfg.TUI.Review.Default.Provider,
)
}
if !isChoiceValue(reviewProviderChoices(&cfg), string(provider)) &&
cfg.TUI.Review.Default.Provider == string(defaultReviewProvider) {
provider = configuredReviewProvider(&cfg)
}
if !isChoiceValue(reviewProviderChoices(&cfg), string(provider)) {
return nil, fmt.Errorf(
"invalid tui.review.default.provider %q",
cfg.TUI.Review.Default.Provider,
)
}
cfg.TUI.Review.Default.Provider = string(provider)
for _, provider := range []reviewProvider{
reviewProviderClaude,
reviewProviderCodex,
reviewProviderGemini,
} {
pc := cfg.TUI.Review.providerConfig(provider)
if len(pc.Models) == 1 && pc.Models[0] == "" {
pc.Models = nil
}
if len(pc.Efforts) == 1 && pc.Efforts[0] == "" {
pc.Efforts = nil
}
switch provider {
case reviewProviderClaude:
cfg.TUI.Review.Providers.Claude.Models = pc.Models
cfg.TUI.Review.Providers.Claude.Efforts = pc.Efforts
case reviewProviderCodex:
cfg.TUI.Review.Providers.Codex.Models = pc.Models
cfg.TUI.Review.Providers.Codex.Efforts = pc.Efforts
case reviewProviderGemini:
cfg.TUI.Review.Providers.Gemini.Models = pc.Models
cfg.TUI.Review.Providers.Gemini.Efforts = pc.Efforts
case reviewProviderUnknown:
// The provider list above excludes unknown values.
}
}
model := cfg.TUI.Review.Default.Model
if model == "" {
model = defaultReviewModel(&cfg, provider)
}
if !isValidReviewModel(&cfg, provider, model) &&
model == defaultReviewModel(nil, defaultReviewProvider) {
model = defaultReviewModel(&cfg, provider)
}
if !isValidReviewModel(&cfg, provider, model) {
return nil, fmt.Errorf(
"invalid tui.review.default.model %q for provider %q",
cfg.TUI.Review.Default.Model,
provider,
)
}
cfg.TUI.Review.Default.Model = model
effort := cfg.TUI.Review.Default.Effort
if effort == "" {
effort = defaultReviewEffort(&cfg, provider, model)
}
if effort != "" && !isValidReviewEffort(&cfg, provider, model, effort) &&
effort == defaultReviewEffort(
nil,
defaultReviewProvider,
defaultReviewModel(nil, defaultReviewProvider),
) {
effort = defaultReviewEffort(&cfg, provider, model)
}
if effort != "" && !isValidReviewEffort(&cfg, provider, model, effort) {
return nil, fmt.Errorf(
"invalid tui.review.default.effort %q for provider %q model %q",
cfg.TUI.Review.Default.Effort,
provider,
model,
)
}
cfg.TUI.Review.Default.Effort = effort
if err := validateReviewPromptTemplate(cfg.TUI.Review.Providers.Claude.Prompt); err != nil {
return nil, fmt.Errorf("invalid tui.review.providers.claude.prompt: %w", err)
}
if err := validateReviewPromptTemplate(cfg.TUI.Review.Providers.Codex.Prompt); err != nil {
return nil, fmt.Errorf("invalid tui.review.providers.codex.prompt: %w", err)
}
if err := validateReviewPromptTemplate(cfg.TUI.Review.Providers.Gemini.Prompt); err != nil {
return nil, fmt.Errorf("invalid tui.review.providers.gemini.prompt: %w", err)
}
// Validate VCS
switch strings.ToLower(cfg.VCS) {
case vcsGit, vcsJJ:
cfg.VCS = strings.ToLower(cfg.VCS)
default:
return nil, fmt.Errorf("invalid vcs %q (expected %q or %q)", cfg.VCS, vcsGit, vcsJJ)
}
return &cfg, nil
}
// saveConfigKey reads the config file, sets a dotted key (e.g. "tui.refresh.enabled")
// to the given value, and writes it back preserving comments and formatting.
func saveConfigKey(key string, value any) error {
cp, err := configPath()
if err != nil {
return err
}
// Resolve symlinks so we write to the actual file.
if resolved, evalErr := filepath.EvalSymlinks(cp); evalErr == nil {
cp = resolved
}
// Read existing file, or start empty.
data, err := os.ReadFile(cp)
if err != nil && !os.IsNotExist(err) {
return fmt.Errorf("reading config: %w", err)
}
// Parse into an AST to preserve comments/formatting.
f, err := goyamlparser.ParseBytes(data, goyamlparser.ParseComments)
if err != nil {
return fmt.Errorf("parsing config: %w", err)
}
// Build the path from the dotted key.
path, pathErr := goyaml.PathString("$." + key)
if pathErr != nil {
return fmt.Errorf("building path: %w", pathErr)
}
// Try to read the existing value - if it fails, the key doesn't exist yet.
_, readErr := path.ReadNode(f)
if readErr == nil {
// Key exists - replace in-place.
replacement, marshalErr := marshalYAMLValue(value)
if marshalErr != nil {
return fmt.Errorf("marshalling key %s: %w", key, marshalErr)
}
if replaceErr := path.ReplaceWithReader(
f,
strings.NewReader(replacement),
); replaceErr != nil {
return fmt.Errorf("replacing key %s: %w", key, replaceErr)
}
//nolint:gosec // config file, not sensitive
return os.WriteFile(cp, []byte(withSingleTrailingNewline(f.String())), 0o644)
}
if merged := mergeIntoAncestor(f, key, value); merged {
//nolint:gosec // config file, not sensitive
return os.WriteFile(cp, []byte(withSingleTrailingNewline(f.String())), 0o644)
}
// No ancestor found - append as a new top-level section.
parts := strings.Split(key, ".")
nested := make(map[string]any)
cur := nested
for i, p := range parts {
if i == len(parts)-1 {
cur[p] = value
} else {
next := make(map[string]any)
cur[p] = next
cur = next
}
}
section, mErr := goyaml.Marshal(nested)
if mErr != nil {
return fmt.Errorf("marshalling new key: %w", mErr)
}
base := strings.TrimRight(f.String(), nl)
sectionBody := strings.TrimRight(string(section), nl)
out := sectionBody
if base != "" {
out = base + nl + nl + sectionBody
}
//nolint:gosec // config file, not sensitive
return os.WriteFile(cp, []byte(withSingleTrailingNewline(out)), 0o644)
}
func marshalYAMLValue(value any) (string, error) {
encoded, err := goyaml.Marshal(value)
if err != nil {
return "", err
}
return strings.TrimRight(string(encoded), nl), nil
}
func withSingleTrailingNewline(content string) string {
return strings.TrimRight(content, nl) + nl
}
func indentBlock(content string, indent int) string {
prefix := strings.Repeat(" ", indent)
lines := strings.Split(content, nl)
for i, line := range lines {
lines[i] = prefix + line
}
return strings.Join(lines, nl)
}
// mergeIntoAncestor finds the top-level ancestor of a dotted key in the YAML
// AST, unmarshals it, deep-sets the missing suffix, re-marshals only that
// top-level subtree, and splices it back via ReplaceWithReader. The rest of
// the document's comments and formatting are left untouched.
//
// We only replace at depth=1 (top-level keys) because ReplaceWithReader does
// not re-indent replacement content to match the column offset of the replaced
// node - operating on nested nodes produces progressively wrong indentation.
func mergeIntoAncestor(f *goyamlast.File, key string, value any) bool {
parts := strings.Split(key, ".")
if len(parts) < 2 { //nolint:mnd // need at least key + one ancestor
return false
}
ancestorPath, pErr := goyaml.PathString("$." + parts[0])
if pErr != nil {
return false
}
if _, aErr := ancestorPath.ReadNode(f); aErr != nil {
return false
}
// Top-level ancestor exists. Unmarshal the full document, set the target
// key, extract the top-level ancestor's subtree, and replace only that node.
var docMap map[string]any
if uErr := goyaml.Unmarshal([]byte(f.String()), &docMap); uErr != nil {
return false
}
if docMap == nil {
docMap = make(map[string]any)
}
// Deep-set the full dotted path into the decoded document.
cur := docMap
for i, seg := range parts {
if i == len(parts)-1 {
cur[seg] = value
} else {
if next, ok := cur[seg].(map[string]any); ok {
cur = next
} else {
next := make(map[string]any)
cur[seg] = next
cur = next
}
}
}
ancestorMap, ok := docMap[parts[0]].(map[string]any)
if !ok {
return false
}
updated, mErr := goyaml.Marshal(ancestorMap)
if mErr != nil {
return false
}
if rErr := ancestorPath.ReplaceWithReader(
f,
strings.NewReader(string(updated)),
); rErr != nil {
return false
}
return true
}
var defaultConfigYAML = func() string {
const promptBlockIndent = 10
return fmt.Sprintf(`# prl configuration
# See: prl --help
# Default query parameters applied when the corresponding flag is not set.
default:
# Default authors to search for.
# Use "%[1]s" for the authenticated user, or specify GitHub usernames.
# Examples:
# authors: ["%[1]s"]
# authors: ["octocat", "hubot"]
authors:
- "%[1]s"
# Whether to include PRs from bot accounts (e.g. dependabot, renovate).
bots: true
# Maximum number of results to return.
limit: %[2]d
# Restrict text search to a specific field.
# Options: title, body, comments
match: title
# Merge method used for auto-merge.
# Options: squash, merge, rebase
merge_method: squash
# Limit searches to specific GitHub owners (organizations or users).
# Examples:
# owners: ["my-org"]
# owners: ["org-a", "org-b"]
owners: []
# Output format for results.
# Options: table, url, bullet, json, repo
output: %[3]s
# Show oldest results first (at the top).
reverse: false
# Sort order for results.
# Options: name, created, updated
sort: %[4]s
# Filter by PR state.
# Options: open, closed, merged, all
state: %[5]s
# TUI (interactive browse) settings.
tui:
refresh:
# Automatically refresh results in the background.
enabled: true
review:
# Optional: limit or reorder the available review providers.
# enabled: [claude, codex, gemini]
default:
# Default AI review provider and model.
# Providers: claude, codex, gemini
provider: claude
model: sonnet
effort: medium
providers:
claude:
# Optional overrides for the available model/effort choices.
# If omitted, prl uses the built-in Claude review options.
# models: [sonnet, opus]
# efforts: [low, medium, high, xhigh, max, auto]
# Default prompt for Claude AI review.
# Available placeholders:
# %[10]s
prompt: |
%[9]s
codex:
# Optional overrides for the available model/effort choices.
# If omitted, prl uses the built-in Codex review options.
# models: [gpt-5.4, gpt-5.4-mini, gpt-5.3-codex]
# efforts: [low, medium, high, xhigh]
# Default prompt for Codex AI review.
# Available placeholders:
# %[10]s
prompt: |
%[11]s
gemini:
# Optional overrides for the available model/effort choices.
# If omitted, prl uses the built-in Gemini review options.
# models: [gemini-3.1-pro, gemini-3-pro, gemini-2.5-flash]
# efforts:
# Gemini 3: [low, medium, high]
# Gemini 2.5 Flash budgets: [0, 1024, 8192, 24576, dynamic]
# Default prompt for Gemini AI review.
# Available placeholders:
# %[10]s
prompt: |
%[12]s
# Persisted filter overrides for TUI mode.
# Set via the filter menu (alt+f) in the TUI.
# filters:
# state: merged
# draft: false
# bots: false
sort:
# Persisted sort column and direction.
# Set by clicking column headers in the TUI.
# key: title
# order: asc
# VCS used for --clone.
# Options: git, jj
vcs: %[6]s
# Spinner displayed while fetching data.
spinner:
# Animation style.
# Options: dots, stars
style: %[7]s
# Colors for spinner frames (256-color palette).
# Each frame cycles through these colors in order.
colors: [%[8]s]
# Plugin binary for completions and resolution.
# If set, prl invokes this binary for --author/--team/-R/--topic completions
# and for resolving --team to GitHub usernames.
# If omitted, prl auto-discovers any prl-plugin-* binary on PATH.
# Example: plugin: acme
plugin: ""
# Owners to exclude from results.
# Example: ignored_owners: ["archived-org", "old-org"]
ignored_owners: []
# Map GitHub usernames to display names for prettier output.
# Example:
# authors:
# octocat: Mona Lisa
# hubot: Hubot Bot
authors: {}
# Map team names to lists of GitHub usernames for --team resolution.
# Example:
# teams:
# ops: [alice, bob, charlie]
# frontend: [dave, eve]
teams: {}
# Short aliases for team slugs, usable with --team.
# Example:
# team_aliases:
# fe: my-org/frontend
# be: my-org/backend
team_aliases: {}
`,
valueAtMe,
defaultLimit,
valueTable,
valueName,
valueOpen,
vcsGit,
defaultSpinner,
`"`+strings.Join(defaultSpinnerColors, `", "`)+`"`,
indentBlock(defaultReviewPromptTemplate(reviewProviderClaude), promptBlockIndent),
"`{prNumber}`, `{repo}`, `{owner}`, `{ownerWithRepo}`, `{prURL}`, `{prRef}`, `{title}`",
indentBlock(defaultReviewPromptTemplate(reviewProviderCodex), promptBlockIndent),
indentBlock(defaultReviewPromptTemplate(reviewProviderGemini), promptBlockIndent),
)
}()
func initConfig() error {
cp, err := configPath()
if err != nil {
return fmt.Errorf("determining config path: %w", err)
}
if _, err := os.Stat(cp); err == nil {
clog.Warn().Path("path", cp).Msg("Config already exists")
return errOK
}
if err := os.MkdirAll(
filepath.Dir(cp),
0o755,
); err != nil {
return fmt.Errorf("creating config directory: %w", err)
}
if err := os.WriteFile(cp, []byte(defaultConfigYAML), 0o600); err != nil {
return fmt.Errorf("writing config: %w", err)
}
clog.Info().Path("path", cp).Msg("Initialized default config")
return nil
}
// resolveTeamAlias resolves a team alias to its full name.
func (c *Config) resolveTeamAlias(team string) string {
lower := strings.ToLower(team)
if full, ok := c.TeamAliases[lower]; ok {
return full
}
return team
}