package
Updates a section inside a file with newer content while removing the old content.
npm install update-sectionGitHub-flavored package documentation.
Across all versions, last 30 days.
645,825 in 30 days
Runtime metadata.
Tagged topics.

Updates a section inside a file with newer content while removing the old content.
var updateSection = require('update-section');
var original = [
'# Some Project'
, ''
, 'Does a bunch of things'
, ''
, 'START -- GENERATED GOODNESS'
, 'this was painstakingly generated'
, 'as was this'
, 'END -- GENERATED GOODNESS' , ''
, ''
, '## The End'
, ''
, 'Til next time'
].join('\n');
var update = [
'START -- GENERATED GOODNESS'
, 'this was painstakingly re-generated'
,
# Some Project
Does a bunch of things
START -- GENERATED GOODNESS
this was painstakingly re-generated
and we added another line
here
END -- GENERATED GOODNESS
## The End
Til next timenpm install update-section/**
* Updates the content with the given section.
*
* If previous section is found it is replaced.
* Otherwise the section is appended to the end of the content.
*
* @name updateSection
* @function
* @param {String} content that may or may not include a previously added section
* @param {String} section the section to update
* @param {Function} matchesStart when called with a line needs to return true iff it is the section start line
* @param {Function} matchesEnd when called with a line needs to return true iff it is the section end line
* @return {String} content with updated section
*/MIT
Updates the content with the given section.
If previous section is found it is replaced. Otherwise the section is appended to the end of the content.
| Name | Type | Description |
|---|---|---|
content | String | that may or may not include a previously added section |
section | String | the section to update |
matchesStart | function | when called with a line needs to return true iff it is the section start line |
matchesEnd | function | when called with a line needs to return true iff it is the section end line |
top | boolean | forces the section to be added at the top of the content if a replacement couldn't be made |
content with updated section
Finds the start and end lines that match the given criteria. Used by update-section itself.
Use it if you need to get information about where the matching content is located.
| Name | Type | Description |
|---|---|---|
lines | Array.<string> | the lines in which to look for matches |
matchesStart | function | when called with a line needs to return true iff it is the section start line |
matchesEnd | function | when called with a line needs to return true iff it is the section end line |
with the following properties: hasStart, hasEnd, startIdx, endIdx
generated with docme