Migration guide for version 3.0.0 #1510
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mroderick
reviewed
Aug 3, 2017
| Codemod available at https://github.com/hurrymaplelad/sinon-codemod | ||
|
|
||
| ## `sinon.stub(object, property, value)` - Removed | ||
| The three parameter signature will now throw an exception (feature has been deprecated at `[email protected]` and has been finally removed from the codebase). |
There was a problem hiding this comment.
Nitpicking: In JavaScript, they're called arguments, so this should read something like this:
Calling
sinon.stubwith three arguments will throw anError. This was deprecated withsinon@2and has been removed withsinon@3
| `sinon.useFakeTimers()` signature has [changed](./fake-timers). To define which methods to fake, please use `config.toFake`. Other options are now available when configuring `useFakeTimers`. Please consult the [documentation](./fake-timers) for more information. | ||
|
|
||
| ## Removal of internal helpers | ||
| The following utility functions has been marked as deprecated as of `[email protected]` and were removed as planned on this release: |
There was a problem hiding this comment.
This could be more concise:
The following internal functions were deprecated as of
[email protected]and have been removed insinon@3
| breadcrumb: migrating to 3.0 | ||
| --- | ||
|
|
||
| Sinon v3.0 is the third major release, we have made several breaking changes in this release as a result of modernising the internals of Sinon. This guide is intended to walk you through the changes. |
There was a problem hiding this comment.
This could be more concise:
As with all
MAJORreleases insemver, there are breaking changes insinon@3.
This guide will walk you through those changes.
|
all done 🗡 |
|
Thank you 💯 |
|
This has become part of |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
added documentation for the migration guide
resolves #1502