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

Jump to bottom

feat: require JSDoc in new api #50429

Merged
merged 6 commits into from Aug 3, 2023
Merged

feat: require JSDoc in new api #50429

merged 6 commits into from Aug 3, 2023

Conversation

naomi-lgbt
Copy link
Member

Checklist:

Closes #50417

@codesee-maps
Copy link
Contributor

codesee-maps bot commented May 18, 2023 •
edited

👀 Review this PR in a CodeSee Review Map

View the CodeSee Map of this change

Review these changes using an interactive CodeSee Map

Legend

CodeSee Map legend

@github-actions github-actions bot added the platform: api Server application that needs familiarity with Express, Loopback, MongoDB etc. label May 18, 2023
@naomi-lgbt
Copy link
Member Author

Okay @ojeytonwilliams if you'd like to take a peek at this:

  • Added quick JSDocs to all the exported things
  • Also added a lint script to the api because running pnpm run lint:js takes forever 🙃

@ojeytonwilliams
Copy link
Contributor

@naomi-lgbt I'll take a proper look next week, but it's looking good!

ojeytonwilliams
ojeytonwilliams requested changes May 22, 2023
View reviewed changes
Copy link
Contributor

@ojeytonwilliams ojeytonwilliams left a comment

Choose a reason for hiding this comment

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

Hey @naomi-lgbt I had play with it and have a few suggestions:

.eslintrc.json Outdated Show resolved Hide resolved
.eslintrc.json Outdated Show resolved Hide resolved
.eslintrc.json Outdated Show resolved Hide resolved
.eslintrc.json Outdated Show resolved Hide resolved
.eslintrc.json Outdated Show resolved Hide resolved
@naomi-lgbt naomi-lgbt marked this pull request as ready for review May 22, 2023 17:46
@naomi-lgbt naomi-lgbt requested a review from a team as a code owner May 22, 2023 17:46
ojeytonwilliams
ojeytonwilliams reviewed May 23, 2023
View reviewed changes
Copy link
Contributor

@ojeytonwilliams ojeytonwilliams left a comment

Choose a reason for hiding this comment

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

Thanks @naomi-lgbt, the config looks good.

When I get a chance, I'll update the comments - it gives me an excuse to understand Fastify a bit better!

ojeytonwilliams

This comment was marked as duplicate.

Sign in to view

ojeytonwilliams

This comment was marked as duplicate.

Sign in to view

ojeytonwilliams

This comment was marked as duplicate.

Sign in to view

@moT01 moT01 added the status: merge conflict To be applied to PR's that have a merge conflict and need updating label Jun 9, 2023
@naomi-lgbt naomi-lgbt removed the status: merge conflict To be applied to PR's that have a merge conflict and need updating label Jul 8, 2023
raisedadead
raisedadead reviewed Aug 3, 2023
View reviewed changes
Copy link
Member

@raisedadead raisedadead left a comment

Choose a reason for hiding this comment

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

Ooh - I love this!

image

Can we change the rule to a warning, I am assuming adding all the docs are going to take a while. This can go in as a warning for now?

@raisedadead raisedadead added the status: waiting update To be applied to PR if a maintainer/reviewer has left a feedback and follow up is needed from OP label Aug 3, 2023
@ojeytonwilliams
Copy link
Contributor

Yes and no. We convert all warnings to errors and, while we could stop doing that, I'd rather not. Warnings just get ignored.

It shouldn't take long to finish this PR, though, so I'll just crack on with it.

naomi-lgbt and others added 6 commits August 3, 2023 12:03
@naomi-lgbt @ojeytonwilliams
feat: configure jsdoc plugin
0fb725b
@naomi-lgbt @ojeytonwilliams
feat: jsdoc all the things
21df5f0
@naomi-lgbt @ojeytonwilliams
chore: apply oliver's suggestions
45c1b00 
Co-authored-by: Oliver Eyton-Williams <ojeytonwilliams@gmail.com>
@naomi-lgbt @ojeytonwilliams
fix: disable tag-lines rule
a66b628 
This keeps it from enforcing spacing or no spacing between
function description and tags.
@naomi-lgbt @ojeytonwilliams
chore: remove types from param and return tags
c307651
@ojeytonwilliams
refactor: add missing JSDocs
37ccdf3
raisedadead
raisedadead approved these changes Aug 3, 2023
View reviewed changes
Copy link
Member

@raisedadead raisedadead left a comment

Choose a reason for hiding this comment

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

Now which PRs are we looking to update once this is in? I don't want main to break if other PRs are outdated.

@ojeytonwilliams
Copy link
Contributor

#50998
#50636
#50637

are the non-draft PRs without conflicts. The others should get updated before being merged.

Do you want me to block them and then merge this?

@raisedadead raisedadead merged commit 0aa1ad0 into freeCodeCamp:main Aug 3, 2023
18 checks passed
@raisedadead
Copy link
Member

Do you want me to block them and then merge this?

No - I'll just hit the update branch on all of them. Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@raisedadead raisedadead raisedadead approved these changes

@ojeytonwilliams ojeytonwilliams ojeytonwilliams approved these changes

Assignees
No one assigned
Labels
platform: api Server application that needs familiarity with Express, Loopback, MongoDB etc. status: waiting update To be applied to PR if a maintainer/reviewer has left a feedback and follow up is needed from OP
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Require JSDocs for api
4 participants
@naomi-lgbt @ojeytonwilliams @raisedadead @moT01