grunt-path-validator
v2.0.2
Published
Validate that file names match given globs
Downloads
8
Maintainers
Readme
grunt-path-validator
Validate that file names match given globs
Getting Started
This plugin requires Grunt ~0.4.5
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-path-validator --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-path-validator');
The "path_validator" task
Overview
grunt-path-validator
uses the Grunt file matching pattern.
In your project's Gruntfile, add a section named path_validator
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
path_validator: {
your_target: {
// Target-specific file lists and/or options go here.
}
}
});
Usage Examples
Fail if any javascript file name has an upper case character.
grunt.initConfig({
path_validator: {
js: {
src: ['**/*[A-Z]*.js']
}
}
});
Excludes
Fail if any javascript file includes underscores. Don't search in node_modules
.
grunt.initConfig({
path_validator: {
not_node_modules: {
src: [
'**/*_*.js',
'!**/node_modules/**/*.js'
]
}
}
});
Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.
Release History
See the releases page.