personal_interest_mirrors/awesome-docker
1
0
Fork 0
mirror of https://github.com/veggiemonk/awesome-docker.git synced 2026-04-03 12:25:39 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

feat: implement lint --fix and standardize README

Browse Source 
Add FixFile() to rewrite README entries: capitalize descriptions,
add trailing periods, remove author attributions, and sort entries
alphabetically within each section. Update parser regex to handle
entries with markers between URL and description separator. Fix
linter to check first letter (not first character) for capitalization.

~480 entries standardized across the README.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Julien Bisconti
2026-02-27 23:31:57 +01:00
parent e5d5594775
commit 0816049273
6 changed files with 792 additions and 482 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
internal/linter/rules.go
View File

@@ -47,7 +47,7 @@ func (i Issue) String() string {
func CheckEntry(e parser.Entry) []Issue {
var issues []Issue
if len(e.Description) > 0 && !unicode.IsUpper(rune(e.Description[0])) {
if first, ok := firstLetter(e.Description); ok && !unicode.IsUpper(first) {
issues = append(issues, Issue{
Rule: RuleDescriptionCapital,
Severity: SeverityError,
@@ -106,13 +106,28 @@ func CheckDuplicates(entries []parser.Entry) []Issue {
return issues
}
// firstLetter returns the first unicode letter in s and true, or zero and false if none.
func firstLetter(s string) (rune, bool) {
for _, r := range s {
if unicode.IsLetter(r) {
return r, true
}
}
return 0, false
}
// FixEntry returns a copy of the entry with auto-fixable issues corrected.
func FixEntry(e parser.Entry) parser.Entry {
fixed := e
if len(fixed.Description) > 0 {
// Capitalize first letter
// Capitalize first letter (find it, may not be at index 0)
runes := []rune(fixed.Description)
runes[0] = unicode.ToUpper(runes[0])
for i, r := range runes {
if unicode.IsLetter(r) {
runes[i] = unicode.ToUpper(r)
break
}
}
fixed.Description = string(runes)
// Ensure period at end