10 ms·

One of my favorite things about Shellcheck is that the error messages come with a link to a wiki page about the problem. Does anyone know other programs that ha

by ufo 6y ago

One of my favorite things about Shellcheck is that the error messages come with a link to a wiki page about the problem. Does anyone know other programs that have a similar approach to error messages? https://github.com/koalaman/shellcheck/wiki/Checks https://github.com/koalaman/shellcheck/wiki/Checks

varbhat 6y ago
Rust Compiler Error Index https://doc.rust-lang.org/error-index.html https://doc.rust-lang.org/error-index.html
- mitmaro 6y ago
  Related, Clippy, a linter for Rust also does the same and links to https://rust-lang.github.io/rust-clippy/master/index.html https://rust-lang.github.io/rust-clippy/master/index.html .
DiabloD3 6y ago
Yeah, C# compilers do. Easily Googleable error code to further explain it.
- oblio 6y ago
  I think it's a Microsoft thing. A ton of their stuff has unique error codes just for this purpose.
  - trinix912 6y ago
    Remember back when OS/2 had a special error code for every error message?
    - SSLy 6y ago
      Codes like that are a part of IBM culture that spilled out to other companies.
  - llarsson 6y ago
    Sure beats the General Protection Fault we were so accustomed to back in the day. :)
    - MichaelMoser123 6y ago
      they had the MSDN cd (microsoft developer network) for documentation in these days; that cd had a lot of thorough documentation for apis and developer tools.
  - _pmf_ 6y ago
    All heavily internationalized software should have error codes.
    - oblio 6y ago
      PHP was just ahead of the T_PAAMAYIM_NEKUDOTAYIM curve.
KronisLV 6y ago
I recall working with AngularJS, which output error messages that had links, which opened the documentation with bits from your stack trace filled in. It was a while ago and seemed a bit gimmicky, but i really enjoyed the ability to see what could be done about an error by opening a web page (without having to manually dig through StackOverflow or other sites). Now, if we'd get a development framework that'd couple documentation like that, with user generated comments (like PHP has, for example see the bottom of https://www.php.net/manual/en/function.strcmp.php https://www.php.net/manual/en/function.strcmp.php ), then i think the developer experience would improve a bunch! Who knows, maybe even allow users to contribute possible fixes and allow those as autocomplete solutions and you've just improved on what tools like Codota do a whole bunch!
thepratt 6y ago
Hadolint is another. It's built atop shellcheck. https://github.com/hadolint/hadolint https://github.com/hadolint/hadolint
tyingq 6y ago
find-sec-bugs does that. It's used by, for example, SonarQube. See https://github.com/find-sec-bugs/find-sec-bugs/blob/master/findsecbugs-plugin/src/main/resources/metadata/messages.xml https://github.com/find-sec-bugs/find-sec-bugs/blob/master/f...
rakingleaves 6y ago
Error Prone does this: https://errorprone.info/bugpatterns https://errorprone.info/bugpatterns
imoverclocked 6y ago
Errorprone (java compiler plug-in) has this as does NullAway (an errorprone plug-in) I agree that it’s really handy, especially when implementing the check in a CI pipeline with lots of developers.
monoideism 6y ago
Many of the JS linters do as well (eslint, etc).
human_error 6y ago
SQLAlchemy also does something similar. It points to relevant SQLAlchemy page for more information about the error.
darwingr 6y ago
Dart's static analyzer & lint rules: https://dart-lang.github.io/linter/lints/ https://dart-lang.github.io/linter/lints/ Each rule has its own url. Tool therefore easily gives you a link.
ptman 6y ago
If you're building a REST API, make sure to check out RFC7807 ( https://tools.ietf.org/html/rfc7807 https://tools.ietf.org/html/rfc7807 ) , which recommends doing exactly this. Giving each error a type, which is a resolvable URI.
agapon 6y ago
zpool status
account42 6y ago
Newer versions of GCC have clickable (using terminal escape sequences) warning flags in the output that link to the corresponding documentation.
jidiculous 6y ago
Staticcheck for Go kind of does something similar in that it outputs Googleable error codes, but doesn't actually print a link to the pages. It's also included as part of golangci-lint. https://staticcheck.io/docs/checks https://staticcheck.io/docs/checks

by ufo 6y ago

varbhat 6y ago

Rust Compiler Error Index https://doc.rust-lang.org/error-index.html https://doc.rust-lang.org/error-index.html

mitmaro 6y ago
Related, Clippy, a linter for Rust also does the same and links to https://rust-lang.github.io/rust-clippy/master/index.html https://rust-lang.github.io/rust-clippy/master/index.html .

DiabloD3 6y ago

Yeah, C# compilers do. Easily Googleable error code to further explain it.

oblio 6y ago
I think it's a Microsoft thing. A ton of their stuff has unique error codes just for this purpose.
- trinix912 6y ago
  Remember back when OS/2 had a special error code for every error message?
  - SSLy 6y ago
    Codes like that are a part of IBM culture that spilled out to other companies.
- llarsson 6y ago
  Sure beats the General Protection Fault we were so accustomed to back in the day. :)
  - MichaelMoser123 6y ago
    they had the MSDN cd (microsoft developer network) for documentation in these days; that cd had a lot of thorough documentation for apis and developer tools.
- _pmf_ 6y ago
  All heavily internationalized software should have error codes.
  - oblio 6y ago
    PHP was just ahead of the T_PAAMAYIM_NEKUDOTAYIM curve.

KronisLV 6y ago

I recall working with AngularJS, which output error messages that had links, which opened the documentation with bits from your stack trace filled in. It was a while ago and seemed a bit gimmicky, but i really enjoyed the ability to see what could be done about an error by opening a web page (without having to manually dig through StackOverflow or other sites). Now, if we'd get a development framework that'd couple documentation like that, with user generated comments (like PHP has, for example see the bottom of https://www.php.net/manual/en/function.strcmp.php https://www.php.net/manual/en/function.strcmp.php ), then i think the developer experience would improve a bunch! Who knows, maybe even allow users to contribute possible fixes and allow those as autocomplete solutions and you've just improved on what tools like Codota do a whole bunch!

thepratt 6y ago

Hadolint is another. It's built atop shellcheck. https://github.com/hadolint/hadolint https://github.com/hadolint/hadolint

tyingq 6y ago

find-sec-bugs does that. It's used by, for example, SonarQube. See https://github.com/find-sec-bugs/find-sec-bugs/blob/master/findsecbugs-plugin/src/main/resources/metadata/messages.xml https://github.com/find-sec-bugs/find-sec-bugs/blob/master/f...

rakingleaves 6y ago

Error Prone does this: https://errorprone.info/bugpatterns https://errorprone.info/bugpatterns

imoverclocked 6y ago

Errorprone (java compiler plug-in) has this as does NullAway (an errorprone plug-in) I agree that it’s really handy, especially when implementing the check in a CI pipeline with lots of developers.

monoideism 6y ago

Many of the JS linters do as well (eslint, etc).

human_error 6y ago

SQLAlchemy also does something similar. It points to relevant SQLAlchemy page for more information about the error.

darwingr 6y ago

Dart's static analyzer & lint rules: https://dart-lang.github.io/linter/lints/ https://dart-lang.github.io/linter/lints/ Each rule has its own url. Tool therefore easily gives you a link.

ptman 6y ago

If you're building a REST API, make sure to check out RFC7807 ( https://tools.ietf.org/html/rfc7807 https://tools.ietf.org/html/rfc7807 ) , which recommends doing exactly this. Giving each error a type, which is a resolvable URI.

agapon 6y ago

zpool status

account42 6y ago

Newer versions of GCC have clickable (using terminal escape sequences) warning flags in the output that link to the corresponding documentation.

jidiculous 6y ago

Staticcheck for Go kind of does something similar in that it outputs Googleable error codes, but doesn't actually print a link to the pages. It's also included as part of golangci-lint. https://staticcheck.io/docs/checks https://staticcheck.io/docs/checks