-
Notifications
You must be signed in to change notification settings - Fork 1
chore(KNO-8961): remove withReadonlyField option #549
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore(KNO-8961): remove withReadonlyField option #549
Conversation
This stack of pull requests is managed by Graphite. Learn more about stacking. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm although I'm not 100% sure what the intended purpose of read only fields is in the CLI
opts: ReadLayoutDirOpts = {}, | ||
): Promise<ParseJsonResult | JoinExtractedFilesResult> => { | ||
const { abspath } = layoutDirCtx; | ||
const { withExtractedFiles = false, withReadonlyField = false } = opts; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It appears we never set withReadonlyField to true anywhere within the codebase.
It's been awhile so I'm trying to remember (😅) but I think I provided these options for completeness early on, to mirror the annotation directive which controls how a resource payload gets transformed and written into a json file.
And conceptually these "read" functions do the inverse, so I probably thought having options to control how the read behavior works with respect to extractable and readonly fields made sense. But it turned out the commands we have (so far at least) that reads from the file system haven't necessarily needed to care about the read only fields .
Description
This PR removes the
withReadonlyField
option from the various functions used to read resource directories. It appears we never setwithReadonlyField
totrue
anywhere within the codebase.Tasks
KNO-8961