update-section

v0.3.3

Updates a section inside a file with newer content while removing the old content. For more information about how to use this package see README

Latest version published 11 years ago

License: MIT

Package Health Score

47 / 100

security
No known security issues
popularity
Recognized
maintenance
Inactive
community
Limited

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
0.2.0	\|	03/2014		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.3.3	\|	03/2014	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.2	\|	01/2014		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

No

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (91,708)

GitHub Stars: 3
Forks: 0
Contributors: 1

Direct Usage Popularity

The npm package update-section receives a total of 91,708 downloads a week. As such, we scored update-section popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package update-section, we found that it has been starred 3 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 1
Funding: Yes

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like update-section is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 1
Open PR: 0
Last Release: 11 years ago
Last Commit: 11 years ago

Further analysis of the maintenance status of update-section based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for update-section is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 11 years
Dependencies: 0 Direct
Versions: 9
Install Size: 0 B
Dist-tags: 1
# of Files: 0
Maintainers: 1
TS Typings: No

update-section has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

update-section

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'
  , 'and we added another line'
  , 'here'
  , 'END -- GENERATED GOODNESS'
].join('\n');

function matchesStart(line) {
  return (/START -- GENERATED GOODNESS/).test(line);  
}

function matchesEnd(line) {
  return (/END -- GENERATED GOODNESS/).test(line);  
}

var updated = updateSection(original, update, matchesStart, matchesEnd);
console.log(updated);

Output

# 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 time

Installation

npm install update-section

API

updateSection(content, section, matchesStart, matchesEnd)

/**
 * 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
 */

License

MIT

updateSection(content, section, matchesStart, matchesEnd, top) → {String}

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.

Parameters:

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

Source:

update-section.js , lineno 44

Returns:

content with updated section

Type: String

updateSection::parse(lines, matchesStart, matchesEnd) → {object}

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.

Parameters:

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

Source:

update-section.js , lineno 3

Returns:

with the following properties: hasStart, hasEnd, startIdx, endIdx

Type: object

generated with docme

update-section development dependencies

FAQs

What is update-section?

Updates a section inside a file with newer content while removing the old content. Visit Snyk Advisor to see a full health score report for update-section, including popularity, security, maintenance & community analysis.

Is update-section popular?

The npm package update-section receives a total of 91,708 weekly downloads. As such, update-section popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is update-section well maintained?

We found indications that update-section is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is update-section safe to use?

The npm package update-section was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 31 October-2024, at 07:18 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected