# gulp-cflint

> A Gulp plugin for identifying and reporting on patterns found in CFML code.

Latest version **1.0.3** (published 2020-03-19) · ISC license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2020-03-19 |
| First published | 2017-07-31 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 5.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Morgan Dennithorne |
| Maintainers | morgdenn |

## Links

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

## Dependencies (4)

- [cflint](https://npm.io/package/cflint.md) ^1.0.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.4
- [through2](https://npm.io/package/through2.md) ^2.0.3
- [gulp-util](https://npm.io/package/gulp-util.md) ^3.0.8

## Recent versions

- 1.0.3 (latest) — 2020-03-19
- 1.0.2 — 2020-02-05
- 1.0.0 — 2018-08-12
- 0.1.1 — 2018-08-12
- 0.0.17 — 2017-08-02
- 0.0.16 — 2017-08-02
- 0.0.15 — 2017-08-02
- 0.0.14 — 2017-08-02
- 0.0.13 — 2017-08-02
- 0.0.12 — 2017-08-02
- 0.0.11 — 2017-08-02
- 0.0.10 — 2017-08-01
- 0.0.9 — 2017-08-01
- 0.0.8 — 2017-08-01
- 0.0.7 — 2017-08-01
- … 5 more at https://npm.io/package/gulp-cflint/versions

## README

# gulp-cflint
A Gulp plugin for identifying and reporting on patterns found in CFML code.

## Installation

[Use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/getting-started/what-is-npm).

```
npm install gulp-cflint --save-dev
```
## Usage

```javascript
const {src, task} = require('gulp');
const cflint = require('gulp-cflint');

const cfFiles = [
  './**/*.cf[cm]',
  '!./WEB-INF/**/*',
  '!./CFIDE/**/*'
];

task('lint:cf', () => {
  return src(cfFiles)
    .pipe(cflint());
});

task('test:cf', () => {
  return src(cfFiles)
    .pipe(cflint({ failOnError: true, quiet: true }));
});
```
## Options

### failOnError

Type: `Boolean`

Default: `true`

When `true`, Stop a task/stream if a CFLint error has been reported for any file.

### quiet

Type: `Boolean`

Default: `true`

When `false`, this option will show each file name as its proccessed.

### folder

Type: `String`

If used, the file path will be ignored and cflint will process the folder instead using the '-folder' argument.

```javascript
task('test:cf', () => {
  return src(['./index.cfm'])
    .pipe(cflint({ failOnError: true, quiet: true, folder: './system/customtags' }));
});
```
### logError

Type: `Boolean`

Default: `true`

When `true`, log parsing errors as bugs.

### maxBuffer

Type: `Number`

Default: `10000000` (10MB)

Largest amount of data in bytes allowed from the error.
When running with the folder option on a large project this might have to be ajusted.
If you exceed the limit you will get this error 'stderr maxBuffer exceeded'

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