Skip to content

docs: improve default exclusions render #5661

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 3 commits into from
Mar 31, 2025
+21 −16
Merged

docs: improve default exclusions render #5661

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cbfbac8
docs: improve default exclusions render
ldez Mar 29, 2025
44aa9ca
docs: improve
ldez Mar 29, 2025
e321874
nitpick
ldez Mar 31, 2025
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
1 change: 1 addition & 0 deletions docs/src/@rocketseat/gatsby-theme-docs/src/styles/global.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ export default function GlobalStyle() {
font-weight: 400;
}
span.inline-code,
code.inline-code {
display: inline-block;
vertical-align: middle;
Expand Down
36 changes: 20 additions & 16 deletions scripts/website/expand_templates/exclusions.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,26 @@ import (

const exclusionTmpl = `{{- $tick := "` + "`" + `" -}}
{{- range $name, $rules := . }}
### {{ $tick }}{{ $name }}{{ $tick }}
{{ range $rule := $rules }}
{{ $tick }}{{ range $linter := $rule.Linters }}{{ $linter }}{{ end }}{{ $tick }}:
{{ if $rule.Path -}}
- Path: {{ $tick }}{{ $rule.Path }}{{ $tick }}
{{ end -}}
{{ if $rule.PathExcept -}}
- Path Except: {{ $tick }}{{ $rule.PathExcept }}{{ $tick }}
{{ end -}}
{{ if $rule.Text -}}
- Text: {{ $tick }}{{ $rule.Text }}{{ $tick }}
{{ end -}}
{{ if $rule.Source -}}
- Source: {{ $tick }}{{ $rule.Source }}{{ $tick }}
{{ end -}}
{{ end }}{{ end }}`
### Preset {{ $tick }}{{ $name }}{{ $tick }}

<table>
<thead>
<tr>
<th>Linter</th>
<th>Issue Text</th>
</tr>
</thead>
<tbody>
{{- range $rule := $rules }}
<tr>
<td>{{ range $linter := $rule.Linters }}{{ $linter }}{{ end }}</td>
<td><span class="inline-code">{{ if $rule.Text }}{{ $rule.Text }}{{ end }}</span></td>
</tr>
{{- end }}
</tbody>
</table>

{{ end }}`

func getExclusionPresets() (string, error) {
linterExclusionPresets, err := readJSONFile[map[string][]types.ExcludeRule](filepath.Join("assets", "exclusion-presets.json"))
Expand Down
Loading