sindresorhus / comment-regex

Regular expression for matching JavaScript comments

comment-regex

Regular expression for matching JavaScript comments

This is pretty fragile and created for performance reasons where using a real parser would be overkill.

Install

npm install comment-regex

Usage

import {commentRegex} from 'comment-regex';

// Contains a comment
commentRegex().test('/* unicorn */\nvar foo = true;');
//=> true

// Get the contents of a comment
commentRegex().exec('/* unicorn */\nvar foo = true;')[2].trim();

// Get all the comments
'/* unicorn */\nvar foo = true;\nvar unicorn = "rainbows"; // rainbow'.match(commentRegex());
//=> ['/* unicorn */', ' // rainbow']

API

The contents of the comment is in the first submatch.

commentRegex()

Returns a regex for matching line and block comments.

lineCommentRegex()

Returns a regex for matching line comments.

blockCommentRegex()

Returns a regex for matching block comments.

Important

If you run the regex against untrusted user input in a server context, you should give it a timeout.

I do not consider ReDoS a valid vulnerability for this package.

comment-regex's Issues

Some block comments are not closed properly

Would you like to support option loose for block comment that is not closed properly? EG:

/*
var test = 'test';

is actually a "valid" block comment :(

Single line RegExp incorrect

Currently the single line comment needs to be at the beginning or be preceded with whitespace to work. This is not a requirement for actual single line comments (does not need whitespace before it).