Created SC1126 (markdown)

koalaman
2017-11-04 15:57:37 -07:00
parent e6abcc4d88
commit 1ed8b23e8f

23
SC1126.md Normal file

@@ -0,0 +1,23 @@
## Place shellcheck directives before commands, not after.
### Problematic code:
```sh
var=1 # shellcheck disable=SC2034
```
### Correct code:
```sh
# shellcheck disable=SC2034
var=1
```
### Rationale:
ShellCheck expects directives to come before the relevant command. They are not allowed after.
### Exceptions:
If this is not a directive and just a comment mentioning ShellCheck, please rewrite or capitalize:
var=1 # ShellCheck encourages lowercase variable names