parser-js icon indicating copy to clipboard operation
parser-js copied to clipboard

Integrate eslint plugin for jsdoc validation and fix potential issues

Open derberg opened this issue 4 years ago • 10 comments

Reason/Context

We rely on JSDoc not only to generate API ref docs but now also to generate TypeScript types. We should take case for the quality of those.

Description

Please try answering few of those questions

  • integrate https://www.npmjs.com/package/eslint-plugin-jsdoc with eslint
  • fix potential issues

derberg avatar Aug 24 '20 17:08 derberg

video about the issue https://youtu.be/Iqs_2BiNEEo?t=1996

derberg avatar Oct 01 '20 07:10 derberg

This issue has been automatically marked as stale because it has not had recent activity :sleeping: It will be closed in 30 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation. Thank you for your contributions :heart:

github-actions[bot] avatar Dec 01 '20 00:12 github-actions[bot]

This issue has been automatically marked as stale because it has not had recent activity :sleeping: It will be closed in 60 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation. Thank you for your contributions :heart:

github-actions[bot] avatar Jan 31 '21 00:01 github-actions[bot]

@derberg Can I pick up this one?

arjungarg07 avatar May 21 '21 22:05 arjungarg07

This issue has been automatically marked as stale because it has not had recent activity :sleeping: It will be closed in 60 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation. Thank you for your contributions :heart:

github-actions[bot] avatar Jul 21 '21 00:07 github-actions[bot]

This issue has been automatically marked as stale because it has not had recent activity :sleeping: It will be closed in 60 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation. Thank you for your contributions :heart:

github-actions[bot] avatar Sep 20 '21 00:09 github-actions[bot]

@arjungarg07 looks like another good candidate for October, you have work started, some comments recently from the community in the PR. Might be good to open fresh Hacktoberfest PR 😄

derberg avatar Sep 20 '21 11:09 derberg

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

github-actions[bot] avatar Jan 19 '22 00:01 github-actions[bot]

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

github-actions[bot] avatar May 20 '22 00:05 github-actions[bot]

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

github-actions[bot] avatar Sep 18 '22 00:09 github-actions[bot]

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

github-actions[bot] avatar Feb 01 '23 00:02 github-actions[bot]

Hi @derberg, I want to pick this up. Can I start working on it?

pragya-20 avatar Mar 27 '23 13:03 pragya-20

@pragya-20 thanks for pinging

I will close this issue. From the past I know one contributor spent a lot of time trying to fix it. Better just accept what we have and wait for 2.0 that is in active development and will be rewrite this parser to TS, so no more meed of testing jsdoc

derberg avatar Mar 28 '23 16:03 derberg