# linelint

> Scan for lines that are longer than a specified limit.

Latest version **1.0.1** (published 2016-07-18) · MIT license · 0 weekly downloads

## Install

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

Provides the command `linelint`.

## 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.1 |
| Published | 2016-07-18 |
| First published | 2014-08-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Evan Shortiss |
| Maintainers | evanshortiss |
| Keywords | linelint, lint, line, width, scan, lines, check, verify |

## Links

- npm: https://www.npmjs.com/package/linelint
- Homepage: https://github.com/evanshortiss/linelint
- Issues: https://github.com/evanshortiss/linelint/issues
- npm.io page: https://npm.io/package/linelint

## Dependencies (2)

- [colors](https://npm.io/package/colors.md) ~0.6.2
- [commander](https://npm.io/package/commander.md) ~2.3.0

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2016-07-18
- 1.0.0 — 2014-12-05
- 0.0.3 — 2014-08-12
- 0.0.2 — 2014-08-09
- 0.0.1 — 2014-08-09
- 0.0.0 — 2014-08-09

## README

linelint
========

CLI & JS Library (Node.js and Browser) to scan files/text for lines that exceed 
a specified column width.


### Install
Just use npm. 

```
npm install linelint
```

### CLI Help Output
```
evan@Evans-MacBook-Pro:~/lintlint --help

  Usage: lintlint [options]

  Options:

    -h, --help            output usage information
    -l, --linelength <n>  Length that lines cannot exceed. Defaults to 80
    -V, --version         output the version number
```


### CLI Usage Example
Test all *.txt* files in the */test* directory for lines longer than 120
characters.

```
evan@Evans-MacBook-Pro:~/lintlint -l 120 ./test/*.txt

[PASS] /Users/evan/workspaces/work/linelint/test/fail-80.txt
[PASS] /Users/evan/workspaces/work/linelint/test/passing.txt
[FAIL] /Users/evan/workspaces/work/linelint/test/fail-120.txt
   Lines: 3, 5
```


### API Usage Example
Pretty easy here. Require it as you would any module and call the *verify*
function. This can also be used in the browser to scan strings of text. Using 
browserify will allow you to call this using _require_. Alternatively use one 
of the files in the _/dist_ directory.

```javascript
var linelint = require('linelint')
  , fs = require('fs');

// Invalid lines is an array of line numbers
var invalidLines = linelint.verify(fs.readFileSync('./test.js', 'utf8'));
```


### API
Scanning files via the CLI will use the 
[EOL (End of Line)](http://nodejs.org/api/os.html#os_os_eol) delimeter for the 
OS upon which you're running. In the browser "\n" will be used.

##### verify(str[, length]);
Check the contents of a string *str* have no lines longer than *length*
characters. If *length* is omitted 80 is used as a default. If you read a file
as a Buffer you must call the *toString* method on the buffer first as the
library assumes you provide a string.

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