Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

require-jsdoc for ES6 class methods [$10] #4268

Closed
jacek-dargiel opened this issue Oct 27, 2015 · 5 comments

Comments

Projects
None yet
5 participants
@jacek-dargiel
Copy link

commented Oct 27, 2015

The require-jsdoc rule only supports FunctionDeclaration node type. It would be nice to have support for ES6 class methods and maybe constructors.

Did you help close this issue? Go claim the $10 bounty on Bountysource.

@eslintbot

This comment has been minimized.

Copy link

commented Oct 27, 2015

Thanks for the issue! If you're reporting a bug, please be sure to include:

  1. The version of ESLint you are using (run eslint -v)
  2. What you did (the source code and ESLint configuration)
  3. The actual ESLint output complete with numbers
  4. What you expected to happen instead

Requesting a new rule? Please see Proposing a New Rule for instructions.

@eslintbot eslintbot added the triage label Oct 27, 2015

@IanVS IanVS added enhancement rule evaluating and removed triage labels Oct 27, 2015

@nzakas nzakas added accepted and removed evaluating labels Oct 27, 2015

@nzakas

This comment has been minimized.

Copy link
Member

commented Oct 27, 2015

Seems like a good idea to add for both classes and class methods.

@nzakas nzakas changed the title require-jsdoc for ES6 class methods require-jsdoc for ES6 class methods [$10] Oct 27, 2015

@nzakas nzakas added the bounty label Oct 27, 2015

gyandeeps added a commit that referenced this issue Oct 28, 2015

@gyandeeps gyandeeps self-assigned this Oct 28, 2015

@gyandeeps

This comment has been minimized.

Copy link
Member

commented Oct 31, 2015

Do we want to check for both ClassDeclaration and ClassExpression?
As right now for functions we only check for FunctionDeclaration.

@jacek-dargiel

This comment has been minimized.

Copy link
Author

commented Nov 1, 2015

I'd say check both, but be sure to make it configurable.

@nzakas

This comment has been minimized.

Copy link
Member

commented Nov 1, 2015

Let's start with just ClassDeclaration and see what feedback we get.

gyandeeps added a commit that referenced this issue Nov 3, 2015

gyandeeps added a commit that referenced this issue Nov 16, 2015

@gyandeeps gyandeeps closed this in 4cc8326 Nov 19, 2015

nzakas added a commit that referenced this issue Nov 19, 2015

Merge pull request #4328 from eslint/issue4268
Update: Add class support to `require-jsdoc` rule (fixes #4268)

@eslint eslint bot locked and limited conversation to collaborators Feb 7, 2018

@eslint eslint bot added the archived due to age label Feb 7, 2018

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
You can’t perform that action at this time.