Document #nosec use with a list of rules

Extend the readme to document the ability to prevent some, but not all, rules from being enforced within an AST node.
This commit is contained in:
John Martinez 2018-07-31 16:22:19 -04:00 committed by GitHub
parent 639987a295
commit 0d2e16dfa3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -96,6 +96,8 @@ func main(){
```
When a specific false positive has been identified and verified as safe, you may wish to suppress only that single rule (or a specific set of rules) within a section of code, while continuing to scan for other problems. To do this, you can list the rule(s) to be suppressed within the `#nosec` annotation, e.g: `/* #nosec G401 */` or `// #nosec G201 G202 G203 `
In some cases you may also want to revisit places where #nosec annotations
have been used. To run the scanner and ignore any #nosec annotations you
can do the following: