Commit Graph

1328 Commits

Author SHA1 Message Date
Benjamin Gordon f6ba500d6b Add support for basic shflags semantics
The shflags command-line flags library creates variables at runtime
with a few well-defined functions.  This causes shellcheck to spit out
lots of warnings about unassigned variables, as well as miss warnings
about unused flag variables.

We can address this with two parts:

1. Pretend that the shflags global variables are predefined like other
   shell variables so that shellcheck doesn't expect users to set them.
2. Treat DEFINE_string, DEFINE_int, etc. as new commands that create
   variables, similar to the existing read, local, mapfile, etc.

Part 1 can theoretically be addresssed without this by following sourced
files, but that doesn't help if people are otherwise not following
external sources.

The new behavior is on by default, similar to automatic bats test
behavior.

Addresses #1597
2019-06-25 12:14:54 -06:00
Vidar Holen c5aa171a5f Use mappend over <> for compatibility 2019-06-24 09:02:35 -07: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 e099625e7d Remove unused ioref 2019-06-23 15:50:48 -07:00
Vidar Holen 5242e384a1 Fix error spans for shebang warnings (fixes #1620) 2019-06-23 13:49:08 -07:00
Vidar Holen 7e77bfae49 Improve message for SC2055 2019-06-23 13:48:43 -07:00
Vidar Holen 9059024de6
Merge pull request #1592 from hugopeixoto/fix/SC2016-false-positive
SC2016: Don't trigger when using empty backticks
2019-06-19 19:55:34 -07:00
Vidar Holen 0eebb50563
Merge pull request #1608 from oleg-andreyev/issue-1607
#1607 fixing brew command
2019-06-19 19:03:02 -07:00
Vidar Holen 3b5aa84757
Merge pull request #1616 from blueyed/dockerignore
Add .dockerignore
2019-06-19 18:55:49 -07:00
Daniel Hahler 200aabb63c Add .dockerignore
This explicitly defines included/copied files, to reduce the context
being sent to the Docker daemon initially.
2019-06-18 23:18:26 +02:00
Oleg Andreyev c6dcb4127a #1607 fixing brew command 2019-06-09 17:00:51 +03:00
Vidar Holen 61d2112e71 Add missing JSON1.hs 2019-06-02 13:00:38 -07:00
Vidar Holen 9f0ef5983a Optionally check for unassigned uppercase variables 2019-06-02 10:29:04 -07:00
Vidar Holen 1297ef46d7 Add JSON1 as a separate format, wrap result in an object 2019-06-02 10:28:37 -07:00
Vidar Holen f4be53eb19 Warn about [ -v var ] for POSIX sh 2019-06-02 10:28:20 -07:00
Vidar Holen 3e7c2bfec0 Warn about [ $a != x ] || [ $a != y ] 2019-06-02 09:26:54 -07:00
Hugo Peixoto 07ffcb626e SC2016: Don't trigger when using empty backticks
When using '``' or '```', it should not suggest using double quotes.
2019-05-27 11:03:24 +01:00
Vidar Holen 36bb1e7858 Mention that "-" is supported as a filename. (Fixes #1586) 2019-05-22 17:35:41 -07:00
Vidar Holen 95b1185882 Inform about ineffectual ! on commands (fixes #1531) 2019-05-22 17:14:28 -07:00
Vidar Holen 8efbecd64a Don't suggest removing braces from $((${x+1})) (fixes #1533) 2019-05-19 15:29:47 -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 f5892f2d0d (docs)Fix typo in yaml markdown
Was aligned as per TOC 2nd.  Reverted to -
2019-05-17 07:41:12 +10:00
Vidar Holen de7541e656 Merge branch 'yetamrra-require-braces' 2019-05-14 18:57:44 -07:00
Vidar Holen 861b63aa77 Specify 'variable' in require-braces 2019-05-14 18:48:41 -07:00
Benjamin Gordon 64c9c83cc8 SC2250: New optional check for braces around variable references
Always using braces makes it harder to accidentally change a variable by
pasting other text next to it, but the warning is off by default because
it's definitely a style preference.  Omit special and positional
variables from the check because appending additional characters to them
already doesn't change parsing.
2019-05-14 11:01:38 -06:00
Benjamin Gordon aa3b709b5d Track whether braces were present in T_DollarBraced
References of the form $var and ${var} both map to the same structure in
the AST, which prevents any later analysis functions from distinguishing
them.  In preparation for adding checks that need this info, add a Bool
to T_DollarBraced that tracks whether the braces were seen at parsing
time and update all references so that this change is a no-op.
2019-05-14 11:01:38 -06:00
Benjamin Gordon 0358090b3c Refactor definition of special variables.
This ensures that the parser and other places that refer to special
variables can use the same list.
2019-05-14 08:57:56 -06: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 50116e8aee Don't suggest [[..]] for sh in SC2081 (fixes #1562) 2019-05-13 20:45:53 -07:00
Vidar Holen 5ccaddbcc2 Promote `json1` as the primary JSON format 2019-05-13 19:31:55 -07:00
Vidar Holen 80b7e1e099
Merge pull request #1578 from yetamrra/tabstops
Allow variable tabstop widths
2019-05-13 19:25:01 -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 58205a3573 Emit resolved rather than apparent filename for 'source' (fixes #1579) 2019-05-12 15:55:37 -07:00
Vidar Holen 5b177d62cb Simplify docker instructions 2019-05-09 20:22:10 -07:00
Vidar Holen 0ab3a726d3 Merge branch 'efx-adjust-docker-usage' 2019-05-09 20:21:41 -07:00
Vidar Holen 2791a48444 Merge branch 'adjust-docker-usage' of https://github.com/efx/shellcheck into efx-adjust-docker-usage 2019-05-09 20:21:21 -07:00
Vidar Holen bb63d66f7c Delete trailing spaces 2019-05-09 20:17:35 -07:00
Vidar Holen d9e419d60f Add support for source-path directives (fixes #1577) 2019-05-09 19:54:41 -07:00
Vidar Holen aa4b24e458
Merge pull request #1570 from virgilwashere/readme-pandoc
docs: README: Update pandoc command to match `Setup.hs`
2019-05-09 17:38:21 -07:00
Virgil 1c7a9f8a2f
Merge branch 'master' into readme-pandoc 2019-05-09 20:32:07 +10:00
Vidar Holen 2521c1cf56 Tweak README 2019-05-08 18:04:51 -07:00
Vidar Holen 65e7f2059d
Merge pull request #1571 from virgilwashere/master
docs: add Chocolatey installation method
2019-05-08 17:53:48 -07:00
Vidar Holen 248858c13e
Merge pull request #1549 from Lin-Buo-Ren/patch/snap/improve-packaging
Improve snap packaging
2019-05-08 17:35:05 -07:00
Eli Flanagan c0d4c5a106 ensure docker invocation is ephemeral
Also adjust the tag to use the `:stable` tag mentioned in the prior
line.
2019-05-07 07:48:43 -04:00
Virgil ec25fb4052 📝 add Chocolatey installation method
- [x]  add Chocolatey for Windows installation
- [x] 🚨 add language types to code blocks
2019-05-05 22:59:35 +10:00
Vidar Holen a3cd5979a2 Update message for SC2171 2019-05-04 12:54:59 -07:00
Vidar Holen 37b24cc129 Don't warn about "a"b"c" in =~ regex (fixes #1565) 2019-05-04 12:18:45 -07:00
Virgil d72a5faa1f 📝 docs: Update pandoc to match `Setup.hs`
The sdist hook in [Setup.hs](Setup.hs) disables the `smart` extension
when creating man page.
2019-05-04 16:27:44 +10:00