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

feat: ability to flag words based on patterns #1704

Closed
danisharora099 opened this issue Nov 6, 2023 · 6 comments · Fixed by #1709
Closed

feat: ability to flag words based on patterns #1704

danisharora099 opened this issue Nov 6, 2023 · 6 comments · Fixed by #1709
Assignees
Labels
enhancement New feature or request

Comments

@danisharora099
Copy link
Collaborator

danisharora099 commented Nov 6, 2023

This is a *feature request

Problem

Our current word/spelling check library, cSpell, does not offer a feature to flag words based on patterns/regex.

This introduced leaks that need to be manually resolved: #1703

Proposed Solutions

  • change word-check library from cSpell to a library that supports flagging words with patterns
  • write a utility script that parses & replaces words based on a pattern
@weboko
Copy link
Collaborator

weboko commented Nov 6, 2023

Do we even need this cspell? 😅

@danisharora099
Copy link
Collaborator Author

danisharora099 commented Nov 6, 2023

Do we even need this cspell? 😅

It helps me mostly in terms of choosing british vs american english. I can see some more use cases but not as significant as the one mentioned.

Would definitely help if we could flag patterns :P

@chair28980 chair28980 added the enhancement New feature or request label Nov 7, 2023
@chair28980 chair28980 moved this to To Do in Waku Nov 7, 2023
@adklempner
Copy link
Member

adklempner commented Nov 7, 2023

https://cspell.org/configuration/patterns/

(Nvm, this is for matching which patterns should be spellchecked, not a pattern that is considered invalid)

@chair28980
Copy link
Contributor

Action items per js-waku pm 2023-11-07

  • research existing solutions
  • implement homegrown solution (less desirable) -- will require ongoing maintenance.

Danish:

  • We should come to consensus on how we should handle theses cases.

@adklempner
Copy link
Member

I have an MR which adds an eslint rule that uses regex to forbid any identifiers which contain pubSub or PubSub: #1709

I think it should cover most cases.

@adklempner adklempner moved this from To Do to Code Review / QA in Waku Nov 7, 2023
@danisharora099
Copy link
Collaborator Author

I have an MR which adds an eslint rule that uses regex to forbid any identifiers which contain pubSub or PubSub: #1709

I think it should cover most cases.

this resolves this issue!
will be closed with #1703

@github-project-automation github-project-automation bot moved this from Code Review / QA to Done in Waku Nov 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

5 participants