Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include link to lint rules #22

Open
redtopia opened this issue Nov 22, 2017 · 0 comments
Open

Include link to lint rules #22

redtopia opened this issue Nov 22, 2017 · 0 comments

Comments

@redtopia
Copy link

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
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants