search

ckaznocha / SublimeLinter-contrib-CFLint

SublimeLinter plugin for Adobe ColdFusion, using CFLint.
MIT License
16 stars 9 forks source link

Include link to lint rules #22

Open redtopia opened 6 years ago

redtopia commented 6 years ago

Out of the box, cflint is fairly opinionated about coding style, which can add quite a bit of lint to an ordinary CFML file. It took me a while to track down the lint rules and how to apply them so that cflint becomes more useful. My suggestion would be to include a link to the rules document (https://github.com/cflint/CFLint/blob/dev/RULES.md) and an example .cflintrc file, like:

{
    "output": [],
    "rule": [],
    "excludes": [],
    "includes": [{
        "code": "MISSING_VAR"
    },{
        "code": "OUTPUT_ATTR"
    },{
        "code": "AVOID_USING_STRUCTNEW"
    },{
        "code": "AVOID_USING_ARRAYNEW"
    },{
        "code": "UNUSED_LOCAL_VARIABLE"
    },{
        "code": "SQL_SELECT_STAR"
    }],
    "inheritParent": false,
    "inheritPlugins": true
}