Commit Graph

45 Commits

Author SHA1 Message Date
shak-mar e280116ef0 Fix syntax and indentation in shellcheck.1.md
Out of interest, I ran the command

    pandoc -s -f markdown-smart -t man shellcheck.1.md -o shellcheck.1

locally, but that produces warnings (previous to this commit).  Checking
the generated manpage, I found the diff to be rendered very badly.
(Broken at terminal width like a normal paragraph).  This commit fixes
the problem.
2019-07-12 16:52:39 +02:00
Vidar Holen b1aeee564c Add a Diff output format 2019-06-23 20:02:01 -07:00
Vidar Holen b8b4a11348 Update JSON1 docs in man page 2019-06-23 19:19:00 -07:00
Vidar Holen 9f0ef5983a Optionally check for unassigned uppercase variables 2019-06-02 10:29:04 -07:00
Vidar Holen 36bb1e7858 Mention that "-" is supported as a filename. (Fixes #1586) 2019-05-22 17:35:41 -07:00
Vidar Holen 52a9d90e1a
Merge pull request #1580 from virgilwashere/copyright
Update Copyright to year 2019; README linting
2019-05-19 12:03:15 -07:00
Virgil ea05271fa3 📝 Update Copyright to year 2019 and Markdown linting
- [x] 📝 Update Copyright to year 2019

- [x] 📝 MD009/no-trailing-spaces: Trailing spaces [Expected: 0 or 2; Actual: 1]
- [x] 📝 MD034/no-bare-urls: Bare URL used

- [ ] 📝 ~MD004/ul-style: Unordered list style [Expected: dash; Actual: asterisk]~
- [ ] ~add missing TOC entries~
2019-05-14 20:12:34 +10:00
Vidar Holen 5ccaddbcc2 Promote `json1` as the primary JSON format 2019-05-13 19:31:55 -07:00
Benjamin Gordon 50af8aba29 Add json1 format that ignores tabs
The new json1 format works just like json except that it treats tabs as
single characters instead of 8-character tabstops.

The main use case is to allow editors to pass -fjson1 so that they can
consume the json output in a character-oriented way without breaking
backwards compatibility.

Also addresses #1048.
2019-05-13 10:55:16 -06:00
Vidar Holen 5fb1da6814 Replace verbose checks with optional checks 2019-05-12 19:14:04 -07:00
Vidar Holen d9e419d60f Add support for source-path directives (fixes #1577) 2019-05-09 19:54:41 -07:00
Vidar Holen 6ccf9d6af1 Mention in manual that 'sh' means POSIX and not system 2019-04-27 17:25:20 -07:00
Vidar Holen c6c12f52bd Expand root paths into source paths 2019-04-24 18:51:24 -07:00
Vidar Holen 9652ccfdbd Add a verbose mode: `-S verbose` 2019-04-13 13:16:41 -07:00
Vidar Holen 4dfb3fce9c Add missing backtick in man page 2019-03-03 19:00:22 -08:00
Vidar Holen 581bcc3907 Add support for `.shellcheckrc` files 2019-03-03 18:57:13 -08:00
Vidar Holen 25ea405468 Fix typo in man page (fixes #1486) 2019-03-02 13:50:07 -08:00
Vidar Holen a404efab65 Merge branch 'issue_837_opposite_of_exclude_option' of https://github.com/Gandalf-/shellcheck 2019-01-22 19:39:55 -08:00
Vidar Holen 3c94d8b3eb Merge branch 'issue_1393_quiet_flag' of https://github.com/Gandalf-/shellcheck 2019-01-22 19:15:28 -08:00
Gandalf- a89403f09b Issue 1393 quiet flag
Issue https://github.com/koalaman/shellcheck/issues/1393

Provide '-q' and '--quiet' flags that suppress all normal output, but keep the
return status, similar to 'grep -q'.
2019-01-21 18:25:41 -08:00
Vidar Holen 6dcf4b8e64 Mention extension in changelog and man page 2019-01-21 16:55:01 -08:00
Gandalf- 59c47f2266 Issue 837 flag to include only certain warnings
Issue https://github.com/koalaman/shellcheck/issues/837

Add an --include option, which creates a whitelist of warnings to report
on, the opposite of --exclude.
2019-01-20 16:42:27 -08:00
Vidar Holen e0e46e979a Add wiki links to output, and a -W controlling it. (Fixes #920) 2018-10-10 21:53:43 -07:00
Martin Schwenke 3fe11927bb SQUASH: --severity specifies *minimum* severity to be handled
Signed-off-by: Martin Schwenke <martin@meltin.net>
2018-08-18 20:05:56 -07:00
Martin Schwenke b16da4b242 Add command-line option -S/--severity
Specifies the maximum severity of errors to handle.  For example,
specifying "-S warning" means that errors of severity "info" and
"style" are ignored.

Signed-off-by: Martin Schwenke <martin@meltin.net>
2018-08-18 20:05:56 -07:00
Mike Frysinger 161801a86e convert http:// URIs to https://
Also update the ShellCheck homepage to the new dedicated domain.
2017-12-14 01:06:43 -05:00
Vidar Holen 8dd40efb44 Add support for -a: emit for sourced files. 2017-08-13 19:34:45 -07:00
Dan Kegel 9c4f651e6b Document shell directive added by 944313c6 2017-04-18 09:57:38 -07:00
Vidar Holen 46fb91b44d Manually decode input files as lenient UTF-8. 2017-01-22 15:24:21 -08:00
Jakub Wilk 89572d3a96 Fix typo 2016-01-20 01:00:22 +01:00
Vidar Holen b4390414ef Fix remaining FIXME for tty error color output. 2015-12-06 12:48:53 -08:00
Vidar Holen d1df3713ca Document --color in the man page. 2015-12-05 13:16:31 -08:00
Vidar Holen f77821625c Add dash as a first class supported shell. 2015-10-13 11:37:50 -07:00
Vidar Holen 3b36c2c820 Document exit codes in man page. 2015-10-10 19:19:38 -07:00
Vidar Holen ae4aea4530 Adds support for a SHELLCHECK_OPTS environment variable. 2015-08-22 13:15:10 -07:00
Vidar Holen a01862bc12 Adds a #shellcheck source=file directive to override source statements. 2015-08-19 19:09:55 -07:00
Vidar Holen 136b654867 Update man page with info for -x. 2015-08-16 18:20:08 -07:00
Vidar Holen f86d68bcc0 Fixed incorrectly documented flag syntax for -V. 2015-06-30 19:10:41 -07:00
Vidar Holen 1e65d36874 Included copyright information in the man page. 2015-06-30 19:07:08 -07:00
Vidar Holen ed56a837c3 Killed Zsh support 2015-03-20 10:03:56 -07:00
Vidar Holen 8494509150 Warn about missing shebangs. 2014-08-09 17:32:42 -07:00
Vidar Holen 9dfeb6b42a Added -s to the man page 2014-02-02 21:56:04 -08:00
Vidar Holen 16bd52333a man page: Added Directives section 2014-01-19 12:36:48 -08:00
Vidar Holen 78d9a7ad97 Tweaked man page format 2013-12-15 19:40:05 -08:00
Dridi Boukelmoune 91fc4a046c Added a shellcheck(1) man page
The manual is mainly a copy/paste from the current documentation. It is
builded with pandoc, and written in markdown.

closes #50
2013-12-16 00:04:31 +01:00