Auto addition of `#|` messes code on "return"

[mcanouil]

This can also happen in other less reproducible situations on save.
Currently, the way #| is not really reliable and most of the time causes issues rather than the opposite.

#| should only be added at the beginning of a new line.

Screen.Recording.2024-04-26.at.17.56.41.mov

[juliasilge]

The handling for #| looks very complicated to me (although part of that is for autocompletion for the YAML options). Maybe some of that could be simplified to instead have an "OnEnter" rule in this file like:

{
    "beforeText": "^\\s*#+\\|",
    "action": { "indent": "none", "appendText": "#| " }
}

This rule results in behavior that is much better.

[mcanouil]

The code for the this option is:

• added here: 209975b

• quarto/apps/vscode/src/providers/option.ts

  Lines 71 to 91 in 57ed6fb

  	function handleOptionEnter(editor: TextEditor, comment: string) {
  	// option comment for this language
  	const optionComment = comment + "| ";
  	// current line info
  	const currentLineNumber = editor.selection.active.line;
  	const currentLine = editor.document.lineAt(editor.selection.start).text;
  	// apply edits
  	if (currentLine.trim() === optionComment.trim()) {
  	editor.edit((builder) => {
  	builder.delete(new Range(new Position(currentLineNumber, 0), new Position(currentLineNumber, currentLine.length)));
  	});
  	} else if (currentLine.startsWith(optionComment)) {
  	editor.edit((builder) => {
  	builder.insert(editor.selection.start.translate(1, 0), optionComment);
  	});
  	}
  	}

I will try to take an hit on this because this behaviour does too much harm around me (compare to the little typing gain), especially with users/colleagues not knowing about this.
I personally know about this but have to revert the changes caused by the extension on a day by day basis.

[mcanouil]

Note that the feature needs to use the appropriate comment symbol, so using the native API as suggested might be a bit tricky if not impossible.

[mcanouil]

PR to fix this is up:

• fix: Ensure #| is added only at the beginning of a new line #649

Below is a recording before/after:

Screen.Recording.2025-02-03.at.14.13.16.mov

[juliasilge]

Note that the feature needs to use the appropriate comment symbol, so using the native API as suggested might be a bit tricky if not impossible.

If you are talking about onEnterRules, they can be used in pretty flexible ways. For example, see:

https://github.com/posit-dev/positron/blob/9d2b4d01d4732d5113dc36f3a57abd4a0ced129e/extensions/positron-r/language-configuration/r-language-configuration.json#L44-L64

[mcanouil]

I mean, you need to hardcode everything inside language configuration for each possible language there could be in a Quarto document, I believe that is why there is a "custom on enter provider" which is more agnostic and only applies to code cells:

• https://github.com/posit-dev/positron/blob/9d2b4d01d4732d5113dc36f3a57abd4a0ced129e/extensions/positron-r/language-configuration/r-language-configuration.json#L44-L64

Unless I am missing something (which is possible as I don't master the language configuration/contribution in the VSCode API), I don't think you can set the onEnterRules rule here.

[mcanouil]

Probably worth reopening as the behaviour is still not perfect.
Now, it, at least, do not insert the comment in the middle but it still adds the comment on the next line at the beginning in some circumstances.

For instance:

```{python}
#| error: true
bad("code")
some other code
```

sometimes become (not yet fully sure when this is triggered)

```{python}
#| error: true
#| bad("code")
some other code
```