search

NickColley / jest-axe

Custom Jest matcher for aXe for testing accessibility ♿️🃏
MIT License
1.06k stars 54 forks source link

Update types for latest version #213

Closed samatcolumn closed 2 years ago

samatcolumn commented 2 years ago

Right now the latest version of @types/jest-axe is 3.5.3 which provides types for jest-axe v3.5. This is not the latest version of jest-axe and it assumes a different major version of axe-core which means there are conflicts in the types for axe.RunOptions, etc:

npm ls axe-core
...
├─┬ @types/jest-axe@3.5.3
│ └── axe-core@3.5.6 
├─┬ jest-axe@5.0.1
│ └── axe-core@4.2.1
NickColley commented 2 years ago

I think that this has been done by community members in the past so I cant help here sorry, if someone wants to update them in the community repos that's fine with me but I wont be maintaining types in this package itself, the API does not change hardly ever breaking changes are nearly always just updating axe-core incase of updated test results so should be minimal effort.

samatcolumn commented 2 years ago

@nickcolley that's fair, however you might want to remove the recommendation to install @types/jest-axe from the README since it's for version 3.x