grunt-text-grab
Grab and extract text chunks from files using regular expressions and save as a single file formated by a user defined template.
Getting Started
This plugin requires Grunt ~0.4.2
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-text-grab --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt;
The "text_grab" task
Overview
In your project's Gruntfile, add a section named text_grab
to the data object passed into grunt.initConfig()
.
grunt;
Options
options.pattern
Type: RegExp
Default value: none
A regular expression, as a string, that is used to find bits of text to extract from your files.
options.exceptions
Type: Array
Default value: none
An array of regular expressions, as strings, to exclude from the final output.
options.templateStart
Type: String
Default value: none
A string that will be prepended to the output file. Can be empty.
options.templateRow
Type: String
Default value: none
This is the bit of the template that gets repeated on each match. Must contain the ´%s´ symbol as the placeholder for grabbed chunks.
options.templateEnd
Type: String
Default value: none
A string that will be appended to the output file. Can be empty.
Usage Examples
In this example we'll be extracting from style.css
all CSS class selectors with the exception of any containing the exception
expression and writing them as an HTML table with single selector per row.
grunt;
Contributing
In lieu of a formal style guide, 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
(Nothing yet)