squirrellyjs / squirrelly

Semi-embedded JS template engine that supports helpers, filters, partials, and template inheritance. 4KB minzipped, written in TypeScript β›Ί
https://squirrelly.js.org
MIT License
635 stars 83 forks source link

Add clarifications to broken-down regEx #60

Closed first-timers[bot] closed 5 years ago

first-timers[bot] commented 6 years ago

πŸ†•πŸ₯☝ First Timers Only.

This issue is reserved for people who never contributed to Open Source before. We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you πŸ’

About First Timers Only.

πŸ€” What you will need to know.

Nothing. This issue is meant to welcome you to Open Source :) We are happy to walk you through the process.

πŸ“‹ Step by Step

@@ -45,9 +45,10 @@ export function replaceParamHelpers (params) {
   })
   return params
 }
-// The initial RegExp broken down:
+// The whole regular expression can be hard to comprehend, so here it's broken down.
+// You can pass the string between "START REGEXP" and "END REGEXP" into a regular expression
+// That removes whitespace and comments, and outputs a working regular expression.

-// Total RegEx:
 /* START REGEXP
 {{ *? //the beginning
 (?: //or for each possible tag
  1. If you are familiar with the terminal or would like to learn it, here is a great tutorial on how to send a pull request using the terminal.

  2. You can edit files directly in your browser

πŸ€”β“ Questions

Leave a comment below!

This issue was created by First-Timers-Bot.

sambhavkaul commented 6 years ago

I would like to claim this issue.

Artistic18 commented 6 years ago

Can i work on it?

ptella commented 6 years ago

Can I work on it please?

nebrelbug commented 6 years ago

Great! Reserved for @1Oozaru1.

nebrelbug commented 6 years ago

@Artistic18 you can work on the next issue that opens up.

Artistic18 commented 6 years ago

ok thanks

electricgnome commented 6 years ago

Hi, I'd like to claim this issue

nebrelbug commented 6 years ago

@electricgnome this issue is already reserved, but you could work on #87 or another issue with the 'available' label.

nebrelbug commented 5 years ago

@1Oozaru1 if you're not able to work on this issue within the next few days, will you let someone else work on it? Thank you!

sambhavkaul commented 5 years ago

@nebrelbug Hi, I had summited a PR regarding this issue the day I claimed it which was merged as well. So that doesn't mean this issue is resolved ? Or is there anything left in this ?

nebrelbug commented 5 years ago

Sorry @1Oozaru1, my bad. I must have forgotten to close this issue and mistakenly assumed it was open. Thank you for telling me!