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

fix/feat!: show input from a new line #4112

Open
4 tasks
abitrolly opened this issue Aug 3, 2024 · 1 comment
Open
4 tasks

fix/feat!: show input from a new line #4112

abitrolly opened this issue Aug 3, 2024 · 1 comment

Comments

@abitrolly
Copy link
Contributor

abitrolly commented Aug 3, 2024

Proposal to discuss

It will be less confusing to read, and also easier to test and copy/paste (for example for #4101) if the error message of commitlint tool contained exact input.

This is a breaking change, but it should be, and the arguments are:

  1. new format makes user readable error message also machine readable
  2. the output can be copy/pasted for tests
  3. the new text is not confusing for potential 100k+ of new users
  4. 100k+ users spending 5 minutes trying to understand what is the error, who produced that, and what exactly is the source, is a lot of time better spent on fixing other stuff
  5. integration of linters with tools and editors should use JSON or other standard machine readable format, so that no ANSI codes or fixes in grammar break them again

Current Behavior

This error log is confusing for people not familiar with commitlint.

⧗   input: fix: ingest - do not double strip /doc/ prefix
It is already stripped here
https://gitlab.com/gitlab-community/modelops/applied-ml/code-suggestions/ai-assist/-/blob/22bb9cf2b996dc2ec347bad761abb12fd11bcf75/scripts/ingest/gitlab-docs/steps/parse.rb#L16
✖   body's lines must not be longer than 100 characters [body-max-line-length]
✖   found 1 warnings

Expected Behavior

⧗ commit 4c6319af message:
fix: ingest - do not double strip /doc/ prefix

It is already stripped here
https://gitlab.com/gitlab-community/modelops/applied-ml/code-suggestions/ai-assist/-/blob/22bb9cf2b996dc2ec347bad761abb12fd11bcf75/scripts/ingest/gitlab-docs/steps/parse.rb#L16
✖   body's lines must not be longer than 100 characters [body-max-line-length]
✖   found 1 warnings

Affected packages

  • cli
  • core
  • prompt
  • config-angular

Possible Solution

No response

Context

No response

commitlint --version

latest

git --version

latest

node --version

latest

@knocte
Copy link
Contributor

knocte commented Aug 31, 2024

I agree with @abitrolly's change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

3 participants