Skip to content

docs: add linters description #3945

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Jul 11, 2023
Merged

docs: add linters description #3945

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
c7940c7
add description to linters in usages/linters
AlduLonghi Jul 7, 2023
72e7886
add function for normalizing linter descriptions to a standard format
AlduLonghi Jul 7, 2023
68365aa
refactor logic in normalization function to linter description
AlduLonghi Jul 9, 2023
291cf58
change name for normalizing function for better understanding
AlduLonghi Jul 9, 2023
483d0fa
replace getName function for Name in description mapping
AlduLonghi Jul 9, 2023
a80b008
add missing variable asignment line in function
AlduLonghi Jul 9, 2023
dcd876b
move import to previous location
AlduLonghi Jul 10, 2023
8d9bf09
resolve comments in PR / refactor in formatting function por linter's…
AlduLonghi Jul 10, 2023
f67aef7
fix logic in function for formatting linter's description
AlduLonghi Jul 10, 2023
d5fc9a4
review: minor changes
ldez Jul 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 35 additions & 3 deletions scripts/expand_website_templates/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ import (
"reflect"
"sort"
"strings"
"unicode"
"unicode/utf8"

"gopkg.in/yaml.v3"

Expand Down Expand Up @@ -302,7 +304,20 @@ func getDesc(lc *linter.Config) string {
}
}

return strings.ReplaceAll(desc, "\n", "<br/>")
return formatDesc(desc)
}

func formatDesc(desc string) string {
runes := []rune(desc)

r, _ := utf8.DecodeRuneInString(desc)
runes[0] = unicode.ToUpper(r)

if runes[len(runes)-1] != '.' {
runes = append(runes, '.')
}

return strings.ReplaceAll(string(runes), "\n", "<br/>")
}

func check(b bool, title string) string {
Expand Down Expand Up @@ -342,6 +357,10 @@ func getThanksList() string {
addedAuthors := map[string]*authorDetails{}

for _, lc := range lintersdb.NewManager(nil, nil).GetAllSupportedLinterConfigs() {
if lc.Internal {
continue
}

if lc.OriginalURL == "" {
continue
}
Expand Down Expand Up @@ -468,7 +487,7 @@ func extractExampleSnippets(example []byte) (*SettingSnippets, error) {
globalNode.Content = append(globalNode.Content, node, newNode)

if node.Value == "linters-settings" {
snippets.LintersSettings, err = getLintersSettingSnippets(node, nextNode)
snippets.LintersSettings, err = getLintersSettingSections(node, nextNode)
if err != nil {
return nil, err
}
Expand Down Expand Up @@ -508,7 +527,19 @@ func extractExampleSnippets(example []byte) (*SettingSnippets, error) {
return &snippets, nil
}

func getLintersSettingSnippets(node, nextNode *yaml.Node) (string, error) {
func getLintersSettingSections(node, nextNode *yaml.Node) (string, error) {
lcs := lintersdb.NewManager(nil, nil).GetAllSupportedLinterConfigs()

var lintersDesc = make(map[string]string)
for _, lc := range lcs {
if lc.Internal {
continue
}

// it's important to use lc.Name() nor name because name can be alias
lintersDesc[lc.Name()] = getDesc(lc)
}

builder := &strings.Builder{}

for i := 0; i < len(nextNode.Content); i += 2 {
Expand All @@ -530,6 +561,7 @@ func getLintersSettingSnippets(node, nextNode *yaml.Node) (string, error) {
}

_, _ = fmt.Fprintf(builder, "### %s\n\n", nextNode.Content[i].Value)
_, _ = fmt.Fprintf(builder, "%s\n\n", lintersDesc[nextNode.Content[i].Value])
_, _ = fmt.Fprintln(builder, "```yaml")

encoder := yaml.NewEncoder(builder)
Expand Down