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

test: separate jsdoc tag tests #1969

Merged
merged 19 commits into from
Mar 30, 2023
Merged

Conversation

Shinigami92
Copy link
Member

In the history we had some (mostly newbie) contributors but also myself that got confused by the examplesAndDeprecations test.

This PR aims for separating the verification of each JSDoc tag into its own section, so it can faster be identified which problem occurred.

Also this improves the test in that way that for example when a @param fails, a @since tag will still get validated in the same test run.

@codecov
Copy link

codecov bot commented Mar 23, 2023

Codecov Report

Merging #1969 (741483c) into next (3562e87) will increase coverage by 0.00%.
The diff coverage is n/a.

Additional details and impacted files
@@           Coverage Diff           @@
##             next    #1969   +/-   ##
=======================================
  Coverage   99.62%   99.62%           
=======================================
  Files        2460     2460           
  Lines      240146   240146           
  Branches     1277     1278    +1     
=======================================
+ Hits       239234   239251   +17     
+ Misses        889      872   -17     
  Partials       23       23           

see 2 files with indirect coverage changes

@Shinigami92
Copy link
Member Author

Right now the loop should be swapped

yet it is: ... > verify JSDoc tags > CompanyModule > verify @deprecated tag > suffixes

it should be one of:

  1. ... > verify JSDoc tags > CompanyModule > suffixes > verify @deprecated tag
  2. ... > verify JSDoc tags > verify @deprecated tag > CompanyModule > suffixes

Copy link
Member

@ST-DDT ST-DDT left a comment

Choose a reason for hiding this comment

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

Maybe add a beforeAll(deleteTemp);

@Shinigami92 Shinigami92 marked this pull request as ready for review March 23, 2023 18:16
@Shinigami92 Shinigami92 requested a review from a team as a code owner March 23, 2023 18:16
@Shinigami92 Shinigami92 requested review from ST-DDT and a team March 23, 2023 18:16
ST-DDT
ST-DDT previously approved these changes Mar 23, 2023
@ST-DDT ST-DDT requested a review from a team March 23, 2023 18:21
@ST-DDT ST-DDT added the s: accepted Accepted feature / Confirmed bug label Mar 23, 2023
matthewmayer
matthewmayer previously approved these changes Mar 28, 2023
@ST-DDT ST-DDT requested a review from a team March 28, 2023 08:51
test/scripts/apidoc/verify-jsdoc-tags.spec.ts Outdated Show resolved Hide resolved
test/scripts/apidoc/verify-jsdoc-tags.spec.ts Show resolved Hide resolved
test/scripts/apidoc/verify-jsdoc-tags.spec.ts Outdated Show resolved Hide resolved
test/scripts/apidoc/verify-jsdoc-tags.spec.ts Outdated Show resolved Hide resolved
test/scripts/apidoc/verify-jsdoc-tags.spec.ts Outdated Show resolved Hide resolved
@Shinigami92 Shinigami92 dismissed stale reviews from matthewmayer and ST-DDT via 7b09756 March 28, 2023 15:14
ST-DDT
ST-DDT previously approved these changes Mar 28, 2023
scripts/apidoc/signature.ts Outdated Show resolved Hide resolved
@Shinigami92 Shinigami92 requested a review from ST-DDT March 29, 2023 07:40
@ST-DDT ST-DDT requested a review from a team March 29, 2023 21:33
@ST-DDT ST-DDT merged commit 063ba6e into next Mar 30, 2023
@ST-DDT ST-DDT deleted the test-separate-verify-jsdoc-tag-tests branch March 30, 2023 15:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: test p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants