Refactor base rule with better typing and organization

dangreenisrael / eslint-plugin-jest-formatting

ESLint rules for formatting test suites written for jest.

MIT License

156 stars 13 forks source link

Refactor base rule with better typing and organization #70

Closed benkimpel closed 5 years ago

benkimpel commented 5 years ago

Move AST utility functions to separate file
Create/export enums to help build/read configuration objects
Add an interface and better property names for configuration objects
Rename makeRule to createRule and move to main file
Delete src/utils.ts
Add TODO for removing filename test in rule
Fix last implicit any and enable noImplicitAny in tsconfig

benkimpel commented 5 years ago

I wanted to get this file cleaned up before I opened a few additional PRs/changes...

Make padding-around-all rule (WIP here)
Add missing x/f jest tokens (WIP here)
Move filename checking into overrides in our configs objects and add technique to our docs
Move src/rules/padding.ts to src/padding.ts since it's not really a rule.

benkimpel commented 5 years ago

I think the only controversial thing in this PR would be the change in tsconfig.json. @dangreenisrael let me know how you feel about that one.

Also, give the padding.ts file a read from start to finish (outside of the diff... the diff is a mess). I hope it reads easier with the changes I've made. My goal was to make things a little more clear.

benkimpel commented 5 years ago

@dangreenisrael I think I'm going to close this PR and bundle these items into one PR with the following commits...

This refactor
padding-around-all rule and missing x/f jest functions
Remove the filename checks in the rule and add overrides.files to our configs and documentation
Rename src/rules/padding.ts to src/padding.ts

That can save us a few code review cycles. Lemme know if you disagree and we can reopen this PR as a standalone.