JSPM

comments-parser

1.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 129
  • Score
    100M100P100Q73194F
  • License MIT

This scripts extracts comments from JavaScript code

Package Exports

  • comments-parser

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 (comments-parser) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

node-comments-parser

Description

This scripts extracts comments from JavaScript code. It's built on esprima.

Example

This script will transform example.js:

'use strict';

/**
 * Class description
 * @class Test
 * @constructor
 */
function Test() {
  
}

Test.prototype = {
  /**
   * 
   * @param {string} text
   */
  log: function(text) {
    console.log(text);
  }
};

module.exports = Test;

to Object:

[
  {
    start: 3,
    end: 7,
    jsDoc: true,
    lines: [ 'Class description' ],
    tags: [
      { name: 'class',       value: 'Test' },
      { name: 'constructor', value: true   }
    ]
  },
  {
    start: 13,
    end: 16,
    jsDoc: true,
    lines: [],
    tags: [
      { name: 'param', value: '{string} text' }
    ]
  }
]

Installation

Install with npm:

npm install node-comments-parser

Usage

var fs     = require('fs');
var parser = require('comments-parser');

var source = fs.readFileSync(__dirname + '/example.js', 'utf-8');
var comments = parser(source);

// Test parsed data
expect(comments[0].lines).to.equal([ 'Class description' ]);

Options

parser(options:Object):

Name Default Description
addEsprimaInfo false Add esprima parser data to a comment
parseJsDocTags true If false jsdoc tags processed as text
hideJsDocTags true If parseJsDocTags is true remove tags from lines property
trim true Trim lines, values: true, false, 'right'

License

Licensed under MIT.