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.

Sign up for GitHub

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

docs: add changelog note about typescript #1414

Merged
merged 2 commits into from
Sep 6, 2020
Merged

docs: add changelog note about typescript #1414

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
41897d7
docs: add changelog note about typescript
davidjgoss Aug 28, 2020
a88487c
shorten message
davidjgoss Aug 31, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

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

I think this could be shortened to:

Now includes Typescript type definitions, deprecating the need for @types/cucumber in TypeScript projects

Thoughts?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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.


#### Breaking changes

Expand Down