Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: codeceptjs/CodeceptJS
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 3.5.10
Choose a base ref
...
head repository: codeceptjs/CodeceptJS
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 3.5.11
Choose a head ref
3 contributors

Commits on Dec 8, 2023

  1. update changelog

    @kobenguyent
    kobenguyent committed Dec 8, 2023
    Copy the full SHA
    d8c688e View commit details

Commits on Dec 11, 2023

  1. chore(deps): bump actions/stale from 8 to 9 (#4059) 

    Bumps [actions/stale](https://github.com/actions/stale) from 8 to 9.
- [Release notes](https://github.com/actions/stale/releases)
- [Changelog](https://github.com/actions/stale/blob/main/CHANGELOG.md)
- [Commits](actions/stale@v8...v9)

---
updated-dependencies:
- dependency-name: actions/stale
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    @dependabot
    dependabot[bot] authored Dec 11, 2023
    Copy the full SHA
    8eceaf6 View commit details

  2. fix: expect docs (#4058)

    @kobenguyent
    kobenguyent authored Dec 11, 2023
    Copy the full SHA
    25637ba View commit details

  3. chore(deps): bump @xmldom/xmldom from 0.7.7 to 0.8.10 (#4060) 

    Bumps [@xmldom/xmldom](https://github.com/xmldom/xmldom) from 0.7.7 to 0.8.10.
- [Release notes](https://github.com/xmldom/xmldom/releases)
- [Changelog](https://github.com/xmldom/xmldom/blob/master/CHANGELOG.md)
- [Commits](xmldom/xmldom@0.7.7...0.8.10)

---
updated-dependencies:
- dependency-name: "@xmldom/xmldom"
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    @dependabot
    dependabot[bot] authored Dec 11, 2023
    Copy the full SHA
    cba856c View commit details

Commits on Dec 12, 2023

  1. fix(typings): scrollintoview complains scrollintoviewoptions (#4067)

    @kobenguyent
    kobenguyent authored Dec 12, 2023
    Copy the full SHA
    0d1d86b View commit details

  2. chore(deps-dev): bump typedoc-plugin-markdown from 3.13.4 to 3.17.1 (#… 

    …4064)

Bumps [typedoc-plugin-markdown](https://github.com/tgreyuk/typedoc-plugin-markdown/tree/HEAD/packages/typedoc-plugin-markdown) from 3.13.4 to 3.17.1.
- [Release notes](https://github.com/tgreyuk/typedoc-plugin-markdown/releases)
- [Changelog](https://github.com/tgreyuk/typedoc-plugin-markdown/blob/master/packages/typedoc-plugin-markdown/CHANGELOG.md)
- [Commits](https://github.com/tgreyuk/typedoc-plugin-markdown/commits/typedoc-plugin-markdown@3.17.1/packages/typedoc-plugin-markdown)

---
updated-dependencies:
- dependency-name: typedoc-plugin-markdown
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    @dependabot
    dependabot[bot] authored Dec 12, 2023
    Copy the full SHA
    af49335 View commit details

Commits on Dec 14, 2023

  1. fix: retryFailedStep is disabled for non tryTo steps (#4069)

    @kobenguyent
    kobenguyent authored Dec 14, 2023
    Copy the full SHA
    7912198 View commit details

Commits on Dec 17, 2023

  1. Update CONTRIBUTING.md

    @kobenguyent
    kobenguyent authored Dec 17, 2023
    Copy the full SHA
    ce7a342 View commit details

  2. Update CONTRIBUTING.md

    @kobenguyent
    kobenguyent authored Dec 17, 2023
    Copy the full SHA
    edec18c View commit details

Commits on Dec 18, 2023

  1. chore(deps-dev): bump typedoc from 0.25.3 to 0.25.4 (#4079)

    @dependabot
    dependabot[bot] authored Dec 18, 2023
    Copy the full SHA
    bed67e0 View commit details

  2. chore(deps-dev): bump eslint from 8.55.0 to 8.56.0 (#4078)

    @dependabot
    dependabot[bot] authored Dec 18, 2023
    Copy the full SHA
    0f135d0 View commit details

  3. fix: typo in agrs (#4077)

    @kobenguyent
    kobenguyent authored Dec 18, 2023
    Copy the full SHA
    815da18 View commit details

  4. chore(deps-dev): bump xpath from 0.0.33 to 0.0.34 (#4080)

    @dependabot
    dependabot[bot] authored Dec 18, 2023
    Copy the full SHA
    e8ce81c View commit details

  5. chore(deps-dev): bump electron from 27.0.4 to 28.0.0 (#4062)

    @dependabot
    dependabot[bot] authored Dec 18, 2023
    Copy the full SHA
    52cf527 View commit details

Commits on Dec 19, 2023

  1. fix: docs format (#4076)

    @kobenguyent
    kobenguyent authored Dec 19, 2023
    Copy the full SHA
    6c57921 View commit details

Commits on Dec 20, 2023

  1. fix: seeattributesonelements throws error (#4073)

    @kobenguyent
    kobenguyent authored Dec 20, 2023
    Copy the full SHA
    51f7eb2 View commit details

Commits on Dec 21, 2023

  1. fix(puppeteer): hide deprecation info (#4075)

    @kobenguyent
    kobenguyent authored Dec 21, 2023
    Copy the full SHA
    0341547 View commit details

Commits on Dec 22, 2023

  1. fix: expect helper to have custom error message as optional param (#4082 

    )
    @kobenguyent
    kobenguyent authored Dec 22, 2023
    Copy the full SHA
    b4b6dd8 View commit details

Commits on Dec 23, 2023

  1. fix: joi args in step (#4084)

    @kobenguyent
    kobenguyent authored Dec 23, 2023
    Copy the full SHA
    0de0783 View commit details

Commits on Dec 27, 2023

  1. chore(deps-dev): bump ts-node from 10.9.1 to 10.9.2 (#4089) 

    Bumps [ts-node](https://github.com/TypeStrong/ts-node) from 10.9.1 to 10.9.2.
- [Release notes](https://github.com/TypeStrong/ts-node/releases)
- [Changelog](https://github.com/TypeStrong/ts-node/blob/main/development-docs/release-template.md)
- [Commits](TypeStrong/ts-node@v10.9.1...v10.9.2)

---
updated-dependencies:
- dependency-name: ts-node
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    @dependabot
    dependabot[bot] authored Dec 27, 2023
    Copy the full SHA
    0e7b6ed View commit details

  2. chore(deps-dev): bump typescript from 5.2.2 to 5.3.3 (#4088) 

    Bumps [typescript](https://github.com/Microsoft/TypeScript) from 5.2.2 to 5.3.3.
- [Release notes](https://github.com/Microsoft/TypeScript/releases)
- [Commits](microsoft/TypeScript@v5.2.2...v5.3.3)

---
updated-dependencies:
- dependency-name: typescript
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    @dependabot
    dependabot[bot] authored Dec 27, 2023
    Copy the full SHA
    b1037dd View commit details

Commits on Dec 28, 2023

  1. chore(deps): bump resq from 1.10.2 to 1.11.0 (#4087)

    @dependabot
    dependabot[bot] authored Dec 28, 2023
    Copy the full SHA
    78309b1 View commit details

Commits on Dec 30, 2023

  1. feat: other locators from playwright (#4090)

    @kobenguyent
    kobenguyent authored Dec 30, 2023
    Copy the full SHA
    474b5e1 View commit details

  2. fix: step arg is a function (#4092) 

    * fix: step arg is a function
    @kobenguyent
    kobenguyent authored Dec 30, 2023
    Copy the full SHA
    10df8b2 View commit details

Commits on Jan 1, 2024

  1. chore(deps): bump @cucumber/cucumber-expressions from 16.1.2 to 17.0.1 ( 

    #4093)
    @dependabot
    dependabot[bot] authored Jan 1, 2024
    Copy the full SHA
    3bc9e5b View commit details

  2. chore(deps-dev): bump ts-morph from 19.0.0 to 21.0.1 (#4094)

    @dependabot
    dependabot[bot] authored Jan 1, 2024
    Copy the full SHA
    bd08cb5 View commit details

  3. chore(deps-dev): bump @wdio/utils from 8.20.3 to 8.27.0 (#4095)

    @dependabot
    dependabot[bot] authored Jan 1, 2024
    Copy the full SHA
    9169a1b View commit details

  4. chore(deps-dev): bump @wdio/sauce-service from 8.3.8 to 8.27.0 (#4097)

    @dependabot
    dependabot[bot] authored Jan 1, 2024
    Copy the full SHA
    5bcc8b7 View commit details

  5. chore(deps): bump axios from 1.6.2 to 1.6.3 (#4096)

    @dependabot
    dependabot[bot] authored Jan 1, 2024
    Copy the full SHA
    79d9897 View commit details

  6. release 3.5.11 (#4098)

    @kobenguyent
    kobenguyent authored Jan 1, 2024
    Copy the full SHA
    1a9f3be View commit details
25 changes: 25 additions & 0 deletions .github/CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -132,6 +132,31 @@ Documentation parts can be shared across helpers. Those parts are located in `do
}
```

_Note:_ Due to the (lib)[https://documentation.js.org/] that we are using to generate docs, the fast and cheap way to fix format issue that text after the mustache template is appended without formatting is moving the texts to above the mustache template.

```js
/**
* // Before
* Click action
* {{> click }}
* Click action
*/
click() {
// ...
}
```

```js
/**
* // After
* Click action
* {{> click }}
*/
click() {
// ...
}
```

## Typings

Typings are generated in `typings/` directory via `jsdoc`
2 changes: 1 addition & 1 deletion .github/workflows/close-inactive-issues.yml
View file
Original file line number Diff line number Diff line change
@@ -10,7 +10,7 @@ jobs:
issues: write
pull-requests: write
steps:
- uses: actions/stale@v8
- uses: actions/stale@v9
with:
days-before-issue-stale: 90
days-before-issue-close: 365
28 changes: 27 additions & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,29 @@
## 3.5.11

❤️ Thanks all to those who contributed to make this release! ❤️

🛩️ *Features*
* feat: other locators from playwright (#4090) - by @KobeNguyenT
* CodeceptJS - Playwright now supports other locators like
* React (https://playwright.dev/docs/other-locators#react-locator),
* Vue (https://playwright.dev/docs/other-locators#vue-locator)
![Vue Locators](https://github.com/codeceptjs/CodeceptJS/assets/7845001/841e9e54-847b-4326-b95f-f9406955a3ce)
![Example](https://github.com/codeceptjs/CodeceptJS/assets/7845001/763e6788-143b-4a00-a249-d9ca5f0b2a09)

🐛 *Bug Fixes*
* fix: step object is broken when step arg is a function (#4092) - by @KobeNguyenT
* fix: step object is broken when step arg contains joi object (#4084) - by @KobeNguyenT
* fix(expect helper): custom error message as optional param (#4082) - by @KobeNguyenT
* fix(puppeteer): hide deprecation info (#4075) - by @KobeNguyenT
* fix: seeattributesonelements throws error when attribute doesn't exist (#4073) - by @KobeNguyenT
* fix: typo in agrs (#4077) - by @KobeNguyenT
* fix: retryFailedStep is disabled for non tryTo steps (#4069) - by @KobeNguyenT
* fix(typings): scrollintoview complains scrollintoviewoptions (#4067) - by @KobeNguyenT

📖 *Documentation*
* fix(docs): some doc blocks are broken (#4076) - by @KobeNguyenT
* fix(docs): expect docs (#4058) - by @KobeNguyenT

## 3.5.10

❤️ Thanks all to those who contributed to make this release! ❤️
@@ -71,7 +97,7 @@ module.exports = function() {
});
}
```
* fix: ai html updates (#3962) - by @davert
* fix: ai html updates (#3962) - by @DavertMik
```
replaced minify library with a modern and more secure fork. Fixes html-minifier@4.0.0 Regular Expression Denial of Service vulnerability #3829
AI class is implemented as singleton
2 changes: 1 addition & 1 deletion docs/helpers/Appium.md
View file
Original file line number Diff line number Diff line change
@@ -1171,7 +1171,7 @@ I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "cent
#### Parameters

- `locator` **([string][5] \| [object][11])** located by CSS|XPath|strict locator.
- `scrollIntoViewOptions` **ScrollIntoViewOptions** see [https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView][17].
- `scrollIntoViewOptions` **(ScrollIntoViewOptions | [boolean][7])** either alignToTop=true|false or scrollIntoViewOptions. See [https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView][17].

Returns **void** automatically synchronized promise through #recorderSupported only for web testing

66 changes: 33 additions & 33 deletions docs/helpers/Expect.md
View file
Original file line number Diff line number Diff line change
@@ -20,7 +20,7 @@ Zero-configuration when paired with other helpers like REST, Playwright:
{
helpers: {
Playwright: {...},
ExpectHelper: {},
Expect: {},
}
}
```
@@ -32,32 +32,32 @@ Zero-configuration when paired with other helpers like REST, Playwright:
#### Parameters

- `targetData` **any**
- `aboveThan` **any** number | Date
- `customErrorMsg` **any**
- `aboveThan` **any**
- `customErrorMsg` **any?**

### expectBelow

#### Parameters

- `targetData` **any**
- `belowThan` **any** number | Date
- `customErrorMsg` **any**
- `belowThan` **any**
- `customErrorMsg` **any?**

### expectContain

#### Parameters

- `actualValue` **any**
- `expectedValueToContain` **any**
- `customErrorMsg` **any**
- `customErrorMsg` **any?**

### expectDeepEqual

#### Parameters

- `actualValue` **any**
- `expectedValue` **any**
- `customErrorMsg` **any**
- `customErrorMsg` **any?**

### expectDeepEqualExcluding

@@ -68,7 +68,7 @@ expects members of two JSON objects are deeply equal excluding some properties
- `actualValue` **any**
- `expectedValue` **any**
- `fieldsToExclude` **any**
- `customErrorMsg` **any**
- `customErrorMsg` **any?**

### expectDeepIncludeMembers

@@ -78,7 +78,7 @@ expects an array to be a superset of another array

- `superset` **any**
- `set` **any**
- `customErrorMsg` **any**
- `customErrorMsg` **any?**

### expectDeepMembers

@@ -88,77 +88,77 @@ expects members of two arrays are deeply equal

- `actualValue` **any**
- `expectedValue` **any**
- `customErrorMsg` **any**
- `customErrorMsg` **any?**

### expectEmpty

#### Parameters

- `targetData` **any**
- `customErrorMsg` **any**
- `customErrorMsg` **any?**

### expectEndsWith

#### Parameters

- `actualValue` **any**
- `expectedValueToEndWith` **any**
- `customErrorMsg` **any**
- `customErrorMsg` **any?**

### expectEqual

#### Parameters

- `actualValue` **any**
- `expectedValue` **any**
- `customErrorMsg` **any**
- `customErrorMsg` **any?**

### expectEqualIgnoreCase

#### Parameters

- `actualValue` **any**
- `expectedValue` **any**
- `customErrorMsg` **any**
- `customErrorMsg` **any?**

### expectFalse

#### Parameters

- `targetData` **any**
- `customErrorMsg` **any**
- `customErrorMsg` **any?**

### expectHasAProperty

#### Parameters

- `targetData` **any**
- `propertyName` **any**
- `customErrorMsg` **any**
- `customErrorMsg` **any?**

### expectHasProperty

#### Parameters

- `targetData` **any**
- `propertyName` **any**
- `customErrorMsg` **any**
- `customErrorMsg` **any?**

### expectJsonSchema

#### Parameters

- `targetData` **any**
- `jsonSchema` **any**
- `customErrorMsg` **any**
- `customErrorMsg` **any?**

### expectJsonSchemaUsingAJV

#### Parameters

- `targetData` **any**
- `jsonSchema` **any**
- `customErrorMsg` **any**
- `customErrorMsg` **any?**
- `ajvOptions` **any** Pass AJV options

### expectLengthAboveThan
@@ -167,23 +167,23 @@ expects members of two arrays are deeply equal

- `targetData` **any**
- `lengthAboveThan` **any**
- `customErrorMsg` **any**
- `customErrorMsg` **any?**

### expectLengthBelowThan

#### Parameters

- `targetData` **any**
- `lengthBelowThan` **any**
- `customErrorMsg` **any**
- `customErrorMsg` **any?**

### expectLengthOf

#### Parameters

- `targetData` **any**
- `length` **any**
- `customErrorMsg` **any**
- `customErrorMsg` **any?**

### expectMatchesPattern

@@ -193,83 +193,83 @@ expects a JSON object matches a provided pattern

- `actualValue` **any**
- `expectedPattern` **any**
- `customErrorMsg` **any**
- `customErrorMsg` **any?**

### expectMatchRegex

#### Parameters

- `targetData` **any**
- `regex` **any**
- `customErrorMsg` **any**
- `customErrorMsg` **any?**

### expectNotContain

#### Parameters

- `actualValue` **any**
- `expectedValueToNotContain` **any**
- `customErrorMsg` **any**
- `customErrorMsg` **any?**

### expectNotDeepEqual

#### Parameters

- `actualValue` **any**
- `expectedValue` **any**
- `customErrorMsg` **any**
- `customErrorMsg` **any?**

### expectNotEndsWith

#### Parameters

- `actualValue` **any**
- `expectedValueToNotEndWith` **any**
- `customErrorMsg` **any**
- `customErrorMsg` **any?**

### expectNotEqual

#### Parameters

- `actualValue` **any**
- `expectedValue` **any**
- `customErrorMsg` **any**
- `customErrorMsg` **any?**

### expectNotStartsWith

#### Parameters

- `actualValue` **any**
- `expectedValueToNotStartWith` **any**
- `customErrorMsg` **any**
- `customErrorMsg` **any?**

### expectStartsWith

#### Parameters

- `actualValue` **any**
- `expectedValueToStartWith` **any**
- `customErrorMsg` **any**
- `customErrorMsg` **any?**

### expectToBeA

#### Parameters

- `targetData` **any**
- `type` **any**
- `customErrorMsg` **any**
- `customErrorMsg` **any?**

### expectToBeAn

#### Parameters

- `targetData` **any**
- `type` **any**
- `customErrorMsg` **any**
- `customErrorMsg` **any?**

### expectTrue

#### Parameters

- `targetData` **any**
- `customErrorMsg` **any**
- `customErrorMsg` **any?**
Loading