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

Fix the return type of format: string -> Promise<string> #751

Merged
merged 1 commit into from
May 26, 2022

Conversation

IronBlood
Copy link
Contributor

The function declaration was changed in #696 from function format(options) to async function(options), the example section in README.md is changed as well, but the doc as well as the later added types/index.d.ts from #739 was not updated.

@codecov-commenter
Copy link

codecov-commenter commented May 25, 2022

Codecov Report

Merging #751 (ae3227c) into master (26a574c) will not change coverage.
The diff coverage is n/a.

❗ Current head ae3227c differs from pull request most recent head 841590e. Consider uploading reports for the commit 841590e to get more accurate results

@@           Coverage Diff           @@
##           master     #751   +/-   ##
=======================================
  Coverage   99.66%   99.66%           
=======================================
  Files           2        2           
  Lines         298      298           
  Branches       88       88           
=======================================
  Hits          297      297           
  Misses          1        1           
Impacted Files Coverage Δ
src/index.js 99.20% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 26a574c...841590e. Read the comment docs.

@idahogurl idahogurl self-requested a review May 25, 2022 20:32
Copy link
Collaborator

@idahogurl idahogurl left a comment

Choose a reason for hiding this comment

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

This is great but your commit message needs to follow the convention of conventional commits since we use semantic-release to handle our release versioning. https://www.conventionalcommits.org/

Could you please fix the commit message?

The return type was not updated when format function was changed to
an async function. This patch changes the type from `string` to
`Promise<string>`, this only affects language servers.
@IronBlood IronBlood force-pushed the fix/return-type-of-format branch from ae3227c to 841590e Compare May 26, 2022 15:58
@IronBlood
Copy link
Contributor Author

Sorry for making troubles, this is my first time of learning the concept of Conventional Commits. Does the commit message now look good?

@idahogurl idahogurl merged commit d6ef389 into prettier:master May 26, 2022
@github-actions
Copy link
Contributor

🎉 This PR is included in version 15.0.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

3 participants