Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 5358349

Browse files
committed
Adjust ruledocsgen module code for github.com/olekukonko/tablewriter 1.x API
The API of the `github.com/olekukonko/tablewriter` module was completely redesigned prior to the 1.0.0 release. This made it incompatible with the code written for the API of the 0.0.x versions of the module. These code changes are purely refactoring. There are some changes to the output (hence the changes in the test data), but these are only insignificant changes to the format of the generated markup, which do not result in any changes to the rendered rules documentation content displayed on the website.
1 parent 5401dc2 commit 5358349

File tree

5 files changed

+41
-16
lines changed

5 files changed

+41
-16
lines changed

‎ruledocsgen/main.go‎

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ import (
3232
"github.com/arduino/arduino-lint/internal/rule/rulelevel"
3333
"github.com/arduino/go-paths-helper"
3434
"github.com/olekukonko/tablewriter"
35+
"github.com/olekukonko/tablewriter/renderer"
36+
"github.com/olekukonko/tablewriter/tw"
3537
)
3638

3739
func main() {
@@ -102,13 +104,36 @@ Subcategory: {{.Subcategory}}
102104
// This is too complex to handle via the template so it is appended to the templated text.
103105
levelsData := ruleLevels(ruleConfiguration)
104106
var table bytes.Buffer
105-
tableWriter := tablewriter.NewWriter(&table)
106-
tableWriter.SetAutoFormatHeaders(false)
107-
tableWriter.SetHeader(levelsData[0])
108-
tableWriter.SetBorders(tablewriter.Border{Left: true, Top: false, Right: true, Bottom: false})
109-
tableWriter.SetCenterSeparator("|")
110-
tableWriter.AppendBulk(levelsData[1:])
111-
tableWriter.Render()
107+
108+
tableConfig := tablewriter.NewConfigBuilder().
109+
/*
110+
By default, the tablewriter package makes arbitrary changes to header content. The content is already exactly as
111+
intended.
112+
*/
113+
WithHeaderAutoFormat(tw.Off).
114+
WithHeaderAlignment(tw.AlignLeft).
115+
WithRowAlignment(tw.AlignLeft).
116+
Build()
117+
118+
tableWriter := tablewriter.NewTable(
119+
&table,
120+
tablewriter.WithConfig(tableConfig),
121+
// Render the table as Markdown markup.
122+
tablewriter.WithRenderer(renderer.NewMarkdown()),
123+
tablewriter.WithAlignment(tw.Alignment{tw.AlignLeft}),
124+
)
125+
126+
// Populate table data.
127+
tableWriter.Header(levelsData[0])
128+
if err := tableWriter.Bulk(levelsData[1:]); err != nil {
129+
panic(err)
130+
}
131+
132+
// Populate the buffer with the table markup.
133+
if err := tableWriter.Render(); err != nil {
134+
panic(err)
135+
}
136+
112137
if _, err := table.WriteTo(&projectRulesData.content); err != nil {
113138
panic(err)
114139
}

‎ruledocsgen/testdata/golden/library.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Subcategory: general
1616
##### Rule levels
1717

1818
| `compliance` | Level |
19-
|---------------|-------|
19+
|:--------------|:------|
2020
| permissive | ERROR |
2121
| specification | ERROR |
2222
| strict | ERROR |
@@ -36,8 +36,8 @@ Subcategory: miscellaneous
3636

3737
##### Rule levels
3838

39-
| `compliance` | `library-manager` | Level |
40-
|---------------|-------------------|----------|
39+
| `compliance` | `library-manager` | Level |
40+
|:--------------|:------------------|:---------|
4141
| permissive | submit | ERROR |
4242
| permissive | update | ERROR |
4343
| permissive | false | disabled |

‎ruledocsgen/testdata/golden/package-index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Subcategory: package
1616
##### Rule levels
1717

1818
| `compliance` | Level |
19-
|---------------|-------|
19+
|:--------------|:------|
2020
| permissive | ERROR |
2121
| specification | ERROR |
2222
| strict | ERROR |

‎ruledocsgen/testdata/golden/platform.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Subcategory: boards.txt
1616
##### Rule levels
1717

1818
| `compliance` | Level |
19-
|---------------|-------|
19+
|:--------------|:------|
2020
| permissive | ERROR |
2121
| specification | ERROR |
2222
| strict | ERROR |
@@ -36,8 +36,8 @@ Subcategory: boards.txt
3636

3737
##### Rule levels
3838

39-
| `compliance` | Level |
40-
|---------------|---------|
39+
| `compliance` | Level |
40+
|:--------------|:--------|
4141
| permissive | WARNING |
4242
| specification | WARNING |
4343
| strict | ERROR |

‎ruledocsgen/testdata/golden/sketch.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ Subcategory: root folder
1515

1616
##### Rule levels
1717

18-
| `compliance` | Level |
19-
|---------------|---------|
18+
| `compliance` | Level |
19+
|:--------------|:--------|
2020
| permissive | WARNING |
2121
| specification | ERROR |
2222
| strict | ERROR |

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /