create-typescript-app icon indicating copy to clipboard operation
create-typescript-app copied to clipboard
verified publisher icon JoshuaKGoldberg

📝 Documentation: `eslint-plugin-regex` vs `eslint-plugin-regexp`

Open fb55 opened this issue 1 year ago • 5 comments

Bug Report Checklist

  • [X] I have pulled the latest main branch of the repository.
  • [X] I have searched for related issues and found none that matched my issue.

Overview

I am currently reading through the docs to see if I can pick up anything new.

https://github.com/JoshuaKGoldberg/create-typescript-app/blob/8404b1dbe654ec90786eabd82a6196c90bf97771/docs/Tooling.md#lint-regex states that:

eslint-plugin-regex: Detects issues with JavaScript regular expressions, such as potential exponential complexity.

https://github.com/gmullerb/eslint-plugin-regex allows files to be checked against regular expressions, and does not validate regular expressions. https://github.com/ota-meshi/eslint-plugin-regexp is the plugin that validates regular expressions.

Additional Info

No response

fb55 avatar Aug 03 '24 08:08 fb55

Ha, nice spot! This is a pure docs issue. I slipped up and linked to the wrong plugin. It should be ota-meshi's eslint-plugin-regexp. Thanks for noting!

JoshuaKGoldberg avatar Aug 03 '24 13:08 JoshuaKGoldberg

i would like to work on this

Krupakar-Reddy-S avatar Aug 03 '24 16:08 Krupakar-Reddy-S

@all-contributors please add @fb55 for bug.

🤖 Beep boop! This comment was added automatically by all-contributors-auto-action. Not all contributions can be detected from Git & GitHub alone. Please comment any missing contribution types this bot missed. ...and of course, thank you for contributing! 💙

JoshuaKGoldberg avatar Aug 07 '24 04:08 JoshuaKGoldberg

@JoshuaKGoldberg

I've put up a pull request to add @fb55! :tada:

I couldn't determine any contributions to add, did you specify any contributions? Please make sure to use valid contribution names.

allcontributors[bot] avatar Aug 07 '24 04:08 allcontributors[bot]

@Krupakar-Reddy-S we don't have any issue claiming system (https://github.com/JoshuaKGoldberg/create-typescript-app/blob/212b5f7f767dd59473ec175408a6aa0e898fd0e5/.github/CONTRIBUTING.md#issue-claiming). If you've got a code change, you can go ahead and send a PR (please do!). 🚀

JoshuaKGoldberg avatar Aug 07 '24 05:08 JoshuaKGoldberg

👋 ping @Krupakar-Reddy-S, still planning on sending a PR?

JoshuaKGoldberg avatar Nov 09 '24 17:11 JoshuaKGoldberg

I'm going to go ahead and fix the CLI options and docs references too.

JoshuaKGoldberg avatar Dec 24 '24 19:12 JoshuaKGoldberg