Add warning diagnostic when using V2 api #33
Closed
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
microbit-robert
commented
May 3, 2024
•
microbit-robert
commented
- Translation sync required before merge and use (or at least addition of new strings in all simplified language files in English for now). Keeping in draft until this is done.
microbit-robert
commented
May 7, 2024
Comment on lines
+391
to
+401
| maybeAddMicrobitVersionWarningBinderWrapper(importResult.importName, () => | ||
| this._addDiagnostic( | ||
| this._fileInfo.diagnosticRuleSet.reportMicrobitV2ApiUse, | ||
| DiagnosticRule.reportMicrobitV2ApiUse, | ||
| Localizer.Diagnostic.microbitV2ModuleUse().format({ | ||
| moduleName: importResult.importName, | ||
| device, | ||
| }), | ||
| node | ||
| ) | ||
| ); |
There was a problem hiding this comment.
This is setup with a callback so we can track micro:bit specific diagnostics in one file, microbitUtils.ts. Useful if we only want to warn on the first use of a V2 API call in the future. We can't directly pass in this_.addDiagnostic as this causes errors.
microbit-robert
commented
May 7, 2024
Comment on lines
39
to
45
| return ( | ||
| ['log', 'microbit.microphone', 'microbit.speaker', 'power'].includes(moduleName) || | ||
| (moduleName === 'microbit' && | ||
| ['run_every', 'set_volume', 'Sound', 'pin_logo', 'pin_speaker'].includes(name ?? '')) || | ||
| (moduleName === 'microbit.audio' && name === 'SoundEffect') || | ||
| (moduleName === 'neopixel' && ['fill', 'write'].includes(name ?? '')) | ||
| ); |
There was a problem hiding this comment.
Hardcoded, but only in one place. Are any missing?
microbit-robert
commented
May 7, 2024
Comment on lines
+61
to
+63
| "microbitV2ClassMethodUse": "The \"{methodName}\" method on the \"{className}\" class cannot be used with a {device}", | ||
| "microbitV2ModuleMemberUse": "\"{name}\" from the \"{moduleName}\" module cannot be used with a {device}", | ||
| "microbitV2ModuleUse": "\"{moduleName}\" cannot be used with a {device}", |
There was a problem hiding this comment.
Highlighting for review as these will be tweaked based on prior discussion.
|
I've tried for an alternative on #35 Mainly focussed on the layer we do this at but I've also made some incidental changes to the error code/text. |
|
Merged the alternative on #35 |
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.