feat(require-author): add new require-author rule
#851
Conversation
This change adds the first or our new `require-` rules, and creates some foundational plumbing to make it super easy to add new require rules. I've only done author in this PR. Assuming this all looks good, we can quickly knock all the rest of the require rules in one shot.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #851 +/- ##
==========================================
+ Coverage 98.71% 98.77% +0.06%
==========================================
Files 19 21 +2
Lines 1163 1220 +57
Branches 139 142 +3
==========================================
+ Hits 1148 1205 +57
Misses 15 15 ☔ View full report in Codecov by Sentry. |
src/rules/require-properties.ts
Outdated
There was a problem hiding this comment.
[Style] A couple of quick thoughts here:
- I don't think the
////*comments are worth their weight; IMO their content is inferable from the file - We could trim this down just a bit by using an
as constand an array of tuples
WDYT of this?
const properties = [
["author", false],
// TODO: more to come :)
] as const;
export const rules = Object.fromEntries(
properties.map(([propertyName, recommended]) => [
`require-${propertyName}`,
createRequirePropertyRule(propertyName, recommended),
]),
);There was a problem hiding this comment.
I like the idea of using tuples here. I changed the properties object over to that, but kept satisfies in there to enforce a type expectation. I also went with a reducer, since that felt a bit more readable / communicative.
There was a problem hiding this comment.
Also surfacing from a 1:1 conversation: I'm not against trying out more comments 😄
| ], | ||
| valid: [ | ||
| `{ "main": "./index.js", "author": "Sophie Trudeau" }`, | ||
| `{ "author": "Jessica Moss" }`, |
There was a problem hiding this comment.
[Question] What is the reference with these names? Google isn't helping me 😄
There was a problem hiding this comment.
They're both members of an amazing post-rock band, Thee Silver Mt. Zion, which spun out of pioneer post-rock band Godspeed You! Black Emperor. Sophie's also a member of GYBE, and Jessica is married to Efrim who's also in both. I originally had two other people, but cspell didn't recognize the words "Reznor", "Efrim", or "Menuck", so I went with these 😊
JoshuaKGoldberg
added
the
status: waiting for author
michaelfaith
removed
the
status: waiting for author
There was a problem hiding this comment.
💯 glorious!
Want to merge it whenever you're ready @michaelfaith?
|
🎉 This is included in version v0.22.0 🎉 The release is available on: Cheers! 📦🚀 |
PR Checklist
status: accepting prsOverview
This change adds the first or our new
require-rules, and creates some foundational plumbing to make it super easy to add new require rules. I've only done author in this PR. Assuming this all looks good, we can quickly knock all the rest of the require rules in one shot.