https://github.com/chiawendt/some-jsdoc-parser

A jsdoc parser.
https://github.com/chiawendt/some-jsdoc-parser

javascript jsdoc jsdoc-parser parser

Last synced: 3 months ago
JSON representation

A jsdoc parser.

• Host: GitHub
• URL: https://github.com/chiawendt/some-jsdoc-parser
• Owner: golopot
• License: mit
• Created: 2019-06-19T10:17:38.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2020-12-07T08:21:34.000Z (over 5 years ago)
• Last Synced: 2025-01-18T03:12:37.923Z (over 1 year ago)
• Topics: javascript, jsdoc, jsdoc-parser, parser
• Language: JavaScript
• Homepage:
• Size: 15.6 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![npm](https://img.shields.io/npm/v/some-jsdoc-parser.svg?style=flat)](https://www.npmjs.org/package/some-jsdoc-parser) ![build status](https://github.com/golopot/jsdoc-parser/workflows/build/badge.svg) [![codecov.io](https://codecov.io/github/golopot/jsdoc-parser/coverage.svg?branch=master)](https://codecov.io/github/golopot/jsdoc-parser?branch=master)

# some-jsdoc-parser

A hand-written jsdoc parser.

- AST format similar to estree.

- Nodes locations included.

- Typed with typescript.

## Install

```

npm install --save some-jsdoc-parser

```

## Usage

```js

const SomeJsdocParser = require('some-jsdoc-parser');

const ast = SomeJsdocParser.parse(`

/**

 * @param {string} foo - some parameter.

 * @returns {string} 

 */

`);

console.log(ast);

// {

//   type: 'JSDocComment',

//   description: null,

//   blocks: [

//     {

//       type: 'JSDocBlock',

//       tag: { type: 'JSDocTag', name: 'param', range: [ 8, 14 ] },

//       typeAnnotation: {

//         type: 'JSDocTypeAnnotation',

//         value: 'string',

//         range: [ 15, 23 ]

//       },

//       name: {

//         type: 'JSDocName',

//         name: 'foo',

//         optional: false,

//         range: [ 24, 27 ]

//       },

//       description: {

//         type: 'JSDocDescription',

//         value: '- some parameter.',

//         range: [ 28, 45 ]

//       },

//       range: [ 8, 45 ]

//     },

//     {

//       type: 'JSDocBlock',

//       tag: { type: 'JSDocTag', name: 'returns', range: [ 49, 57 ] },

//       typeAnnotation: {

//         type: 'JSDocTypeAnnotation',

//         value: 'string',

//         range: [ 58, 66 ]

//       },

//       name: null,

//       description: null,

//       range: [ 49, 66 ]

//     }

//   ],

//   range: [ 0, 71 ]

// }

```

## License

[MIT License](https://opensource.org/licenses/MIT)