Rule proposal: test-title-format

[alexander-akait]

Give to check the title on a specific regex pattern.
We adhere to specific naming titles, but the new members in the team are sometimes overlooked or do mistake.

IssueHunt Summary

gmartigny has been rewarded.

Sponsors (Total: $60.00)

• issuehunt ($60.00)

Tips

• Checkout the Issuehunt explorer to discover more funded issues.
• Need some help from other developers? Add your repositories on IssueHunt to raise funds.

[sindresorhus]

Sounds like a good idea. Would you mind providing some examples of the test titles you use?

[alexander-akait]

@sindresorhus
All our test starting at should succeed when (if, for) ..., should fail when (if, for), should throw exception when (if, for) ..., ``should not throw exception when (if, for) ...` and etc.

[jfmengels]

FYI, eslint-plugin-mocha has similar rules: valid-test-description and valid-suite-description.

Sounds good to me too.

[sindresorhus]

What kind of regex would you use? Should it also support hooks?

[alexander-akait]

@sindresorhus ^should (pass|fail|(not)?\sthrow)\s.+$

[jfmengels]

I'm guessing that if you pass a regex to the rule's options (only possible when you configure your lint file in JS), we'll use it as is, but if you pass a string, we'll transform it with new Regex, meaning you'll probably need to use espacing in your regex, like ^should (pass|fail|(not)?\\sthrow)\\s.+$

[alexander-akait]

@jfmengels sgtm for me

[sindresorhus]

Sounds good. Pull request welcome :)

---

Alternative rule name suggestions:

• valid-test-title
• test-title-style
• test-title-format

[jfmengels]

I like test-title-format.

[IssueHuntBot]

@IssueHunt has funded $60.00 to this issue.

---

• Submit pull request via IssueHunt to receive this reward.
• Want to contribute? Chip in to this issue via IssueHunt.
• Checkout the IssueHunt Issue Explorer to see more funded issues.
• Need help from developers? Add your repository on IssueHunt to raise funds.

[IssueHuntBot]

@sindresorhus has rewarded $54.00 to @GMartigny. See it on IssueHunt

• 💰 Total deposit: $60.00
• 🎉 Repository reward(0%): $0.00
• 🔧 Service fee(10%): $6.00