comment-finder v0.1.3

comment-finder

a comment parser for code language

Features

• Support for Multiple Languages: While the library can automatically detect the language of the provided code snippet, you can also explicitly set the language to JavaScript, TypeScript, Python, and others.
• Custom Regular Expressions: The library allows users to define custom regular expressions for matching comments.
• Position Information: Optionally return the location of each comment within the source code.

Install

npm install --save comment-finder

Usage

import { parse } from 'comment-finder'

parse({
    content:`
        // this is a log
    `,
    filter:[CommentType.singleLineComment]
})

/*
output:
[
  {
    match: '// this is a log',
    startLine: 0,
    endLine: 0,
    startColumn: 0,
    endColumn: 15,
    content: ' this is a log',
    type: 0
  }
]

*/

Config

License

MIT © hcl-z