Package Exports

parse-annotation-blocks

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (parse-annotation-blocks) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

parse-annotation-blocks

ES6 string splitting by annotated comments. Parse blocks of text wrapped in annotated comments to a JS object.

For example, if your string contains:

/* @start someKey */ 
Some content 
/* @end someKey */

The module will extract the text between the @start and @end comments and return an object like:

{
    someKey: "Some content" 
}

Installation

npm install parse-annotation-blocks

yarn add parse-annotation-blocks

Usage

An example:

let parseAnnotations = require('parse-annotation-blocks');

let string = `
  /* @start firstKey */  
  Lorem ipsum dolor sit amet, consectetur adipiscing elit. 
  /* @end firstKey */

  
  /* @start secondKey */
  Sed at est pellentesque ante ultricies aliquet aliquam a tellus. Donec eget urna velit. Mauris ac scelerisque lacus. 
  /* @end secondKey */
  
  This is outside a comment @start and @end block, so won't get included in the returned object. 
  `

let outputObject = parseAnnotations(string);

Credits

https://github.com/rjjakes

License

MIT