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

chore: rename next to done #2786

Merged
merged 1 commit into from
Jan 12, 2021

Conversation

ryhinchey
Copy link
Contributor

the callback used in fastify plugins is called done throughout the docs; however, next is used in the Typescript type. This PR updates the type to be consistent with the documentation

Checklist

@giulianok
Copy link

@ryhinchey this is awesome! I personally don't really care how the parameter is being called in the application side, but it would be great to have consistency in the docs, examples, code, tests, etc.

Maybe this PR could be used to change all the next references to done? https://github.com/fastify/fastify/search?p=3&q=next. I found that tests and examples are also using next

@ryhinchey
Copy link
Contributor Author

ryhinchey commented Jan 11, 2021

@giulianok yah I'm happy to do that in this PR if the fastify team is on board with a PR changing so many files :)

@Ethan-Arrowood
Copy link
Member

I'm 👍 for consistency. I don't believe this is a breaking change since its just function arguments (which can be named anything).

@ryhinchey ryhinchey force-pushed the typescript-done-plugin-callback branch from bb44995 to ce54641 Compare January 11, 2021 18:10
@ryhinchey ryhinchey changed the title chore(typescript): rename next to done chore: rename next to done Jan 11, 2021
@Ethan-Arrowood
Copy link
Member

Ethan-Arrowood commented Jan 11, 2021

Haha so there seems to be no consistency throughout the repo, nice fix! How do other maintainers feel about this? Would you rather us use next instead?

@ryhinchey ryhinchey force-pushed the typescript-done-plugin-callback branch from ce54641 to fef678e Compare January 11, 2021 19:22
Copy link
Member

@Eomm Eomm left a comment

Choose a reason for hiding this comment

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

image

@Eomm Eomm added the chore Small changes or internal project maintenance label Jan 11, 2021
Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

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

lgtm

This is massive work, thanks.

LGTM

Copy link
Member

@RafaelGSS RafaelGSS left a comment

Choose a reason for hiding this comment

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

LGTM.

Copy link
Member

@jsumners jsumners left a comment

Choose a reason for hiding this comment

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

I can't go through this line by line. But I'm on board.

@mcollina mcollina merged commit 7edf500 into fastify:master Jan 12, 2021
@github-actions
Copy link

github-actions bot commented Feb 4, 2022

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 4, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
chore Small changes or internal project maintenance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants