# cflint

> CFLint is a tool for identifying and reporting on patterns found in CFML code.

Latest version **1.5.0** (published 2020-03-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install cflint
pnpm add cflint
yarn add cflint
bun add cflint
```

Provides the command `cflint`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; large bundle.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.5.0 |
| Published | 2020-03-17 |
| First published | 2017-05-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 19.8 MB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Morgan Dennithorne |
| Maintainers | morgdenn, msp1kpj |

## Links

- npm: https://www.npmjs.com/package/cflint
- Repository: https://github.com/morgdenn/npm-cflint
- Homepage: https://github.com/morgdenn/npm-cflint#readme
- Issues: https://github.com/morgdenn/npm-cflint/issues
- npm.io page: https://npm.io/package/cflint

## Dependencies (3)

- [shelljs](https://npm.io/package/shelljs.md) ^0.7.8
- [find-config](https://npm.io/package/find-config.md) ^1.0.0
- [find-java-home](https://npm.io/package/find-java-home.md) ^0.2.0

## Recent versions

- 1.5.0 (latest) — 2020-03-17
- 1.0.2 — 2018-10-16
- 1.0.0 — 2018-08-12
- 0.0.9 — 2018-01-11
- 0.0.8 — 2017-08-03
- 0.0.7 — 2017-08-03
- 0.0.6 — 2017-08-01
- 0.0.5 — 2017-07-10
- 0.0.4 — 2017-07-10
- 0.0.3 — 2017-07-10
- 0.0.2 — 2017-06-27
- 0.0.1 — 2017-05-10

## README

# CFLint

CFLint is a tool for identifying and reporting on patterns found in CFML code.

This is NPM wrapper for the actual CFLint project [https://github.com/cflint/CFLint](https://github.com/cflint/CFLint)

A big thank you to the CFLint team for all their work :thumbsup:

### Global Installation and Usage

If you want to make CFLint available to tools that run across all of your projects, we recommend installing CFLint globally. You can do so using npm:

```
$ npm install -g cflint
```

You should then setup a configuration file (The '-init' argument is only part of the NPM wrapper).

```
$ cflint -init
```

After that, you can run CFLint on any file or directory like this:

```
$ cflint -file yourfile.cfm
$ cflint -folder ./
```

Check out [https://github.com/cflint/CFLint#user-manual](https://github.com/cflint/CFLint#user-manual) for all the documentation.

## Quick Configuration

When you run CFLint it will search the current directory and parent directories for a ".cflintrc" file.  If found it will automaticly use that configuration.

After running `cflint -init`, you'll have a `.cflintrc` file in your directory. In it, you'll see some rules configured like this:

```json
{
  "rule" : [ ],
  "excludes" : [ ],
  "includes" : [ { } ],
  "inheritParent" : false,
  "parameters":{}
}
```

The default configuration will only find parsing errors.  All other rule are excluded, this is done by setting "includes" to an empty object.
To include all rules again change "includes" to an empty array.

All the rules can be found here: [https://github.com/cflint/CFLint/blob/master/RULES.md](https://github.com/cflint/CFLint/blob/master/RULES.md)

---
_Source: https://npm.io/package/cflint · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._