https://github.com/unjs/magic-regexp

A compiled-away, type-safe, readable RegExp alternative
https://github.com/unjs/magic-regexp

hacktoberfest regex regexp regular-expression typescript

Last synced: 3 days ago
JSON representation

A compiled-away, type-safe, readable RegExp alternative

• Host: GitHub
• URL: https://github.com/unjs/magic-regexp
• Owner: unjs
• License: mit
• Created: 2022-07-16T16:22:08.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T01:28:05.000Z (about 2 months ago)
• Last Synced: 2024-10-29T15:07:55.441Z (about 1 month ago)
• Topics: hacktoberfest, regex, regexp, regular-expression, typescript
• Language: TypeScript
• Homepage: https://regexp.dev
• Size: 3.4 MB
• Stars: 3,909
• Watchers: 15
• Forks: 53
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

• awesome - unjs/magic-regexp - A compiled-away, type-safe, readable RegExp alternative (TypeScript)
• my-awesome-list - magic-regexp - away, type-safe, readable RegExp alternative | unjs | 3949 | (TypeScript)

README

        
# 🦄 magic-regexp

[![npm version][npm-version-src]][npm-version-href]

[![npm downloads][npm-downloads-src]][npm-downloads-href]

[![Github Actions][github-actions-src]][github-actions-href]

[![Codecov][codecov-src]][codecov-href]

[![Bundlephobia][bundlephobia-src]][bundlephobia-href]

> A compiled-away, type-safe, readable RegExp alternative

- [✨  Changelog](https://github.com/danielroe/magic-regexp/blob/main/CHANGELOG.md)

- [📖  Documentation](https://regexp.dev)

- [▶️  Online playground](https://stackblitz.com/github/danielroe/magic-regexp/tree/main/playground)

## Features

- Runtime is zero-dependency and ultra-minimal

- Ships with transform to compile to pure RegExp

- Automatically typed capture groups

- Natural language syntax

- Generated RegExp displays on hover

[📖  Read more](https://regexp.dev)

## 💻 Development

- Clone this repository

- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable` (use `npm i -g corepack` for Node.js < 16.10)

- Install dependencies using `pnpm install`

- Run interactive tests using `pnpm dev`

## Similar packages

- [verbal-expressions](http://verbalexpressions.github.io/)

- [typed-regex](https://github.com/phenax/typed-regex/)

## License

Made with ❤️

Published under [MIT License](./LICENCE).

[npm-version-src]: https://img.shields.io/npm/v/magic-regexp?style=flat-square

[npm-version-href]: https://npmjs.com/package/magic-regexp

[npm-downloads-src]: https://img.shields.io/npm/dm/magic-regexp?style=flat-square

[npm-downloads-href]: https://npmjs.com/package/magic-regexp

[github-actions-src]: https://img.shields.io/github/actions/workflow/status/danielroe/magic-regexp/ci.yml?branch=main&style=flat-square

[github-actions-href]: https://github.com/danielroe/magic-regexp/actions?query=workflow%3Aci

[codecov-src]: https://img.shields.io/codecov/c/gh/danielroe/magic-regexp/main?style=flat-square

[codecov-href]: https://codecov.io/gh/danielroe/magic-regexp

[bundlephobia-src]: https://img.shields.io/bundlephobia/minzip/magic-regexp?style=flat-square

[bundlephobia-href]: https://bundlephobia.com/package/magic-regexp