grunt-copy-part-of-file
Version:
This plugin helps me copy a section from 1 file to another. I use it with angularjs to keep my index.html and my index-e2e.html file in sync
147 lines (115 loc) • 4.08 kB
Markdown
# grunt-copy-part-of-file
> This grunt tasks will copy a portion of one file and insert it into another file. I use this to keep my angular index.html file in sync with my index-e2e.html file rather than trying to manually copy all the scripts each time the index.html changes.
## Getting Started
This plugin requires Grunt `~0.4.1`
If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
```shell
npm install grunt-copy-part-of-file --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-copy-part-of-file');
```
## The "copy_part_of_file" task
### Overview
In your project's Gruntfile, add a section named `copy-part-of-file` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
copy_part_of_file: {
simple_replace_scripts: {
options: {
sourceFileStartPattern: '<!-- SIMPLE START -->',
sourceFileEndPattern: '<!-- SIMPLE END -->',
destinationFileStartPattern: '<!-- START -->',
destinationFileEndPattern: '<!-- END -->'
},
files: {
'test/fixtures/simple-destination.html': ['test/fixtures/simple-source.html']
}
}
},
})
```
### Options
#### options.soureFileStartPattern
Type: `String`
Default value: `A STRING OR REGEX`
A string or regexp value that is used to match part of the source file and start to copy the content at this line.
#### options.soureFileEndPattern
Type: `String`
Default value: `A STRING OR REGEX`
A string or regexp value that is used to match part of the source file and stop copying at this line.
#### options.destinationFileStartPattern
Type: `String`
Default value: `A STRING OR REGEX`
A string or regexp value that is used to match part of the destination file and begin to copy the source matched above below this spot.
#### options.destinationFileEndPattern
Type: `String`
Default value: `A STRING OR REGEX`
A string or regexp value that is used to match part of the destination file and stop coping the source matched above at this line.
#### Example Usage
In this example I use the following config and source content to create the destination content
#### Grunt Config
```js
grunt.initConfig({
copy_part_of_file: {
simple_replace_scripts: {
options: {
sourceFileStartPattern: '<!-- SIMPLE START -->',
sourceFileEndPattern: '<!-- SIMPLE END -->',
destinationFileStartPattern: '<!-- START -->',
destinationFileEndPattern: '<!-- END -->'
},
files: {
'test/fixtures/simple-destination.html': ['test/fixtures/simple-source.html']
}
}
},
})
```
#### Source File ( referenced as test/fixtures/simple-source.html in config above )
```html
<html>
<!-- SIMPLE START -->
<head>
<title></title>
</head>
<!-- SIMPLE END -->
<body>
</body>
</html>
```
#### Destination File ( referenced as test/fixtures/simple-destination.html in config above )
```html
<html>
<head>
<title></title>
</head>
<body>
<!-- START -->
<!-- END -->
</body>
</html>
```
##Final Destination File After Task Runs ( Not that anyone would do this...but two heads are better than one. )
```html
<html>
<head>
<title></title>
</head>
<body>
<!-- START -->
<head>
<title></title>
</head>
<!-- END -->
</body>
</html>
```
## 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](http://gruntjs.com/).
## Release History
0.1.0 - First release...supports what I need it to do.