https://github.com/caiogondim/gulp-filename-hint
Gulp plugin for linting filenames
https://github.com/caiogondim/gulp-filename-hint
Last synced: 3 months ago
JSON representation
Gulp plugin for linting filenames
- Host: GitHub
- URL: https://github.com/caiogondim/gulp-filename-hint
- Owner: caiogondim
- Created: 2014-12-03T13:53:11.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-03-16T03:17:14.000Z (over 7 years ago)
- Last Synced: 2025-02-26T00:37:09.498Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 204 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# gulp-filename-hint
A gulp plugin for linting filenames.
## Install
```sh
npm install --save-dev gulp-filename-hint
```
## Usage
```js
var gulp = require('gulp');
var filenameHint = require('gulp-filename-hint');
gulp.task('test', function () {
return gulp.src('src/*.js')
.pipe(filenameHint());
});
```
## API
### filenameHint(options)
#### options.regExp
Type: `RegExp`
Default: `undefined`
Only RegExp's with begin (`^`) and end (`$`) boundaries should be used.
```js
gulp.task('test', function () {
return gulp.src('src/*.js')
.pipe(filenameHint({regExp: /^\w*$/}));
});
```
#### options.whiteList
Type: `Array`
Default: `[]`
An array with allowed filenames. All names here will be automatically
interpreted as valid ones.
```js
gulp.task('test', function () {
return gulp.src('src/*.js')
.pipe(filenameHint({
regExp: /^\w*$/,
whiteList: ['README.md']
}));
});
```
---
[caiogondim.com](https://caiogondim.com) ·
GitHub [@caiogondim](https://github.com/caiogondim) ·
Twitter [@caio_gondim](https://twitter.com/caio_gondim)