Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

just-comments

Package Overview
Dependencies
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

just-comments - npm Package Compare versions

Comparing version 0.5.1 to 0.5.2

16

API.md

@@ -18,3 +18,3 @@ # just-comments API

### *method* parse()
### parse()
```typescript

@@ -36,3 +36,3 @@ parse(): void

### *method* openScope()
### openScope()
```typescript

@@ -51,3 +51,3 @@ openScope(charCode: number, offset: number, lineNum: number, charNum: number): void

### *method* closeScope()
### closeScope()
```typescript

@@ -66,3 +66,3 @@ closeScope(charCode: number, offset: number, lineNum: number, charNum: number): void

### *method* beginComment()
### beginComment()
```typescript

@@ -80,3 +80,3 @@ beginComment(startOffset: number, lineNum: number, charNum: number): void

### *method* endComment()
### endComment()
```typescript

@@ -93,3 +93,3 @@ endComment(nextOffset: number, lineNum: number): void

### *method* endCommentBlock()
### endCommentBlock()
```typescript

@@ -108,3 +108,3 @@ endCommentBlock(targetLineOffset: number, targetLineNum: number): void

### *method* endOfComments()
### endOfComments()
```typescript

@@ -116,3 +116,3 @@ endOfComments(): void

### *method* fatalError()
### fatalError()
```typescript

@@ -119,0 +119,0 @@ fatalError(message: string, offset: number, lineNum: number, charNum: number): void

{
"name": "just-comments",
"version": "0.5.1",
"version": "0.5.2",
"description": "Lightweight JS/TS comment parser that points to the targeted code",

@@ -5,0 +5,0 @@ "main": "build/src/index.js",

@@ -9,3 +9,3 @@ # just-comments

The parser also reports the location of the code that each comment appears to be characterizing, as well as the locations of each possible change in code scope.
The parser also reports the location of the code that each comment appears to be characterizing, as well as the locations of each possible change in code scope. This feature facilitates extracting comments to generate code documentation or identifying the code to which comment-based directives apply.

@@ -131,4 +131,5 @@ Includes support for comments nested within ES6 template literals.

* A multi-line comment that begins on a line containing non-comment source code extends the series of comments that targets the line, so that comments occurring after the multi-line comment but on the same line as the end of the multi-line comment target the same line of code as the preceding multi-line comment.
* ES6 template literals may contain nested `${...}` expressions, and comments may appear in these expressions. The parser reports these comments and their target lines, but within template literals it does not report characters thay may change code scope. Instead, the parser reports when a template literal opens and when it closes as having a scope initiated by the ` character.
* ES6 template literals may contain nested `${...}` expressions, and comments may appear in these expressions. The parser reports these comments and their target lines.
* The parser reports characters that may begin or end code scopes to facilitate client apps that may subsequently parse non-comment source code. This helps keep clients from having to determine whether these characters occur within quotes, template literals, or regular expressions.
* Within template literals, the parser does not report characters thay may change code scope. Instead, the parser reports when a template literal opens and when it closes as having a scope initiated by the ` character.

@@ -135,0 +136,0 @@ ## License

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc