Marc Cataford
bc2bd85422
* feat: autodoc * docs: autodoc output docs: autodoc output * build: document generator * ci: add doc check * chore: add docs * ci: finagle with docs stale check ci: target generated docs for diff * ci: remove check * docs: add links * docs: more matcher documentation
1.4 KiB
works-on-my-machine (womm)
✨ A full-nonsense pet test runner ✨
So, what is this?
Software in the NodeJS ecosystem tends to depend a lot on external dependencies. What would a test runner without any look like? This is the question that started all of this.
womm is a pet test runner that follows the general direction of jest and playwright with a few additional
constraints:
- It must not have any production dependencies (some development dependencies are permissible, like
typescriptandrome, but keeping it to a minimum); - It must be compatible with the general API exposed by Jest and the like, for familiarity;
- It must use itself for testing.
Hot takes baked in
womm is an opinionated implementation of Typescript/Javascript testing libraries we've all come to get used to. You
can peek at the opinions baked into this here.
Documentation
Documentation can be found here and welcomes contributions!
API documentation can also be found here.
Development
This uses Corepack, which comes bundled with node>=16 to manage which Yarn version to use.
To get started, just corepack enable before using yarn commands. You can also jump in by running . script/bootstrap, which will select the right version of Node, enable Corepack and install devDependencies.