Skip to content

Commit e0fec7a

Browse files
apocelipesapocelipes
authored
feat: Automatically provide corrective suggestions when command-line flags contain errors (#655)
1 parent 9f81eda commit e0fec7a

13 files changed

Lines changed: 533 additions & 30 deletions

File tree

‎SCC-OUTPUT-REPORT.html‎

Lines changed: 47 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@
1212
</tr></thead>
1313
<tbody><tr>
1414
<th>Go</th>
15-
<th>27</th>
16-
<th>23501</th>
17-
<th>1456</th>
18-
<th>439</th>
19-
<th>21606</th>
20-
<th>1423</th>
21-
<th>457896</th>
22-
<th>6406</th>
15+
<th>29</th>
16+
<th>23721</th>
17+
<th>1471</th>
18+
<th>452</th>
19+
<th>21798</th>
20+
<th>1442</th>
21+
<th>462788</th>
22+
<th>6497</th>
2323
</tr><tr>
2424
<td>processor/constants.go</td>
2525
<td></td>
@@ -80,6 +80,16 @@
8080
<td>79</td>
8181
<td>18249</td>
8282
<td>416</td>
83+
</tr><tr>
84+
<td>main.go</td>
85+
<td></td>
86+
<td>481</td>
87+
<td>15</td>
88+
<td>9</td>
89+
<td>457</td>
90+
<td>24</td>
91+
<td>11384</td>
92+
<td>304</td>
8393
</tr><tr>
8494
<td>cmd/badges/main.go</td>
8595
<td></td>
@@ -90,16 +100,6 @@
90100
<td>68</td>
91101
<td>12982</td>
92102
<td>297</td>
93-
</tr><tr>
94-
<td>main.go</td>
95-
<td></td>
96-
<td>459</td>
97-
<td>12</td>
98-
<td>8</td>
99-
<td>439</td>
100-
<td>17</td>
101-
<td>10587</td>
102-
<td>291</td>
103103
</tr><tr>
104104
<td>processor/detector_test.go</td>
105105
<td></td>
@@ -200,6 +200,16 @@
200200
<td>16</td>
201201
<td>3323</td>
202202
<td>96</td>
203+
</tr><tr>
204+
<td>processor/similar_flags_test.go</td>
205+
<td></td>
206+
<td>132</td>
207+
<td>5</td>
208+
<td>0</td>
209+
<td>127</td>
210+
<td>5</td>
211+
<td>2333</td>
212+
<td>58</td>
203213
</tr><tr>
204214
<td>processor/trace_test.go</td>
205215
<td></td>
@@ -230,6 +240,16 @@
230240
<td>19</td>
231241
<td>2140</td>
232242
<td>64</td>
243+
</tr><tr>
244+
<td>processor/similar_flags.go</td>
245+
<td></td>
246+
<td>66</td>
247+
<td>7</td>
248+
<td>12</td>
249+
<td>47</td>
250+
<td>7</td>
251+
<td>1762</td>
252+
<td>51</td>
233253
</tr><tr>
234254
<td>processor/filereader.go</td>
235255
<td></td>
@@ -293,16 +313,16 @@
293313
</tr></tbody>
294314
<tfoot><tr>
295315
<th>Total</th>
296-
<th>27</th>
297-
<th>23501</th>
298-
<th>1456</th>
299-
<th>439</th>
300-
<th>21606</th>
301-
<th>1423</th>
302-
<th>457896</th>
303-
<th>6406</th>
316+
<th>29</th>
317+
<th>23721</th>
318+
<th>1471</th>
319+
<th>452</th>
320+
<th>21798</th>
321+
<th>1442</th>
322+
<th>462788</th>
323+
<th>6497</th>
304324
</tr>
305325
<tr>
306-
<th colspan="9">Estimated Cost to Develop (organic) $680,610<br>Estimated Schedule Effort (organic) 11.88 months<br>Estimated People Required (organic) 5.09<br></th>
326+
<th colspan="9">Estimated Cost to Develop (organic) $686,962<br>Estimated Schedule Effort (organic) 11.92 months<br>Estimated People Required (organic) 5.12<br></th>
307327
</tr></tfoot>
308328
</table></body></html>

‎go.mod‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,14 @@ module github.com/boyter/scc/v3
33
go 1.25.2
44

55
require (
6+
github.com/agnivade/levenshtein v1.2.2-0.20250519083737-420867539855
67
github.com/boyter/gocodewalker v1.5.1
78
github.com/boyter/simplecache v0.0.0-20250113230110-8a4c9201822a
89
github.com/json-iterator/go v1.1.12
910
github.com/mattn/go-runewidth v0.0.19
1011
github.com/rs/zerolog v1.30.0
1112
github.com/spf13/cobra v1.10.1
13+
github.com/spf13/pflag v1.0.10
1214
golang.org/x/crypto v0.43.0
1315
golang.org/x/text v0.30.0
1416
gopkg.in/yaml.v2 v2.4.0
@@ -22,7 +24,6 @@ require (
2224
github.com/mattn/go-isatty v0.0.19 // indirect
2325
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
2426
github.com/modern-go/reflect2 v1.0.2 // indirect
25-
github.com/spf13/pflag v1.0.10 // indirect
2627
golang.org/x/sync v0.17.0 // indirect
2728
golang.org/x/sys v0.37.0 // indirect
2829
)

‎go.sum‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
github.com/agnivade/levenshtein v1.2.2-0.20250519083737-420867539855 h1:eecTPiTbYU25fX1PZ2euFs9ol/TwQsJbRZwOF6pddw8=
2+
github.com/agnivade/levenshtein v1.2.2-0.20250519083737-420867539855/go.mod h1:QVVI16kDrtSuwcpd0p1+xMC6Z/VfhtCyDIjcwga4/DU=
3+
github.com/arbovm/levenshtein v0.0.0-20160628152529-48b4e1c0c4d0 h1:jfIu9sQUG6Ig+0+Ap1h4unLjW6YQJpKZVmUzxsD4E/Q=
4+
github.com/arbovm/levenshtein v0.0.0-20160628152529-48b4e1c0c4d0/go.mod h1:t2tdKJDJF9BV14lnkjHmOQgcvEKgtqs5a1N3LNdJhGE=
15
github.com/boyter/gocodewalker v1.5.1 h1:0YeK2QAkd+ymW5MsagMZapIXD3v9/vrZl0HkFSLpKsw=
26
github.com/boyter/gocodewalker v1.5.1/go.mod h1:9k+yM6+fIx61F0xI9ChXEGE5DYoLhggw8AxSOtW+kKo=
37
github.com/boyter/simplecache v0.0.0-20250113230110-8a4c9201822a h1:eL28tNqB4nBuMVA+WijpviMStOY7NAFWDowPB6I6Ruo=
@@ -11,6 +15,8 @@ github.com/danwakefield/fnmatch v0.0.0-20160403171240-cbb64ac3d964/go.mod h1:Xd9
1115
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
1216
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
1317
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
18+
github.com/dgryski/trifles v0.0.0-20230903005119-f50d829f2e54 h1:SG7nF6SRlWhcT7cNTs5R6Hk4V2lcmLz2NsG2VnInyNo=
19+
github.com/dgryski/trifles v0.0.0-20230903005119-f50d829f2e54/go.mod h1:if7Fbed8SFyPtHLHbg49SI7NAdJiC5WIA09pe59rfAA=
1420
github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
1521
github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
1622
github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=

‎main.go‎

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import (
1111

1212
"github.com/boyter/scc/v3/processor"
1313
"github.com/spf13/cobra"
14+
"github.com/spf13/pflag"
1415
)
1516

1617
func printShellCompletion(cmd *cobra.Command, command string) error {
@@ -28,6 +29,23 @@ func printShellCompletion(cmd *cobra.Command, command string) error {
2829
}
2930
}
3031

32+
func printFlagSuggestion(flagSet *pflag.FlagSet, unknownFlag string) {
33+
flags := processor.GetMostSimilarFlags(flagSet, unknownFlag)
34+
if len(flags) == 0 {
35+
return
36+
}
37+
38+
if len(flags) > 1 {
39+
_, _ = fmt.Fprintf(os.Stderr, "The most similar flags of --%s are:\n", unknownFlag)
40+
} else {
41+
_, _ = fmt.Fprintf(os.Stderr, "The most similar flag of --%s is:\n", unknownFlag)
42+
}
43+
44+
for _, flag := range flags {
45+
_, _ = fmt.Fprintf(os.Stderr, "\t--%s\n", flag)
46+
}
47+
}
48+
3149
//go:generate go run scripts/include.go
3250
func main() {
3351
// f, _ := os.Create("scc.pprof")
@@ -448,12 +466,16 @@ func main() {
448466
if len(args) == 4 && args[1] == "completion" && args[2] == "--shell" {
449467
err := printShellCompletion(rootCmd, args[3])
450468
if err != nil {
451-
fmt.Printf("Error printing shell completion: %s\n", err)
469+
_, _ = fmt.Fprintf(os.Stderr, "Error printing shell completion: %s\n", err)
452470
}
453471
return
454472
}
455473

456474
if err := rootCmd.Execute(); err != nil {
475+
// If a flag does not exist and is not a shorthand, it may be a spelling error. Search for and print possible options.
476+
if notExistError, ok := err.(*pflag.NotExistError); ok && len(notExistError.GetSpecifiedName()) > 1 {
477+
printFlagSuggestion(flags, notExistError.GetSpecifiedName())
478+
}
457479
os.Exit(1)
458480
}
459481
}

‎processor/similar_flags.go‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
package processor
2+
3+
import (
4+
"cmp"
5+
"slices"
6+
"strings"
7+
8+
"github.com/agnivade/levenshtein"
9+
"github.com/spf13/pflag"
10+
)
11+
12+
const SimilarStringThreshold float64 = 0.8
13+
14+
// StringSimilarRatio calculates the similarity ratio between s1 and s2.
15+
//
16+
// The function is based on the Levenshtein distance. The ratio is calculated using the formula:
17+
//
18+
// 1 - (Levenshtein Distance / length of the longer string).
19+
//
20+
// It returns a float64 between 0.0 (completely dissimilar) and 1.0 (identical).
21+
// Based on experience, a ratio >= [SimilarStringThreshold] can generally be
22+
// considered to indicate that two strings are highly similar.
23+
//
24+
// Note: The comparison is case-sensitive. For example, "hello" and "HELLO"
25+
// will be treated as completely different strings (their similarity ratio is 0).
26+
func StringSimilarRatio(s1, s2 string) float64 {
27+
distance := levenshtein.ComputeDistance(s1, s2)
28+
return 1 - float64(distance)/float64(max(len(s1), len(s2)))
29+
}
30+
31+
type similarFlag struct {
32+
name string
33+
ratio float64
34+
}
35+
36+
func GetMostSimilarFlags(flagSet *pflag.FlagSet, flag string) []string {
37+
similarFlags := make([]similarFlag, 0)
38+
flagSet.VisitAll(func(f *pflag.Flag) {
39+
if len(f.Name) <= 1 {
40+
return
41+
}
42+
ratio := StringSimilarRatio(flag, f.Name)
43+
if ratio >= SimilarStringThreshold {
44+
similarFlags = append(similarFlags, similarFlag{
45+
name: f.Name,
46+
ratio: ratio,
47+
})
48+
}
49+
})
50+
if len(similarFlags) == 0 {
51+
return []string{}
52+
}
53+
54+
slices.SortFunc(similarFlags, func(a, b similarFlag) int {
55+
result := cmp.Compare(b.ratio, a.ratio)
56+
if result != 0 {
57+
return result
58+
}
59+
return strings.Compare(a.name, b.name)
60+
})
61+
result := make([]string, 0, len(similarFlags))
62+
for _, sc := range similarFlags {
63+
result = append(result, sc.name)
64+
}
65+
return result
66+
}

0 commit comments

Comments
 (0)