Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document array of matching expressions for onlyOn configuration property #60

Closed
lstrojny opened this issue Mar 18, 2022 · 1 comment · Fixed by #74
Closed

Document array of matching expressions for onlyOn configuration property #60

lstrojny opened this issue Mar 18, 2022 · 1 comment · Fixed by #74
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers ready This issue is ready for us to code on it

Comments

@lstrojny
Copy link

onlyOn either by accident or consciously support passing an array of matching expressions. Probably worth mentioning that in the documentation.
This happy coincidence allows me to work around #59

@LMaxence
Copy link
Member

LMaxence commented Mar 18, 2022

Hello !

Actually, is totally fortunate but yes a list of string can be passed in the onlyOn option. I just realized it here but it is due to 2 things:

  • TypeScript/JavaScript does not perform any type checking at runtime, so if you write an array in a string typed reference, well, it won't be noticed until it raises an error.
  • wildcard-match, the library I use for doing the pattern matching actually supports being provided with an array of strings

From here, I see two things to do:

  1. Fix the documentation indeed, so that it is documented that you can use a list of strings
  2. Find a way to improve this system as you mentioned it in Support more matching capabilties #59 (I'll document it on this issue)

Let's keep this open for the first point :)

I'm a bit late on documenting how to contribute to the docs (and to the project in general but it's definitely my next up thing to do on Mookme !). It's nothing more than a common vuepress project.

You'll want to update the file located in docs/references/README.md which describes the onlyOn option.

Otherwise I'll leave it open and fix this at some point but it's a very good first issue for eventual contributors

@LMaxence LMaxence added documentation Improvements or additions to documentation good first issue Good for newcomers ready This issue is ready for us to code on it labels Mar 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers ready This issue is ready for us to code on it
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants