comment-parser

1.4.9

Patch Changes

• 5cf5302: docs: update README to use valid subpath (and update to ESM)

1.4.8

Patch Changes

• 1f4f081: fix: update types

  refactor: use non-deprecated methods

  chore: update devDependencies and add rootDir to avoid warning

  chore: add recommended baseline-browser-mapping

  chore: disallow scripts as per latest npm guidance

1.4.7

Patch Changes

• c413827: Ensure non-optional name is only broken on equal sign if prefixed by an identifier

1.4.6

Patch Changes

• 02d3c46: Support default values on non-optional names (e.g. @property {number} BITMASK_VALUE_A=16 - description)

1.4.5

Patch Changes

• fix: skip empty lines in name tokenizer only when type is present

1.4.4

Patch Changes

• fully exclude slash-containing strings like @npm/package from tag detection @brettz9

1.4.3

Patch Changes

• Add prepare and prepublishOnly scripts to ensure build runs before publishing

1.4.2

Patch Changes

• npm audit
• ensure type, name and description on subsequent lines are properly parsed. @brettz9
• ensure type, name and description on subsequent lines are properly parsed. @brettz9
• fix .prettierignore
• add source trasformation example

• ESM compatibility improvements; fixes #159, #161

• allow for valid empty jsdoc; fixes #128

• add support for custom block markers

• reverting engine constraint back to ^12.0.0

• publishing missing fix: point package's main to .cjs file

• re-export ./util on the top-level for compatibility with older Node
• point package's main to .cjs file

• bump engines per exports issues in earlier Node versions

• keep and handle appropriately CR line endings

• process CRs as a separate .lineEnd toke

• ESM/CJS compatibility fixes

• support native ESM

• keep original CR line endings
• allow to normalize line endings with crlf transform

• drop unused variables
• add .editorconfig

• bugfix fix unsynced lib/

• export primitive type on the top level: Markers, Block, Spec, Line, Tokens, Problem

• bugfix Allow to build nested tags from name.subname even if name wasn't d
• bugfix Preserve indentation when extracting comments

• add helpers for rewiring Spec.source <-> Spec.tags.source

• split tokenizers into separate modules
• allow multiline {type} definitions - issue #109
• allow using "=>" in [name=default] defaults – issue #112
• allow using "=" in quoted [name=default] defaults – issue #112
• add tokenizers usage example - issue #111

• complete rewrite in TS with more flexible API

• distinct non-critical errors by providing err.warning

• name parsing fixes

• node 8 backward compatibility fixes

• make stringify result more close to the source

• make stringify to start each line with * in multiline comments

• ensure non-space characters after asterisk are included in source

• allow fenced blocks in tag description, see opts.fence

• document TypeScript definitions

• adjust strigifier indentation

• soft-drop node@6 support
• migrate to ES6 syntax
• allow to generate comments out of parsed data

• allow loose tag names, e.g. @.tag, @-tag

• allow quoted literal names, e.g. @tag "My Var" description

• corrected TypeScript definitions

• added TypeScript definitions
• removed readable-stream dependency

• Support for tab as separator between tag components.
• Docs: Indicate when optional is true; default property

• line wrapping control with opts.join

• tolerate inconsistent lines alignment within block

• refactored parsing, allow to not start lines with "* " inside block

• fix RegExp for description extraction to allow $ char

• use readable-stream fro Node 0.8 comatibility
• allow to pass optional parameters to parse.file(path [,opts], done)
• allow parse.stream to work with Buffers in addition to strings

• feature allow to use custom parsers
• feature always include source, no raw_value option needed
• bugfix always provide optional tag property
• refactor clean up tests

• bugfix Accept /** one line */ comments
• refactor Get rid of lodash to avoid unnecessary extra size when bundled

• feature allow spaces in default values @my-tag {my.type} [name=John Doe]

• refactor make line pasing mechanism more tolerable

• feature include source line numbers in parsed data
• feature optionally prevent dotten names expanding