Wrap code editor for template selector #21104
Conversation
WalkthroughWalkthroughThis update introduces Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HaTemplateSelector
participant HaCodeEditor
participant CodeMirror
User->>HaTemplateSelector: Initialize HaTemplateSelector with linewrap
HaTemplateSelector->>HaCodeEditor: Create ha-code-editor with linewrap attribute
HaCodeEditor->>CodeMirror: Initialize editor with linewrapCompartment
CodeMirror-->>HaCodeEditor: Editor ready with line wrapping
HaCodeEditor-->>HaTemplateSelector: ha-code-editor initialization complete
HaTemplateSelector-->>User: Selector ready with updated code editor
Recent review detailsConfiguration used: CodeRabbit UI Files selected for processing (1)
Additional comments not posted (3)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range comments (2)
src/components/ha-code-editor.ts (2)
Line range hint
107-107: Consider replacing non-null assertions with optional chaining.Non-null assertions can lead to runtime errors if not handled properly. Consider replacing them with optional chaining (
?.) to improve code safety and robustness.- this.codemirror!.destroy(); + this.codemirror?.destroy();Also applies to: 127-127, 134-134, 135-135, 141-141, 142-142, 164-164, 252-252
Line range hint
108-108: Avoid using thedeleteoperator.Using the
deleteoperator can lead to performance issues. It's better to set properties toundefinedto allow for better optimization by JavaScript engines.- delete this.codemirror; + this.codemirror = undefined;
🤷♂️ if you think that's better I can change it to that 👍 |
There was a problem hiding this comment.
Actionable comments posted: 3
Outside diff range comments (1)
src/components/ha-code-editor.ts (1)
Line range hint
108-108: Replace thedeleteoperator with setting toundefinedto improve performance.- delete this.codemirror; + this.codemirror = undefined;Using
deleteon properties can degrade performance by hindering JavaScript engine optimizations. Setting the property toundefinedis generally a better practice.
| @@ -47,6 +47,8 @@ export class HaCodeEditor extends ReactiveElement { | |||
|
|
|||
| @property({ type: Boolean }) public readOnly = false; | |||
|
|
|||
| @property({ type: Boolean }) public linewrap = false; | |||
There was a problem hiding this comment.
Add a brief comment describing the purpose of the linewrap property.
Adding a comment above this property will improve code readability and maintainability, helping future developers understand its use more quickly.
| this._loadedCodeMirror.linewrapCompartment.of( | ||
| this.linewrap ? this._loadedCodeMirror.EditorView.lineWrapping : [] | ||
| ), |
There was a problem hiding this comment.
Ensure the use of non-null assertions is safe here.
- this._loadedCodeMirror!.linewrapCompartment!.of(
+ this._loadedCodeMirror?.linewrapCompartment?.of(As previously noted, using non-null assertions without checks can lead to runtime issues. Optional chaining should be used instead to ensure the code is robust against null values.
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| this._loadedCodeMirror.linewrapCompartment.of( | |
| this.linewrap ? this._loadedCodeMirror.EditorView.lineWrapping : [] | |
| ), | |
| this._loadedCodeMirror?.linewrapCompartment?.of( | |
| this.linewrap ? this._loadedCodeMirror.EditorView.lineWrapping : [] | |
| ), |
| if (changedProps.has("linewrap")) { | ||
| transactions.push({ | ||
| effects: this._loadedCodeMirror!.linewrapCompartment!.reconfigure( | ||
| this.linewrap ? this._loadedCodeMirror!.EditorView.lineWrapping : [] | ||
| ), | ||
| }); | ||
| } |
There was a problem hiding this comment.
Ensure the use of non-null assertions is safe here.
- this._loadedCodeMirror!.linewrapCompartment!.reconfigure(
+ this._loadedCodeMirror?.linewrapCompartment?.reconfigure(The non-null assertion operator (!) is used multiple times, which can lead to runtime errors if this._loadedCodeMirror or linewrapCompartment is null. Consider replacing it with optional chaining (?.) to make the code safer.
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| if (changedProps.has("linewrap")) { | |
| transactions.push({ | |
| effects: this._loadedCodeMirror!.linewrapCompartment!.reconfigure( | |
| this.linewrap ? this._loadedCodeMirror!.EditorView.lineWrapping : [] | |
| ), | |
| }); | |
| } | |
| if (changedProps.has("linewrap")) { | |
| transactions.push({ | |
| effects: this._loadedCodeMirror?.linewrapCompartment?.reconfigure( | |
| this.linewrap ? this._loadedCodeMirror?.EditorView.lineWrapping : [] | |
| ), | |
| }); | |
| } |
Tools
Biome
[error] 141-141: Forbidden non-null assertion. (lint/style/noNonNullAssertion)
Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator
[error] 141-141: Forbidden non-null assertion. (lint/style/noNonNullAssertion)
Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator
[error] 142-142: Forbidden non-null assertion. (lint/style/noNonNullAssertion)
Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator
Co-authored-by: Simon Lamon <32477463+silamon@users.noreply.github.com>
frenck
added
the
Noteworthy
Proposed change
Wraps lines in the code editor for the template selector
Type of change
Example configuration
Additional information
Checklist
If user exposed functionality or configuration variables are added/changed:
Summary by CodeRabbit
wrapandlinewrapattributes to the code editor component, allowing users to toggle line wrapping on or off.