Reggex NPM | npm.io

A programmatic and human-readable API to create strongly-typed regular expressions in Typescript.

📖 Table of Contents

⚡ Features

This library is still under active development. Once the API becomes more stable, the README will be updated with more useful documentation.

🧑‍💻 Development

This project is open to any contributions via pull requests! Here are some steps to help with any contributions you would like to make:

Clone the repo (git clone git@github.com:pcbowers/reggex.git)
Install the dependencies using pnpm (pnpm install)
Run tests interactively using vitest while making changes (pnpm run dev)
Ensure all the lint tests pass using prettier and eslint (pnpm run lint)
Ensure the package can be built using tsup (pnpm run build)
Use changesets to describe any release-dependent changes (pnpm run changeset)
Commit and Push your changes, ensuring any CI workflows pass
Create a Pull Request to begin the review process and get your changes merged!

Tired of running all these commands? Use pnpm run ci to run the tests, lint, build, and export checks all at once!

More details for the curious:

This package relies heavily on tests. For any developer out there that hasn't contributed to projects using tests, don't fret! This package prioritizes developer experience, so tests are fast and easy to get up and running. If you have questions, don't hesitate to reach out! Code coverage is used as the metric in this project to ensure tests are being written.
If you don't have auto-format on save setup in your editor, linting will fail. I would highly suggest enabling this feature in your editor. If you don't want to do this, run pnpm prettier --write . before a commit to ensure any CI workflows pass.
This project relies on the @changesets/cli to version and publish the package. If you are making a change that is not CI/Document related, add a changeset for each change you make to help document the new features/bug fixes/breaking changes that are being made.

If you've never contributed to open source before and have some questions, reach out via an issue and I'd be happy to guide you to some resources or answer your questions!