ebolaware/i-hate-regex repository overview

⁠ iHateRegex 😈

⁠ ⁠

⁠

don't just use; understand.

iHateRegex.io⁠ - a regex cheatsheet for the haters.

Chat with us on Telegram⁠

⁠Features 😎

• Visual representation of regular expressions
• Matched strings - the Testing area
• Embed regular expression visualization on your sites
• Regex code highlighting and validation
• Regex description with markdown support
• Playground page⁠ where you can create your own expression and link to it.
• User login and save regex

⁠Setup 🚀

1. Install yarn⁠

2. Clone⁠ this repo

3. Install dependencies ⚙️

$ yarn install

1. Test on localhost 🛠

# serve with hot reload at localhost:3600
$ yarn dev

1. Build and Start nuxt server 🚀

# build for production and launch server
$ yarn build
$ yarn start

This project is built with Nuxt.js 🙌

For detailed explanation on how things work, check out Nuxt.js docs⁠.

⁠Contribute Regex 🙏

Contribute to this project and make this the largest collection of useful expressions 😍

You can also submit regex via this google form⁠

⁠To contribute:

1. Add your regex to /static/regex/data.json

{
        "id": "username",
        "title": "username",
        "tagline": "match a username",
        "description": "Alphanumeric string that may include _ and - having a length of 3 to 16 characters.",
        "regex": "^[a-z0-9_-]{3,15}$",
        "flag": "gm",
        "matchText": [
            "lorem",
            "ipsum",
            "gr3at",
            "a",
            "ab",
            "abcd",
            "abcde",
            "john doe",
            "johnny",
            "abcdefghijklmnopqrst"
        ],
        "cheatRegex": [
            "/^/",
            "/$/",
            "/[a-zA-Z0-9]/",
            "/(hello){1,3}/"
        ],
        "embedHeight": 300,
        "tags" : ["name", "slug"]
    },

1. Create a markdown file in /static/regex/markdown/ named <regex-id>.md for longer description and explaination

   <regex-id> is the id from data.json

That's it 🙌 Go ahead and shoot a new pull request✨✨

⁠Descriptions

There are 2 descriptions for each regex.

• One is the description property inside /static/regex/data.json.

  • This is used for page meta description as well.
  • This is the first description

• Second is a dedicated markdown file in /static/regex/markdown/<file>.md

  • This should explain the working of the expression in detail
  • This is the long description
  

⁠Sponsors 💖

⁠

Donate via Opencollective⁠

⁠Credits

• The visual demo is built with: regexper⁠