From c9e05cff1e571ac685bcad4cf57d01855c98e74d Mon Sep 17 00:00:00 2001 From: Vidar Holen Date: Tue, 29 Apr 2025 21:13:46 -0700 Subject: [PATCH] Updated Home (markdown) --- Home.md | 43 ++++++++++++++++++++++--------------------- 1 file changed, 22 insertions(+), 21 deletions(-) diff --git a/Home.md b/Home.md index a65169c..31540a9 100644 --- a/Home.md +++ b/Home.md @@ -1,28 +1,29 @@ -Welcome to the ShellCheck! +### Welcome to the ShellCheck wiki! -If you tried to follow a link for an issue but ended up here, it means that page does not exist yet +If you tried to follow a link for an issue but ended up here, it means that page does not exist yet :( -You can [file an issue](https://github.com/shellcheck/issues) about it and ask that it be added. +You can [file an issue](https://github.com/koalaman/shellcheck/issues) about it and ask that it be added. + +--- + +[ShellCheck](https://github.com/koalaman/shellcheck) is a static analysis tool for shell scripts. This wiki holds all the long form descriptions of warnings and suggestions it outputs. If you get this output: + +```console +$ shellcheck myscript +In myscript line 5: +eof + ^-- SC1118: Delete whitespace after the here-doc end token. +``` + +and it's too terse or you're not sure whether it applies, you can read more on this wiki page: [[SC1118]]. + +On [ShellCheck.net](http://www.shellcheck.net), you can just click the error code to go to this page. -[ShellCheck](https://github.com/shellcheck) is a static analysis tool for shell events. This file holds all the long form descriptions of warnings and suggestions it outputs. If you get this output: +If you would like to contribute and create a page, just copy the [[Template]] and give it a name like [[SC1000]], and bask in unending appreciation from shell scripters world wide! -console -$ shellcheck myevent -In myevent line 11: +--- - SC1111: Include whitespace after the here-doc end token. +Are you a robot or web crawler? See [https://www.shellcheck.net/wiki/](https://www.shellcheck.net/wiki/) for a list of all available [search engine indexable copies of pages](https://github.com/github/feedback/discussions/4992) of the [GitHub Wiki](https://github.com/koalaman/shellcheck/wiki). - -and it's too terse or you're not sure whether it applies, you can read more on this wiki page: [[SC1111]]. - -[ShellCheck.com](http://www.shellcheck.com), you can just click the error code to go to this page. - - -If you would like to contribute and create a page, just copy the [[Template]] and give it a name like [[SC1111]], and bask in unending appreciation from shell users world wide! - - - -Are you a robot or web crawler? See [https://www.shellcheck.com](https://www.shellcheck.com) for a list of all available [search engine indexable copies of pages](https://github.com/github/feedback/discussions) of the [GitHub](https://github.com/shellcheck). - -Looking for tips and tricks, or have one to share? Check out [[End]]! \ No newline at end of file +Looking for tips and tricks, or have one to share? Check out [[Contrib]]! \ No newline at end of file