Implement ViolationUtils lib #31083 #73
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Re-pointed this to violations-utils. |
cdanwards
approved these changes
Nov 20, 2023
There was a problem hiding this comment.
Nice! It's not their usual pattern to include the methods in a module but with the way they use them, this makes more sense. They also might want JSDoc for the params on the functions. I say might because I haven't encountered their expectations for ts files yet.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This implements the ViolationUtils lib as requested in Expensify#31083
Some notes on approach:
He asked for those
violationFieldsandformFieldsobjects, I think as a sort of hack to get some type checking and type safety. I replaced that with string literal union types andRecords -- it's a more idiomatic way to do what he was trying to do, and I think will be better long-term. I asked for his feedback on the approach here. I don't think he's a JS / TS dev so hopefully he finds this helpful, but if he doesn't like it, it'll be pretty easy to switch it back.I had to add some stuff to
ONYXKEYSand toonyx/types-- please take a look and let me know if anything seems like it's in completely the wrong place.Otherwise should be pretty straightforward!
This is a draft pending his approval of the approach, but would appreciate reviews so I can ship it as soon as he gives me the go-ahead.