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.

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

Remove uitable dependency #479

Closed
anderseknert opened this issue Nov 16, 2023 · 0 comments · Fixed by #480
Closed

Remove uitable dependency #479

anderseknert opened this issue Nov 16, 2023 · 0 comments · Fixed by #480
Labels

Comments

@anderseknert
Copy link
Member

We currently use the https://github.com/gosuri/uitable package for printing the pretty and compact reports, which was simple to start with. Later on we introduced https://github.com/olekukonko/tablewriter as we needed to write the markdown table of rules in the README. This is a more competent table writer, and seemingly more performant too (can use strings.Builder rather than a bytes.Buffer) so it makes sense that we use that as our only dependency.

Ideally we'll be able to use the same layout as we currently do for both output formats, but as long as things look good, I don't mind some changes.

anderseknert added a commit that referenced this issue Nov 16, 2023
The compact format now uses a table with headings and borders
as that actually looks better than what it used to, but the
pretty format looks just as before.

An unexpected optimization, I must say, but:

```
regal-table lint e2e/testdata/violations/most_violations.rego ran
  1.09 ± 0.02 times faster than regal-main lint e2e/testdata/violations/most_violations.rego
```

That'll onlyu benefit project with many violations though ;)

Fixes #479

Signed-off-by: Anders Eknert <anders@styra.com>
anderseknert added a commit that referenced this issue Nov 16, 2023
The compact format now uses a table with headings and borders
as that actually looks better than what it used to, but the
pretty format looks just as before.

An unexpected optimization, I must say, but:

```
regal-table lint e2e/testdata/violations/most_violations.rego ran
  1.09 ± 0.02 times faster than regal-main lint e2e/testdata/violations/most_violations.rego
```

That'll only benefit projects with many violations though ;)

Fixes #479

Signed-off-by: Anders Eknert <anders@styra.com>
anderseknert added a commit that referenced this issue Nov 17, 2023
The compact format now uses a table with headings and borders
as that actually looks better than what it used to, but the
pretty format looks just as before.

An unexpected optimization, I must say, but:

```
regal-table lint e2e/testdata/violations/most_violations.rego ran
  1.09 ± 0.02 times faster than regal-main lint e2e/testdata/violations/most_violations.rego
```

That'll only benefit projects with many violations though ;)

Fixes #479

Signed-off-by: Anders Eknert <anders@styra.com>
srenatus pushed a commit to srenatus/regal that referenced this issue Oct 1, 2024
The compact format now uses a table with headings and borders
as that actually looks better than what it used to, but the
pretty format looks just as before.

An unexpected optimization, I must say, but:

```
regal-table lint e2e/testdata/violations/most_violations.rego ran
  1.09 ± 0.02 times faster than regal-main lint e2e/testdata/violations/most_violations.rego
```

That'll only benefit projects with many violations though ;)

Fixes StyraInc#479

Signed-off-by: Anders Eknert <anders@styra.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant