{"_id":"56fbe112698bea2b00de70c9","user":"542975351215fe08007e0e85","githubsync":"","category":{"_id":"56fbe112698bea2b00de70c3","__v":0,"version":"56fbe112698bea2b00de70c2","project":"56d60e96b939870b00512bf3","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-01T21:50:15.983Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"__v":1,"project":"56d60e96b939870b00512bf3","version":{"_id":"56fbe112698bea2b00de70c2","hasDoc":true,"project":"56d60e96b939870b00512bf3","hasReference":true,"__v":1,"createdAt":"2016-03-30T14:22:10.357Z","releaseDate":"2016-03-30T14:22:10.357Z","categories":["56fbe112698bea2b00de70c3","56fbe112698bea2b00de70c4"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.0.5","version":"0.0.5"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-04T17:30:10.897Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":4,"body":"PerfLint will only return results for rules that fail.\n\nSee [Configuring PerfLint](doc:configuring-perflint) on how to setup the pass conditions and error level for rules.\n\nFor a list of available rules see the [Rules](doc:rules) documentation.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Exit Codes\"\n}\n[/block]\nA nonzero exit code will trigger if a rule marked as an 'error' fails checks. If   [`--maxWarnings`](https://perflint.readme.io/docs/command-line-interface#-w-maxwarnings-int) is set, a nonzero exit code will be triggered if the number of rules specified as 'warnings' exceeds or is equal to the maximum number defined.\n\nA zero exit code will be triggered if all rules pass checks or if only rules flagged as 'warnings' fail. See docs on  [`--maxWarnings`](https://perflint.readme.io/docs/command-line-interface#-w-maxwarnings-int) to set the maximum number of warnings allowed.\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Formatting\"\n}\n[/block]\nSee [--format](https://perflint.readme.io/docs/command-line-interface#-f-format-string) documentation on how to change the formatting of the results.\n\n## Formatters\n\n* [Stylish](doc:stylish)\n* [JSON](doc:json)","excerpt":"","slug":"results","type":"basic","title":"Exit Codes and Results"}

Exit Codes and Results


PerfLint will only return results for rules that fail. See [Configuring PerfLint](doc:configuring-perflint) on how to setup the pass conditions and error level for rules. For a list of available rules see the [Rules](doc:rules) documentation. [block:api-header] { "type": "basic", "title": "Exit Codes" } [/block] A nonzero exit code will trigger if a rule marked as an 'error' fails checks. If [`--maxWarnings`](https://perflint.readme.io/docs/command-line-interface#-w-maxwarnings-int) is set, a nonzero exit code will be triggered if the number of rules specified as 'warnings' exceeds or is equal to the maximum number defined. A zero exit code will be triggered if all rules pass checks or if only rules flagged as 'warnings' fail. See docs on [`--maxWarnings`](https://perflint.readme.io/docs/command-line-interface#-w-maxwarnings-int) to set the maximum number of warnings allowed. [block:api-header] { "type": "basic", "title": "Formatting" } [/block] See [--format](https://perflint.readme.io/docs/command-line-interface#-f-format-string) documentation on how to change the formatting of the results. ## Formatters * [Stylish](doc:stylish) * [JSON](doc:json)