docs: add changelog note about typescript #1414
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
CHANGELOG.md
Outdated
| @@ -7,6 +7,7 @@ Please see [CONTRIBUTING.md](https://github.com/cucumber/cucumber/blob/master/CO | |||
| * Add support for Gherkin's [Rule/Example syntax](https://cucumber.io/docs/gherkin/reference/#rule) | |||
| * Add `transpose` method to [data table interface](docs/support_files/data_table_interface.md) | |||
| * Add `log` function to world, providing a shorthand to log plain text as [attachment(s)](docs/support_files/attachments.md) | |||
| * `cucumber-js` is now written in [TypeScript](https://www.typescriptlang.org/) and includes its own typings, so you no longer need to depend on `@types/cucumber` in your own TypeScript projects | |||
There was a problem hiding this comment.
I think this could be shortened to:
Now includes
Typescripttype definitions, deprecating the need for@types/cucumberin TypeScript projects
Thoughts?
There was a problem hiding this comment.
Agree that's better, updated.
I had a look at the tests from DefinitelyTyped and ran them with tsd, there are quite a few inaccuracies (e.g. things like Around and defineSupportCode that we don't export, plus some naming differences of classes and interfaces. Not sure if you think we need to call it out in the changelog, but I think TypeScript users have probably come to expect this when a library starts publishing its own types.
Closed
|
@charlierudolph all okay on this one now? |
charlierudolph
approved these changes
Sep 6, 2020
Adam-ARK
pushed a commit
to Adam-ARK/cucumber-js
that referenced
this pull request
Oct 21, 2020
* docs: add changelog note about typescript * shorten message
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.
Not sure if we should call out any differences between
@types/cucumberand our own typings. For exampleTableDefinition->DataTable.I started looking at using tsd to test the example code from DefinitelyTyped to expose the differences, going to continue with that today.
Fixes #1269