Update types for upcoming changes #22
Conversation
| { | ||
| type: 'object', | ||
| properties: { | ||
| action: { |
There was a problem hiding this comment.
Is the plan to add more properties to this?
| */ | ||
|
|
||
| /** | ||
| * @typedef {boolean | SocketIssueRuleObject} SocketIssueRuleValue |
There was a problem hiding this comment.
A few thoughts after mulling over it. Curious what your thoughts are:
Did you consider something more like
| * @typedef {boolean | SocketIssueRuleObject} SocketIssueRuleValue | |
| * @typedef {boolean | 'defer' | 'error' | 'warn' | 'ignore'} SocketIssueRuleValue |
Just thinking
issueRules:
- didYouMean: 'warn'
- installScript: 'error'Is easier to remember than
- didYouMean:
action: 'warn'
- installScript:
action: 'error'If we have plans for additional keys, maybe the object makes sense. Do we have an idea what those would be and how they would be used?
The other thought I had was what was the purpose of the defer rule action? error and warn take the place of true, ignore is a synonym for false. But omitting a rule is implicitly a defer. Does it enable some kind of new functionality or just serve the role of explicitly defining that behavior?
There was a problem hiding this comment.
We definitely should look at telemetry and role based prompting here which is why I'm not keen on a string, if we do a string now it would be more breaking in the future. defer is to allow explicit saving of that so that the behavior is recorded and not changed. Some UI toggling for example of true/false with a checkbox cannot represent this currently and has an implicit (very hard to understand) 3rd state that is like defer going on right now.
No description provided.