Skip to content
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

Jump to bottom

docs: add link on linter without configuration #4843

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

docs: add link on linter without configuration #4843

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
8d01532
chore: add FaLink
ldez Jun 24, 2024
799adf7
docs: add link on linter without configuration
ldez Jun 24, 2024
60069ab
docs: without icon
ldez Jun 24, 2024
ad83cb9
fix: back to the top link when the repo icon is not on the same line …
ldez Jun 24, 2024
569f77c
fix: back to the top link when no repo
ldez Jun 24, 2024
62eada9
chore: format
ldez Jun 24, 2024
95957a5
docs: add title when no configuration
ldez Jun 24, 2024
3fcc9ef
docs: next
ldez Jun 26, 2024
2b8e3f0
chore: replace emoji by icon
ldez Jun 26, 2024
185e85c
docs: add an icon to display if a linter has a confiiguration or not
ldez Jun 26, 2024
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
2 changes: 1 addition & 1 deletion docs/src/docs/contributing/workflow.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Which runs all the linters and tests.

## Create or update parameters for docs

Add your new or updated parameters to `.golangci.reference.yml` so they will be shown in the docs
Add your new or updated parameters to `.golangci.next.reference.yml` so they will be shown in the docs

## Submit a pull request

Expand Down
2 changes: 1 addition & 1 deletion docs/src/docs/usage/linters.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Linters
---

import { FaGithub, FaGitlab } from "react-icons/fa";
import { FaGithub, FaGitlab, FaArrowUp, FaCog } from "react-icons/fa";

To see a list of supported linters and which linters are enabled/disabled:

Expand Down
12 changes: 7 additions & 5 deletions scripts/website/expand_templates/linters.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,10 +90,12 @@ func getLintersListMarkdown(enabled bool) string {
}

func getName(lc *types.LinterWrapper) string {
name := lc.Name
name := spanWithID(listItemPrefix+lc.Name, "", "")

if hasSettings(lc.Name) {
name = fmt.Sprintf("[%[1]s](#%[2]s \"%[1]s configuration\")", name, lc.Name)
if hasSettings(lc.Name) && lc.Deprecation == nil {
name += fmt.Sprintf("[%[1]s&nbsp;%[2]s](#%[1]s \"%[1]s configuration\")", lc.Name, "<FaCog size={'0.8rem'} />")
} else {
name += fmt.Sprintf("%[1]s[%[2]s](#%[2]s \"%[2]s has no configuration\")", spanWithID(lc.Name, "", ""), lc.Name)
}

if lc.OriginalURL != "" {
Expand All @@ -102,7 +104,7 @@ func getName(lc *types.LinterWrapper) string {
icon = "<FaGitlab size={'0.8rem'} />"
}

name = fmt.Sprintf("%s&nbsp;[%s](%s)", name, spanWithID(listItemPrefix+lc.Name, lc.Name+" repository", icon), lc.OriginalURL)
name += fmt.Sprintf("&nbsp;[%s](%s)", span(lc.Name+" repository", icon), lc.OriginalURL)
}

if lc.Deprecation == nil {
Expand Down Expand Up @@ -322,7 +324,7 @@ func getLintersSettingSections(node, nextNode *yaml.Node) (string, error) {

_, _ = fmt.Fprintln(builder, "```")
_, _ = fmt.Fprintln(builder)
_, _ = fmt.Fprintf(builder, "[%s](#%s)\n\n", span("Back to the top", "🔼"), listItemPrefix+nextNode.Content[i].Value)
_, _ = fmt.Fprintf(builder, "[%s](#%s)\n\n", span("Back to the top", "<FaArrowUp />"), listItemPrefix+nextNode.Content[i].Value)
_, _ = fmt.Fprintln(builder)
}

Expand Down
Loading