search

chaijs / chai

BDD / TDD assertion framework for node.js and the browser that can be paired with any testing framework.
https://chaijs.github.io
MIT License
8.15k stars 698 forks source link

Docs issues galore with ESM vs CommonJS use #1654

Open delfuego opened 5 days ago

delfuego commented 5 days ago

The primary docs site is replete with issues related to the use of Chai, specifically in terms of the differences between Chai 4 and Chai 5.

For example, there are still plenty of places that read that one should use:

import chai from 'chai';

when the Chai 5 ESM-only version doesn't have a default exported object, so that fails. It took me a while to figure out that everything is now a named export, so if I want to use a plugin, I have to use:

import { use, expect } from 'chai';

and then change all my chai.use() calls to just use that newly-exported use method.

Is there a Chai 5/ESM-only doc page that helps folks make these changes?