documentationjs/documentation

ES6 support

Open

#29 opened on Mar 18, 2015

View on GitHub
 (4 comments) (0 reactions) (0 assignees)JavaScript (5,751 stars) (557 forks)batch import
help wanted

Description

Currently blocked by lack of parser support: http://esprima.org/doc/es6.html

Running list of things to support:

  • Switch to espree

  • JSDocs in destructuring assignment:

    { /** docs */ a, /** docs */ b } = { ... }

Contributor guide

Tech stack
javascript
Domain
documentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScriptJSDocNode.jsdocumentationjs
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
First, understand how documentationjs currently parses JSDoc comments by examining the parser integration, likely in src/parsers/. The switch to espree is already done, so focus on destructuring assignment AST nodes. Look at espree's output for destructuring patterns and identify where JSDoc comments are attached. Then modify the comment extraction logic to also capture leading comments for destructured parameters. Check existing tests for destructuring support and add similar ones. Review any comments in the issue for additional context.