Skip to content

Commit

Permalink
chore: fix some dead links (#2259)
Browse files Browse the repository at this point in the history
  • Loading branch information
davidjgoss committed Mar 16, 2023
1 parent 517338b commit 627030d
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 15 deletions.
20 changes: 10 additions & 10 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).

Please see [CONTRIBUTING.md](https://github.com/cucumber/cucumber/blob/master/CONTRIBUTING.md) on how to contribute to Cucumber.
Please see [CONTRIBUTING.md](./CONTRIBUTING.md) on how to contribute to Cucumber.

## [Unreleased]

Expand Down Expand Up @@ -221,7 +221,7 @@ Please see [CONTRIBUTING.md](https://github.com/cucumber/cucumber/blob/master/CO

## [7.3.0] - 2021-06-17
### Added
- Experimental support for [Markdown](https://github.com/cucumber/common/blob/main/gherkin/MARKDOWN_WITH_GHERKIN.md)
- Experimental support for [Markdown](https://github.com/cucumber/gherkin/blob/main/MARKDOWN_WITH_GHERKIN.md)
([#1645](https://github.com/cucumber/cucumber-js/pull/1645))

### Changed
Expand Down Expand Up @@ -284,7 +284,7 @@ Please see [CONTRIBUTING.md](https://github.com/cucumber/cucumber/blob/master/CO
- The npm module has changed name from `cucumber` to `@cucumber/cucumber` - `require`/`import` statements must be changed from `cucumber` to `@cucumber/cucumber`
- TypeScript users must rename `TableDefinition` to `DataTable`
- Drop support for Node.js 8, add support for Node.js 14
- Events are now based on [cucumber-messages](https://github.com/cucumber/cucumber/tree/master/messages)
- Events are now based on [cucumber-messages](https://github.com/cucumber/messages)
- `event-protocol` formatter has been removed and replaced with `message`
- Formatters
- Remove long-deprecated `typeName` from options object for `defineParameterType` in favour of `name`
Expand All @@ -294,7 +294,7 @@ Please see [CONTRIBUTING.md](https://github.com/cucumber/cucumber/blob/master/CO
- Custom formatters are now loaded via the regular require paths relative to the current directory, unless it begins with a dot (e.g. `--format=./relpath/to/formatter`). Previously this was always loaded as a file relative to the current directory.

### Deprecated
- `json` formatter is deprecated and will be removed in next major release. Custom formatters should migrate to use the `message` formatter, or the [standalone JSON formatter](https://github.com/cucumber/cucumber/tree/master/json-formatter) as a stopgap.
- `json` formatter is deprecated and will be removed in next major release. Custom formatters should migrate to use the `message` formatter, or the [standalone JSON formatter](https://github.com/cucumber/json-formatter) as a stopgap.

### Fixed
- don't execute BeforeAll and AfterAll hooks when in dry-run
Expand Down Expand Up @@ -383,7 +383,7 @@ Please see [CONTRIBUTING.md](https://github.com/cucumber/cucumber/blob/master/CO
- print text step attachments ([#1041](https://github.com/cucumber/cucumber-js/pull/1041), DevSide)

### Fixed
- cucumber-expressions: Upgrade from 5.0.7 to [5.0.13](https://github.com/cucumber/cucumber/blob/master/cucumber-expressions/CHANGELOG.md#5013---2018-01-21)
- cucumber-expressions: Upgrade from 5.0.7 to [5.0.13](https://github.com/cucumber/cucumber-expressions/blob/main/CHANGELOG.md#5013---2018-01-21)
- fix error serialization in parallel mode

## [4.0.0] - 2018-01-24
Expand Down Expand Up @@ -416,8 +416,8 @@ Please see [CONTRIBUTING.md](https://github.com/cucumber/cucumber/blob/master/CO
- json formatter: format step result exception ([#973](https://github.com/cucumber/cucumber-js/pull/973) Valerio Innocenti Sedili)

### Fixed
- cucumber-expressions: Upgrade from 5.0.3 to [5.0.6](https://github.com/cucumber/cucumber/blob/master/cucumber-expressions/CHANGELOG.md#506---2017-11-28)
- tag-expressions: Upgrade from 1.0.1 to [1.1.1](https://github.com/cucumber/cucumber/blob/master/tag-expressions/CHANGELOG.md#111---2017-12-01)
- cucumber-expressions: Upgrade from 5.0.3 to [5.0.6](https://github.com/cucumber/cucumber-expressions/blob/main/CHANGELOG.md#506---2017-11-28)
- tag-expressions: Upgrade from 1.0.1 to [1.1.1](https://github.com/cucumber/tag-expressions/blob/main/CHANGELOG.md#111---2017-12-01)

## [3.1.0] - 2017-10-25
### Added
Expand Down Expand Up @@ -609,7 +609,7 @@ be used to get the name / tags of the running scenario. ([#947](https://github.c
- `--require <DIR|FILE>`: the required files are no longer reordered to require anything in a `support` directory first
- `--snippet-interface <INTERFACE>` has moved to `--format-options '{"snippetInterface": "<INTERFACE>"}'`
- `--snippet-syntax <SYNTAX>` has moved to `--format-options '{"snippetSyntax": "<SYNTAX>"}'`
- `--tags <EXPRESSION>` now uses [cucumber-tag-expressions](https://docs.cucumber.io/tag-expressions/). It is no longer repeatable and new values will override previous
- `--tags <EXPRESSION>` now uses [cucumber-tag-expressions](https://github.com/cucumber/tag-expressions). It is no longer repeatable and new values will override previous
- `--tags @dev` stays the same
- `--tags ~@dev` becomes `--tags 'not @dev'`
- `--tags @foo,@bar` becomes `--tags '@foo or @bar'`
Expand All @@ -624,9 +624,9 @@ be used to get the name / tags of the running scenario. ([#947](https://github.c
- When attaching buffers or strings, the callback argument is ignored.
- Hooks
- Hooks now receive a [ScenarioResult](/src/models/scenario_result.js) instead of the Scenario
- The `tags` option for hook should now be a string instead of an array and uses [cucumber-tag-expressions](https://docs.cucumber.io/tag-expressions/)
- The `tags` option for hook should now be a string instead of an array and uses [cucumber-tag-expressions](https://github.com/cucumber/tag-expressions)
- Step Definitions
- String patterns were removed in favor [cucumber-expressions](https://docs.cucumber.io/cucumber-expressions/)
- String patterns were removed in favor [cucumber-expressions](https://github.com/cucumber/cucumber-expressions)
- capture groups matching `(-?\d+)` will be automatically converted to an integer using `parseInt`
- capture groups matching `(-?\d*\.?\d+)` will be automatically converted to a float using `parseFloat`
- Regular Expressions
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Type `npm run` or see the `package.json` scripts section for how to run each cat
* [chai](https://www.chaijs.com/)
* [sinon](https://sinonjs.org/)
* compatibility kit - `npm run cck-test`
* checking that cucumber-js emits the [correct messages](https://github.com/cucumber/cucumber/tree/master/compatibility-kit)
* checking that cucumber-js emits the [correct messages](https://github.com/cucumber/compatibility-kit)
* feature tests - `npm run feature-test`
* cucumber-js tests itself

Expand Down
2 changes: 1 addition & 1 deletion UPGRADING.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ Now in `@cucumber/cucumber`:

### Formatters

The underlying event/data model for cucumber-js is now [cucumber-messages](https://github.com/cucumber/cucumber/tree/master/messages), a shared standard across all official Cucumber implementations. This replaces the old "event protocol".
The underlying event/data model for cucumber-js is now [cucumber-messages](https://github.com/cucumber/messages), a shared standard across all official Cucumber implementations. This replaces the old "event protocol".

If you maintain any custom formatters, you'll need to refactor them to work with the new model. The basics of a `Formatter` class are the same, and the `EventDataCollector` is still there to help you with tracking down data, but the names of events and shape of their data is different. It's worth checking out the implementations of the built-in formatters if you need a pointer.

Expand Down
4 changes: 2 additions & 2 deletions docs/support_files/api_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The built in parameter types are:
Defines a hook which is run after each scenario.

* `options`: An object with the following keys:
* `tags`: String tag expression used to apply this hook to only specific scenarios. See [cucumber-tag-expressions](https://docs.cucumber.io/tag-expressions/) for more information.
* `tags`: String tag expression used to apply this hook to only specific scenarios. See [cucumber-tag-expressions](https://github.com/cucumber/tag-expressions) for more information.
* `timeout`: A hook-specific timeout, to override the default timeout.
* `fn`: A function, defined as follows:
* The first argument will be an object of the form `{pickle, gherkinDocument, result, willBeRetried, testCaseStartedId}`
Expand Down Expand Up @@ -66,7 +66,7 @@ Multiple `AfterAll` hooks are executed in the **reverse** order that they are de
Defines a hook which is run after each step.

* `options`: An object with the following keys:
* `tags`: String tag expression used to apply this hook to only specific scenarios. See [cucumber-tag-expressions](https://docs.cucumber.io/tag-expressions/) for more information.
* `tags`: String tag expression used to apply this hook to only specific scenarios. See [cucumber-tag-expressions](https://github.com/cucumber/tag-expressions) for more information.
* `timeout`: A hook-specific timeout, to override the default timeout.
* `fn`: A function, defined as follows:
* The first argument will be an object of the form `{pickle, pickleStep, gherkinDocument, result, testCaseStartedId, testStepId}`
Expand Down
2 changes: 1 addition & 1 deletion src/formatter/json_formatter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ interface UriToTestCaseAttemptsMap {

export default class JsonFormatter extends Formatter {
public static readonly documentation: string =
'Prints the feature as JSON. The JSON format is in maintenance mode. Please consider using the message formatter with the standalone json-formatter (https://github.com/cucumber/cucumber/tree/master/json-formatter).'
'Prints the feature as JSON. The JSON format is in maintenance mode. Please consider using the message formatter with the standalone json-formatter (https://github.com/cucumber/json-formatter).'

constructor(options: IFormatterOptions) {
super(options)
Expand Down

0 comments on commit 627030d

Please sign in to comment.