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

adding require-jsdoc functionality per library #2555

Merged
merged 2 commits into from
Jul 26, 2020

Conversation

axelsrz
Copy link
Member

@axelsrz axelsrz commented Jul 22, 2020

Work related to #2465

This PR configure the linter to enforce code comments on public classes/methods. It divides the checks per library so it can be toggled between warn/error individually.

@axelsrz axelsrz requested review from stevengum and a team as code owners July 22, 2020 02:29
@axelsrz axelsrz requested a review from BruceHaley July 22, 2020 02:30
@coveralls
Copy link

coveralls commented Jul 22, 2020

Pull Request Test Coverage Report for Build 148851

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 81.586%

Totals Coverage Status
Change from base Build 148660: 0.0%
Covered Lines: 13373
Relevant Lines: 15633

💛 - Coveralls

Copy link
Member

@stevengum stevengum left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@stevengum stevengum merged commit 2e1b42d into master Jul 26, 2020
@stevengum stevengum deleted the axsuarez/require-jsdoc branch July 26, 2020 21:05
@chon219
Copy link
Member

chon219 commented Jul 27, 2020

@stevengum All the code analysis jobs failed with error message:

ESLint couldn't find the plugin "eslint-plugin-jsdoc". This can happen for a couple different reasons:

1. If ESLint is installed globally, then make sure eslint-plugin-jsdoc is also installed globally. A globally-installed ESLint cannot find a locally-installed plugin.

2. If ESLint is installed locally, then it's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

    npm i eslint-plugin-jsdoc@latest --save-dev

Path to ESLint package: /Users/runner/work/1/s/node_modules/eslint

If you still can't figure out the problem, please stop by https://gitter.im/eslint/eslint to chat with the team

Do you know how to resolve this? Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants