https://github.com/owlbertz/lintworm
Gulp plugin to lint files.
https://github.com/owlbertz/lintworm
gulp gulp-plugins linting
Last synced: 5 months ago
JSON representation
Gulp plugin to lint files.
- Host: GitHub
- URL: https://github.com/owlbertz/lintworm
- Owner: Owlbertz
- Created: 2017-11-22T20:56:13.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-27T20:07:38.000Z (over 8 years ago)
- Last Synced: 2025-08-09T09:57:51.913Z (7 months ago)
- Topics: gulp, gulp-plugins, linting
- Language: JavaScript
- Size: 12.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://nodei.co/npm/lintworm/)
# Lintworm
Gulp plugin to lint all kind of files based on keywords.
## Usage
Install Lintworm using npm:
```
npm install lintworm --save-dev
```
Then use it in your Gulp tasks:
```javascript
var gulp = require('gulp');
var lintworm = require('lintworm');
gulp.task('lintworm', function() {
return gulp.src(['./src/**/*'])
.pipe(lintworm(strings, options));
});
```
## Parameter
The following parameter can be passed to the plugin:
### strings
The strings to find in the given files.
This can either be flat array of strings or regular expressions:
```javascript
['TODO', /[Ff]ixme/]
```
or it can be an array of objects:
```javascript
[{
string: 'TODO',
level: 'error' // Override default level for this string
file: 'src/*.js' // Specify files to check with this keyword using glob pattern
}]
```
### options
The following options can be passed additionally:
#### level
The default level of reported findings.
Default value is `'warn'`.
#### failOnError
Whether the task should fail if at least one finding with error level is found.
Default value is `true`.
## Full example
The following gulp-task
```javascript
var gulp = require('gulp');
var lintworm = require('lintworm');
gulp.task('lintworm', function() {
return gulp.src(['./src/**/*'])
.pipe(lintworm([
// Warn for TODOs in general
'TODO',
// Warn for @ts-ignore statements that contain an explanation
/@ts-ignore\s+\w+/,
// Error on @ts-ignore statements that do not contain an explanation
{string: /@ts\-ignore$/, level: 'error'},
// Warn on skipped tests in spec-files
{string: 'skip', level: 'warn', file: '*.spec.ts'}
]));
});
```
might output this:
```
/path/to/files/src/index.js (2)
[25] // TODO: A dynamically upper bound is required.
[30] // @ts-ignore
------------------------------------------------------------
Found 1 error and 1 warning.
```