Package Health Score

67 / 100

security
No known security issues
popularity
Small
maintenance
Sustainable
community
Sustainable

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
1.2.10	\|	04/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.0	\|	02/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.0.16	\|	07/2017		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

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

Small

Weekly Downloads (3,005)

GitHub Stars: 214
Forks: 53
Contributors: 30

Direct Usage Popularity

The npm package remark-comments receives a total of 3,005 downloads a week. As such, we scored remark-comments popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package remark-comments, we found that it has been starred 214 times.

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

Community

Sustainable

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

With more than 10 contributors for the remark-comments repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 23
Open PR: 0
Last Release: 7 months ago
Last Commit: 7 months ago

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

We found that remark-comments demonstrates a positive version release cadence with at least one new version released in the past 12 months.

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: 7 years
Dependencies: 0 Direct
Versions: 37
Install Size: 6.93 kB
Dist-tags: 1
# of Files: 5
Maintainers: 2
TS Typings: No

remark-comments 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

remark-comments

This plugin parses custom Markdown syntax for Markdown source comments.

Syntax

You can insert comments in the Markdown source this way:

Foo&lt;--COMMENTS I am a comment COMMENTS--&gt;bar

Everything between <--COMMENTS and COMMENTS--> will be absent from the HTML output. Compiling to Markdown will preserve all comments.

AST node (see [mdast][mdast] specification)

The plugin will product the following node and add it to the MDAST syntax tree:

interface Comments &lt;: Node {
  type: "comments";
  data: {
    comment: string;
  }
}

Installation

npm:

npm install remark-comments

Configuration

Two options can be passed, as a single argument object:

{beginMarker = 'COMMENTS', endMarker = 'COMMENTS'}

Therefore, invoking this plugin this way:

  .use(remarkComments, {
    beginMarker: 'foo',
    endMarker: 'bar'
  })

will make this plugin remove what's put between <--foo and bar-->.

Usage

Dependencies:

const unified = require('unified')
const remarkParse = require('remark-parse')
const stringify = require('rehype-stringify')
const remark2rehype = require('remark-rehype')

const remarkComments = require('remark-comments')

Usage:

unified()
  .use(remarkParse)
  .use(remarkComments)
  .use(remark2rehype)
  .use(stringify)

License

FAQs

What is remark-comments?

This plugin parses custom Markdown syntax for Markdown source comments. Visit Snyk Advisor to see a full health score report for remark-comments, including popularity, security, maintenance & community analysis.

Is remark-comments popular?

The npm package remark-comments receives a total of 3,005 weekly downloads. As such, remark-comments popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is remark-comments well maintained?

We found indications that remark-comments maintenance is sustainable demonstrating some project activity. We saw a total of 30 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is remark-comments safe to use?

The npm package remark-comments 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 16 November-2024, at 13:25 (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

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

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

MONITOR APP

remark-comments

This plugin parses custom Markdown syntax for Markdown source comments. For more information about how to use this package see README

Ensure you're using the healthiest npm packages

Package Health Score

Explore Similar Packages

Security

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Popularity

Weekly Downloads (3,005)

Direct Usage Popularity

Community

Embed Package Health Score Badge

Maintenance

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Package

Readme

remark-comments

Syntax

AST node (see [mdast][mdast] specification)

Installation

Configuration

Usage

License

FAQs

What is remark-comments?

Is remark-comments popular?

Is remark-comments well maintained?

Is remark-comments safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (3,005)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

remark-comments

Syntax

AST node (see [mdast][mdast] specification)

Installation

Configuration

Usage

License

FAQs

What is remark-comments?

Is remark-comments popular?

Is remark-comments well maintained?

Is remark-comments safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues