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.

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

Set up ESLint for JSDoc comments #1605

Merged
merged 2 commits into from
Feb 19, 2024
Merged

Conversation

koddsson
Copy link
Member

I really want to explore both better typing and possible automatic generation of API docs since the JSDoc comments that exist in the codebase are of such high quality.

This PR introduces ESLint and eslint-plugin-jsdoc to start linting JSDoc comment in effort to make sure that all of the comments stay high quality as we refactor the code

This PR can be followed up by more changes to the rules we apply as well as some explorations into API documentation and stricter type-checking.

@koddsson koddsson requested a review from a team as a code owner February 19, 2024 20:04
@koddsson koddsson enabled auto-merge (squash) February 19, 2024 20:04
import jsdoc from "eslint-plugin-jsdoc";

export default [
jsdoc.configs["flat/recommended"],
Copy link
Contributor

@43081j 43081j Feb 19, 2024

Choose a reason for hiding this comment

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

while you're in there, can you maybe also enable eslint's recommended rule set? im surprised we didn't already have eslint

if it ends up with too big of a change, you could do a PR to add eslint + recommended, then a separate one for jsdoc on top or vice versa

@@ -2116,6 +2110,13 @@ function assertOwnPropertyDescriptor (name, descriptor, msg) {
Assertion.addMethod('ownPropertyDescriptor', assertOwnPropertyDescriptor);
Assertion.addMethod('haveOwnPropertyDescriptor', assertOwnPropertyDescriptor);

/**
*
Copy link
Contributor

Choose a reason for hiding this comment

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

maybe add a description? "Flags that the length property should be asserted in this chain"

Copy link
Contributor

@43081j 43081j left a comment

Choose a reason for hiding this comment

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

looks good, though it may be worth marking optional params as such or just wait for my typescript conversion to land

e.g. @param {string=} iAmAnOptionalParam

@koddsson koddsson merged commit 8475d2a into chaijs:main Feb 19, 2024
5 checks passed
@koddsson
Copy link
Member Author

lol, maybe I shouldn't have had it on auto-merge :D

I'll make a follow up PR to apply some of your suggestions @43081j

renovate bot referenced this pull request in runtime-env/import-meta-env Jul 7, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [chai](http://chaijs.com) ([source](https://github.com/chaijs/chai))
| [`4.4.1` ->
`5.1.1`](https://renovatebot.com/diffs/npm/chai/4.4.1/5.1.1) |
[![age](https://developer.mend.io/api/mc/badges/age/npm/chai/5.1.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/chai/5.1.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/chai/4.4.1/5.1.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/chai/4.4.1/5.1.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>chaijs/chai (chai)</summary>

### [`v5.1.1`](https://github.com/chaijs/chai/releases/tag/v5.1.1)

[Compare
Source](https://github.com/chaijs/chai/compare/v5.1.0...v5.1.1)

#### What's Changed

- Set up ESLint for JSDoc comments by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1605](https://github.com/chaijs/chai/pull/1605)
- build(deps-dev): bump ip from 1.1.8 to 1.1.9 by
[@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/chaijs/chai/pull/1608](https://github.com/chaijs/chai/pull/1608)
- Correct Mocha import instructions by
[@&#8203;MattiSG](https://github.com/MattiSG) in
[https://github.com/chaijs/chai/pull/1611](https://github.com/chaijs/chai/pull/1611)
- fix: support some virtual contexts in `toThrow` by
[@&#8203;43081j](https://github.com/43081j) in
[https://github.com/chaijs/chai/pull/1609](https://github.com/chaijs/chai/pull/1609)

#### New Contributors

- [@&#8203;MattiSG](https://github.com/MattiSG) made their first
contribution in
[https://github.com/chaijs/chai/pull/1611](https://github.com/chaijs/chai/pull/1611)

**Full Changelog**:
chaijs/chai@v5.1.0...v5.1.1

### [`v5.1.0`](https://github.com/chaijs/chai/releases/tag/v5.1.0)

[Compare
Source](https://github.com/chaijs/chai/compare/v5.0.3...v5.1.0)

#### What's Changed

- Remove useless guards and add parentheses to constuctors by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1593](https://github.com/chaijs/chai/pull/1593)
- Cleanup jsdoc comments by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1596](https://github.com/chaijs/chai/pull/1596)
- Convert comments in "legal comments" format to jsdoc or normal
comments by [@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1598](https://github.com/chaijs/chai/pull/1598)
- Implement `iterable` assertion by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1592](https://github.com/chaijs/chai/pull/1592)
- Assert interface fix by
[@&#8203;developer-bandi](https://github.com/developer-bandi) in
[https://github.com/chaijs/chai/pull/1601](https://github.com/chaijs/chai/pull/1601)
- Set support in same members by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1583](https://github.com/chaijs/chai/pull/1583)
- Fix publish script by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1602](https://github.com/chaijs/chai/pull/1602)

#### New Contributors

- [@&#8203;developer-bandi](https://github.com/developer-bandi) made
their first contribution in
[https://github.com/chaijs/chai/pull/1601](https://github.com/chaijs/chai/pull/1601)

**Full Changelog**:
chaijs/chai@v5.0.3...v5.1.0

### [`v5.0.3`](https://github.com/chaijs/chai/releases/tag/v5.0.3)

[Compare
Source](https://github.com/chaijs/chai/compare/v5.0.2...v5.0.3)

Fix bad v5.0.2 publish.

**Full Changelog**:
chaijs/chai@v5.0.2...v5.0.3

### [`v5.0.2`](https://github.com/chaijs/chai/releases/tag/v5.0.2)

[Compare
Source](https://github.com/chaijs/chai/compare/v5.0.0...v5.0.2)

#### What's Changed

- build(deps): bump nanoid and mocha by
[@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/chaijs/chai/pull/1558](https://github.com/chaijs/chai/pull/1558)
- remove `bump-cli` by [@&#8203;koddsson](https://github.com/koddsson)
in
[https://github.com/chaijs/chai/pull/1559](https://github.com/chaijs/chai/pull/1559)
- Update developer dependencies by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1560](https://github.com/chaijs/chai/pull/1560)
- fix: removes `??` for node compat (5.x) by
[@&#8203;43081j](https://github.com/43081j) in
[https://github.com/chaijs/chai/pull/1576](https://github.com/chaijs/chai/pull/1576)
- Update `loupe` to latest version by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1579](https://github.com/chaijs/chai/pull/1579)
- Re-enable some webkit tests by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1580](https://github.com/chaijs/chai/pull/1580)
- Remove a bunch of if statements in test/should.js by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1581](https://github.com/chaijs/chai/pull/1581)
- Remove a bunch of unused files by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1582](https://github.com/chaijs/chai/pull/1582)
- Fix 1564 by [@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1566](https://github.com/chaijs/chai/pull/1566)

**Full Changelog**:
chaijs/chai@v5.0.1...v5.0.2

### [`v5.0.0`](https://github.com/chaijs/chai/releases/tag/v5.0.0)

[Compare
Source](https://github.com/chaijs/chai/compare/v4.4.1...v5.0.0)

#### BREAKING CHANGES

- Chai now only supports EcmaScript Modules (ESM). This means your tests
will need to either have `import {...} from 'chai'` or `import('chai')`.
`require('chai')` will cause failures in nodejs. If you're using ESM and
seeing failures, it may be due to a bundler or transpiler which is
incorrectly converting import statements into require calls.
-   Dropped support for Internet Explorer.
-   Dropped support for NodeJS < 18.
- Minimum supported browsers are now Firefox 100, Safari 14.1, Chrome
100, Edge 100. Support for browsers prior to these versions is "best
effort" (bug reports on older browsers will be assessed individually and
may be marked as wontfix).

#### What's Changed

- feat: use chaijs/loupe for inspection by
[@&#8203;pcorpet](https://github.com/pcorpet) in
[https://github.com/chaijs/chai/pull/1401](https://github.com/chaijs/chai/pull/1401)
- docs: fix URL in README by [@&#8203;Izzur](https://github.com/Izzur)
in
[https://github.com/chaijs/chai/pull/1413](https://github.com/chaijs/chai/pull/1413)
- Remove `get-func-name` dependency by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1416](https://github.com/chaijs/chai/pull/1416)
- Convert Makefile script to npm scripts by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1424](https://github.com/chaijs/chai/pull/1424)
- Clean up README badges by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1422](https://github.com/chaijs/chai/pull/1422)
- fix: package.json - deprecation warning on exports field by
[@&#8203;stevenjoezhang](https://github.com/stevenjoezhang) in
[https://github.com/chaijs/chai/pull/1400](https://github.com/chaijs/chai/pull/1400)
- fix: deep-eql bump package to support symbols by
[@&#8203;snewcomer](https://github.com/snewcomer) in
[https://github.com/chaijs/chai/pull/1458](https://github.com/chaijs/chai/pull/1458)
- ES module conversion PoC by
[@&#8203;43081j](https://github.com/43081j) in
[https://github.com/chaijs/chai/pull/1498](https://github.com/chaijs/chai/pull/1498)
- chore: drop commonjs support by
[@&#8203;43081j](https://github.com/43081j) in
[https://github.com/chaijs/chai/pull/1503](https://github.com/chaijs/chai/pull/1503)
- Update pathval by [@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1527](https://github.com/chaijs/chai/pull/1527)
- Update check-error by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1528](https://github.com/chaijs/chai/pull/1528)
- update `deep-eql` to latest version by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1542](https://github.com/chaijs/chai/pull/1542)
- Inline `type-detect` as a simple function by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1544](https://github.com/chaijs/chai/pull/1544)
- Update loupe by [@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1545](https://github.com/chaijs/chai/pull/1545)
- Typo 'Test an object' not 'Test and object' by
[@&#8203;mavaddat](https://github.com/mavaddat) in
[https://github.com/chaijs/chai/pull/1460](https://github.com/chaijs/chai/pull/1460)
- Update `assertion-error` to it's latest major version! by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1543](https://github.com/chaijs/chai/pull/1543)
- Replacing Karma with Web Test Runner by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1546](https://github.com/chaijs/chai/pull/1546)

#### New Contributors

- [@&#8203;Izzur](https://github.com/Izzur) made their first
contribution in
[https://github.com/chaijs/chai/pull/1413](https://github.com/chaijs/chai/pull/1413)
- [@&#8203;stevenjoezhang](https://github.com/stevenjoezhang) made
their first contribution in
[https://github.com/chaijs/chai/pull/1400](https://github.com/chaijs/chai/pull/1400)
- [@&#8203;43081j](https://github.com/43081j) made their first
contribution in
[https://github.com/chaijs/chai/pull/1498](https://github.com/chaijs/chai/pull/1498)

**Full Changelog**:
chaijs/chai@4.3.1...v5.0.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/runtime-env/import-meta-env).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MjEuOSIsInVwZGF0ZWRJblZlciI6IjM3LjQyMS45IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
solaris007 referenced this pull request in adobe/spacecat-shared Aug 27, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change | Age | Adoption | Passing |
Confidence |
|---|---|---|---|---|---|---|---|
| [actions/setup-java](https://github.com/actions/setup-java) | action
| major | `v3` -> `v4` |
[![age](https://developer.mend.io/api/mc/badges/age/github-tags/actions%2fsetup-java/v4?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/github-tags/actions%2fsetup-java/v4?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/github-tags/actions%2fsetup-java/v3/v4?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/github-tags/actions%2fsetup-java/v3/v4?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
| [chai](http://chaijs.com) ([source](https://github.com/chaijs/chai))
| devDependencies | major | [`4.5.0` ->
`5.1.1`](https://renovatebot.com/diffs/npm/chai/4.5.0/5.1.1) |
[![age](https://developer.mend.io/api/mc/badges/age/npm/chai/5.1.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/chai/5.1.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/chai/4.5.0/5.1.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/chai/4.5.0/5.1.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>actions/setup-java (actions/setup-java)</summary>

### [`v4`](https://github.com/actions/setup-java/compare/v3...v4)

[Compare
Source](https://github.com/actions/setup-java/compare/v3...v4)

</details>

<details>
<summary>chaijs/chai (chai)</summary>

### [`v5.1.1`](https://github.com/chaijs/chai/releases/tag/v5.1.1)

[Compare
Source](https://github.com/chaijs/chai/compare/v5.1.0...v5.1.1)

#### What's Changed

- Set up ESLint for JSDoc comments by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1605](https://github.com/chaijs/chai/pull/1605)
- build(deps-dev): bump ip from 1.1.8 to 1.1.9 by
[@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/chaijs/chai/pull/1608](https://github.com/chaijs/chai/pull/1608)
- Correct Mocha import instructions by
[@&#8203;MattiSG](https://github.com/MattiSG) in
[https://github.com/chaijs/chai/pull/1611](https://github.com/chaijs/chai/pull/1611)
- fix: support some virtual contexts in `toThrow` by
[@&#8203;43081j](https://github.com/43081j) in
[https://github.com/chaijs/chai/pull/1609](https://github.com/chaijs/chai/pull/1609)

#### New Contributors

- [@&#8203;MattiSG](https://github.com/MattiSG) made their first
contribution in
[https://github.com/chaijs/chai/pull/1611](https://github.com/chaijs/chai/pull/1611)

**Full Changelog**:
chaijs/chai@v5.1.0...v5.1.1

### [`v5.1.0`](https://github.com/chaijs/chai/releases/tag/v5.1.0)

[Compare
Source](https://github.com/chaijs/chai/compare/v5.0.3...v5.1.0)

#### What's Changed

- Remove useless guards and add parentheses to constuctors by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1593](https://github.com/chaijs/chai/pull/1593)
- Cleanup jsdoc comments by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1596](https://github.com/chaijs/chai/pull/1596)
- Convert comments in "legal comments" format to jsdoc or normal
comments by [@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1598](https://github.com/chaijs/chai/pull/1598)
- Implement `iterable` assertion by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1592](https://github.com/chaijs/chai/pull/1592)
- Assert interface fix by
[@&#8203;developer-bandi](https://github.com/developer-bandi) in
[https://github.com/chaijs/chai/pull/1601](https://github.com/chaijs/chai/pull/1601)
- Set support in same members by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1583](https://github.com/chaijs/chai/pull/1583)
- Fix publish script by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1602](https://github.com/chaijs/chai/pull/1602)

#### New Contributors

- [@&#8203;developer-bandi](https://github.com/developer-bandi) made
their first contribution in
[https://github.com/chaijs/chai/pull/1601](https://github.com/chaijs/chai/pull/1601)

**Full Changelog**:
chaijs/chai@v5.0.3...v5.1.0

### [`v5.0.3`](https://github.com/chaijs/chai/releases/tag/v5.0.3)

[Compare
Source](https://github.com/chaijs/chai/compare/v5.0.2...v5.0.3)

Fix bad v5.0.2 publish.

**Full Changelog**:
chaijs/chai@v5.0.2...v5.0.3

### [`v5.0.2`](https://github.com/chaijs/chai/releases/tag/v5.0.2)

[Compare
Source](https://github.com/chaijs/chai/compare/v5.0.0...v5.0.2)

#### What's Changed

- build(deps): bump nanoid and mocha by
[@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/chaijs/chai/pull/1558](https://github.com/chaijs/chai/pull/1558)
- remove `bump-cli` by [@&#8203;koddsson](https://github.com/koddsson)
in
[https://github.com/chaijs/chai/pull/1559](https://github.com/chaijs/chai/pull/1559)
- Update developer dependencies by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1560](https://github.com/chaijs/chai/pull/1560)
- fix: removes `??` for node compat (5.x) by
[@&#8203;43081j](https://github.com/43081j) in
[https://github.com/chaijs/chai/pull/1576](https://github.com/chaijs/chai/pull/1576)
- Update `loupe` to latest version by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1579](https://github.com/chaijs/chai/pull/1579)
- Re-enable some webkit tests by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1580](https://github.com/chaijs/chai/pull/1580)
- Remove a bunch of if statements in test/should.js by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1581](https://github.com/chaijs/chai/pull/1581)
- Remove a bunch of unused files by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1582](https://github.com/chaijs/chai/pull/1582)
- Fix 1564 by [@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1566](https://github.com/chaijs/chai/pull/1566)

**Full Changelog**:
chaijs/chai@v5.0.1...v5.0.2

### [`v5.0.0`](https://github.com/chaijs/chai/releases/tag/v5.0.0)

[Compare
Source](https://github.com/chaijs/chai/compare/v4.5.0...v5.0.0)

#### BREAKING CHANGES

- Chai now only supports EcmaScript Modules (ESM). This means your tests
will need to either have `import {...} from 'chai'` or `import('chai')`.
`require('chai')` will cause failures in nodejs. If you're using ESM and
seeing failures, it may be due to a bundler or transpiler which is
incorrectly converting import statements into require calls.
-   Dropped support for Internet Explorer.
-   Dropped support for NodeJS < 18.
- Minimum supported browsers are now Firefox 100, Safari 14.1, Chrome
100, Edge 100. Support for browsers prior to these versions is "best
effort" (bug reports on older browsers will be assessed individually and
may be marked as wontfix).

#### What's Changed

- feat: use chaijs/loupe for inspection by
[@&#8203;pcorpet](https://github.com/pcorpet) in
[https://github.com/chaijs/chai/pull/1401](https://github.com/chaijs/chai/pull/1401)
- docs: fix URL in README by [@&#8203;Izzur](https://github.com/Izzur)
in
[https://github.com/chaijs/chai/pull/1413](https://github.com/chaijs/chai/pull/1413)
- Remove `get-func-name` dependency by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1416](https://github.com/chaijs/chai/pull/1416)
- Convert Makefile script to npm scripts by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1424](https://github.com/chaijs/chai/pull/1424)
- Clean up README badges by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1422](https://github.com/chaijs/chai/pull/1422)
- fix: package.json - deprecation warning on exports field by
[@&#8203;stevenjoezhang](https://github.com/stevenjoezhang) in
[https://github.com/chaijs/chai/pull/1400](https://github.com/chaijs/chai/pull/1400)
- fix: deep-eql bump package to support symbols by
[@&#8203;snewcomer](https://github.com/snewcomer) in
[https://github.com/chaijs/chai/pull/1458](https://github.com/chaijs/chai/pull/1458)
- ES module conversion PoC by
[@&#8203;43081j](https://github.com/43081j) in
[https://github.com/chaijs/chai/pull/1498](https://github.com/chaijs/chai/pull/1498)
- chore: drop commonjs support by
[@&#8203;43081j](https://github.com/43081j) in
[https://github.com/chaijs/chai/pull/1503](https://github.com/chaijs/chai/pull/1503)
- Update pathval by [@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1527](https://github.com/chaijs/chai/pull/1527)
- Update check-error by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1528](https://github.com/chaijs/chai/pull/1528)
- update `deep-eql` to latest version by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1542](https://github.com/chaijs/chai/pull/1542)
- Inline `type-detect` as a simple function by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1544](https://github.com/chaijs/chai/pull/1544)
- Update loupe by [@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1545](https://github.com/chaijs/chai/pull/1545)
- Typo 'Test an object' not 'Test and object' by
[@&#8203;mavaddat](https://github.com/mavaddat) in
[https://github.com/chaijs/chai/pull/1460](https://github.com/chaijs/chai/pull/1460)
- Update `assertion-error` to it's latest major version! by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1543](https://github.com/chaijs/chai/pull/1543)
- Replacing Karma with Web Test Runner by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1546](https://github.com/chaijs/chai/pull/1546)

#### New Contributors

- [@&#8203;Izzur](https://github.com/Izzur) made their first
contribution in
[https://github.com/chaijs/chai/pull/1413](https://github.com/chaijs/chai/pull/1413)
- [@&#8203;stevenjoezhang](https://github.com/stevenjoezhang) made
their first contribution in
[https://github.com/chaijs/chai/pull/1400](https://github.com/chaijs/chai/pull/1400)
- [@&#8203;43081j](https://github.com/43081j) made their first
contribution in
[https://github.com/chaijs/chai/pull/1498](https://github.com/chaijs/chai/pull/1498)

**Full Changelog**:
chaijs/chai@4.3.1...v5.0.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "after 2pm on Monday" in timezone
Europe/Zurich, Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

👻 **Immortal**: This PR will be recreated if closed unmerged. Get
[config help](https://github.com/renovatebot/renovate/discussions) if
that's undesired.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR was generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View the
[repository job
log](https://developer.mend.io/github/adobe/spacecat-shared).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC4yNi4xIiwidXBkYXRlZEluVmVyIjoiMzguMjYuMSIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOltdfQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Dominique Jäggi <1872195+solaris007@users.noreply.github.com>
renovate bot referenced this pull request in davidsneighbour/hugo-modules Sep 14, 2024
This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [chai](http://chaijs.com)
([source](https://github.com/chaijs/chai)) | [`^4.5.0` ->
`^5.0.0`](https://renovatebot.com/diffs/npm/chai/4.5.0/5.1.1) |
[![age](https://developer.mend.io/api/mc/badges/age/npm/chai/5.1.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/chai/5.1.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/chai/4.5.0/5.1.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/chai/4.5.0/5.1.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>chaijs/chai (chai)</summary>

###
[`v5.1.1`](https://github.com/chaijs/chai/releases/tag/v5.1.1)

[Compare
Source](https://github.com/chaijs/chai/compare/v5.1.0...v5.1.1)

#### What's Changed

- Set up ESLint for JSDoc comments by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1605](https://github.com/chaijs/chai/pull/1605)
- build(deps-dev): bump ip from 1.1.8 to 1.1.9 by
[@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/chaijs/chai/pull/1608](https://github.com/chaijs/chai/pull/1608)
- Correct Mocha import instructions by
[@&#8203;MattiSG](https://github.com/MattiSG) in
[https://github.com/chaijs/chai/pull/1611](https://github.com/chaijs/chai/pull/1611)
- fix: support some virtual contexts in `toThrow` by
[@&#8203;43081j](https://github.com/43081j) in
[https://github.com/chaijs/chai/pull/1609](https://github.com/chaijs/chai/pull/1609)

#### New Contributors

- [@&#8203;MattiSG](https://github.com/MattiSG) made their
first contribution in
[https://github.com/chaijs/chai/pull/1611](https://github.com/chaijs/chai/pull/1611)

**Full Changelog**:
chaijs/chai@v5.1.0...v5.1.1

###
[`v5.1.0`](https://github.com/chaijs/chai/releases/tag/v5.1.0)

[Compare
Source](https://github.com/chaijs/chai/compare/v5.0.3...v5.1.0)

#### What's Changed

- Remove useless guards and add parentheses to constuctors by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1593](https://github.com/chaijs/chai/pull/1593)
- Cleanup jsdoc comments by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1596](https://github.com/chaijs/chai/pull/1596)
- Convert comments in "legal comments" format to jsdoc or normal
comments by [@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1598](https://github.com/chaijs/chai/pull/1598)
- Implement `iterable` assertion by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1592](https://github.com/chaijs/chai/pull/1592)
- Assert interface fix by
[@&#8203;developer-bandi](https://github.com/developer-bandi)
in
[https://github.com/chaijs/chai/pull/1601](https://github.com/chaijs/chai/pull/1601)
- Set support in same members by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1583](https://github.com/chaijs/chai/pull/1583)
- Fix publish script by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1602](https://github.com/chaijs/chai/pull/1602)

#### New Contributors

- [@&#8203;developer-bandi](https://github.com/developer-bandi)
made their first contribution in
[https://github.com/chaijs/chai/pull/1601](https://github.com/chaijs/chai/pull/1601)

**Full Changelog**:
chaijs/chai@v5.0.3...v5.1.0

###
[`v5.0.3`](https://github.com/chaijs/chai/releases/tag/v5.0.3)

[Compare
Source](https://github.com/chaijs/chai/compare/v5.0.2...v5.0.3)

Fix bad v5.0.2 publish.

**Full Changelog**:
chaijs/chai@v5.0.2...v5.0.3

###
[`v5.0.2`](https://github.com/chaijs/chai/releases/tag/v5.0.2)

[Compare
Source](https://github.com/chaijs/chai/compare/v5.0.0...v5.0.2)

#### What's Changed

- build(deps): bump nanoid and mocha by
[@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/chaijs/chai/pull/1558](https://github.com/chaijs/chai/pull/1558)
- remove `bump-cli` by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1559](https://github.com/chaijs/chai/pull/1559)
- Update developer dependencies by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1560](https://github.com/chaijs/chai/pull/1560)
- fix: removes `??` for node compat (5.x) by
[@&#8203;43081j](https://github.com/43081j) in
[https://github.com/chaijs/chai/pull/1576](https://github.com/chaijs/chai/pull/1576)
- Update `loupe` to latest version by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1579](https://github.com/chaijs/chai/pull/1579)
- Re-enable some webkit tests by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1580](https://github.com/chaijs/chai/pull/1580)
- Remove a bunch of if statements in test/should.js by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1581](https://github.com/chaijs/chai/pull/1581)
- Remove a bunch of unused files by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1582](https://github.com/chaijs/chai/pull/1582)
- Fix 1564 by [@&#8203;koddsson](https://github.com/koddsson)
in
[https://github.com/chaijs/chai/pull/1566](https://github.com/chaijs/chai/pull/1566)

**Full Changelog**:
chaijs/chai@v5.0.1...v5.0.2

###
[`v5.0.0`](https://github.com/chaijs/chai/releases/tag/v5.0.0)

[Compare
Source](https://github.com/chaijs/chai/compare/v4.5.0...v5.0.0)

#### BREAKING CHANGES

- Chai now only supports EcmaScript Modules (ESM). This means your tests
will need to either have `import {...} from 'chai'` or `import('chai')`.
`require('chai')` will cause failures in nodejs. If you're using ESM and
seeing failures, it may be due to a bundler or transpiler which is
incorrectly converting import statements into require calls.
-   Dropped support for Internet Explorer.
-   Dropped support for NodeJS < 18.
- Minimum supported browsers are now Firefox 100, Safari 14.1, Chrome
100, Edge 100. Support for browsers prior to these versions is "best
effort" (bug reports on older browsers will be assessed individually and
may be marked as wontfix).

#### What's Changed

- feat: use chaijs/loupe for inspection by
[@&#8203;pcorpet](https://github.com/pcorpet) in
[https://github.com/chaijs/chai/pull/1401](https://github.com/chaijs/chai/pull/1401)
- docs: fix URL in README by
[@&#8203;Izzur](https://github.com/Izzur) in
[https://github.com/chaijs/chai/pull/1413](https://github.com/chaijs/chai/pull/1413)
- Remove `get-func-name` dependency by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1416](https://github.com/chaijs/chai/pull/1416)
- Convert Makefile script to npm scripts by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1424](https://github.com/chaijs/chai/pull/1424)
- Clean up README badges by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1422](https://github.com/chaijs/chai/pull/1422)
- fix: package.json - deprecation warning on exports field by
[@&#8203;stevenjoezhang](https://github.com/stevenjoezhang) in
[https://github.com/chaijs/chai/pull/1400](https://github.com/chaijs/chai/pull/1400)
- fix: deep-eql bump package to support symbols by
[@&#8203;snewcomer](https://github.com/snewcomer) in
[https://github.com/chaijs/chai/pull/1458](https://github.com/chaijs/chai/pull/1458)
- ES module conversion PoC by
[@&#8203;43081j](https://github.com/43081j) in
[https://github.com/chaijs/chai/pull/1498](https://github.com/chaijs/chai/pull/1498)
- chore: drop commonjs support by
[@&#8203;43081j](https://github.com/43081j) in
[https://github.com/chaijs/chai/pull/1503](https://github.com/chaijs/chai/pull/1503)
- Update pathval by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1527](https://github.com/chaijs/chai/pull/1527)
- Update check-error by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1528](https://github.com/chaijs/chai/pull/1528)
- update `deep-eql` to latest version by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1542](https://github.com/chaijs/chai/pull/1542)
- Inline `type-detect` as a simple function by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1544](https://github.com/chaijs/chai/pull/1544)
- Update loupe by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1545](https://github.com/chaijs/chai/pull/1545)
- Typo 'Test an object' not 'Test and object' by
[@&#8203;mavaddat](https://github.com/mavaddat) in
[https://github.com/chaijs/chai/pull/1460](https://github.com/chaijs/chai/pull/1460)
- Update `assertion-error` to it's latest major version! by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1543](https://github.com/chaijs/chai/pull/1543)
- Replacing Karma with Web Test Runner by
[@&#8203;koddsson](https://github.com/koddsson) in
[https://github.com/chaijs/chai/pull/1546](https://github.com/chaijs/chai/pull/1546)

#### New Contributors

- [@&#8203;Izzur](https://github.com/Izzur) made their first
contribution in
[https://github.com/chaijs/chai/pull/1413](https://github.com/chaijs/chai/pull/1413)
- [@&#8203;stevenjoezhang](https://github.com/stevenjoezhang)
made their first contribution in
[https://github.com/chaijs/chai/pull/1400](https://github.com/chaijs/chai/pull/1400)
- [@&#8203;43081j](https://github.com/43081j) made their first
contribution in
[https://github.com/chaijs/chai/pull/1498](https://github.com/chaijs/chai/pull/1498)

**Full Changelog**:
chaijs/chai@4.3.1...v5.0.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR was generated by [Mend Renovate](https://mend.io/renovate/).
View the [repository job
log](https://developer.mend.io/github/davidsneighbour/hugo-modules).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC43NC4xIiwidXBkYXRlZEluVmVyIjoiMzguNzQuMSIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOltdfQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants