HTML close-tag auto-insertion (`onTypeFormatting` on `>`) closes the wrong element
メンテナーはふだん 1 日以内に返信
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 38/100
- issue の種類
- バグ
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- typescript
調査の方向性
Start from HtmlElementAutoclosingOnTypeFormattingProvider, which handles textDocument/onTypeFormatting with ch >; reproduce with the <ul>\n <li>\n</ul> snippet and trace how the element lookup behaves when the tree parses into an error node. Read the earlier fix from PR #516 for context on Liquid branches. Note a linked open PR (#1328) already targets this issue, so check its status before starting; done means the response inserts </li> for the just-opened element in the error-state document.
索引モデルが issue の本文から書いたものです。
説明
Describe the bug
When I type > to finish an opening tag, the language server's textDocument/onTypeFormatting response inserts the closing tag of the parent element instead of the element I just opened. In my case the parent's closing tag already exists later in the document (the usual situation when adding a child to existing markup). I noticed it in Zed, but the wrong text comes from the server's response (see "Additional context").
Source
<ul>
</ul>
Steps: on the empty line, type <li>. The cursor is right after the >.
Expected behaviour
</li> is inserted after the cursor.
Actual behaviour
</ul> is inserted:
<ul>
<li></ul>
</ul>
The server then reports Attempting to close HtmlElement 'ul' before HtmlElement 'li' was closed on the inserted text.
Debugging information
- OS: Mac
- OS Version: 27.0.1
- Theme Check Version: n/a, I'm using the language server through the Zed Liquid extension, version 0.7.0
- Editor: Zed 1.22.0
Additional context
LSP trace. The trace below comes from a larger file (header.liquid), so the line and character numbers differ from the snippet above. The document at the time of the request (unclosed <li> followed by the existing </ul>):
<ul>
<li>
</ul>
Request:
{"jsonrpc":"2.0","id":46,"method":"textDocument/onTypeFormatting","params":{"textDocument":{"uri":"file:///.../header.liquid"},"position":{"line":17,"character":10},"ch":">","options":{"tabSize":2,"insertSpaces":true,"trimTrailingWhitespace":true,"insertFinalNewline":true,"trimFinalNewlines":true}}}
Response:
{"jsonrpc":"2.0","id":46,"result":[{"range":{"start":{"line":17,"character":10},"end":{"line":17,"character":10}},"newText":"</ul>"}]}
The position (line 17, character 10) is immediately after the > of <li>, so the request is well-formed. I reproduced it on two separate captures with the same result.
My guess, which may be wrong: at the time of the request the document doesn't parse, because <li> is unclosed before </ul> (the server reports a parse error for this document). The element lookup in HtmlElementAutoclosingOnTypeFormattingProvider seems to land on the parent when the tree is in that error state.
This looks related to the earlier fix "Fix HTML element close tag auto-insertion inside Liquid branches (#516)", but my case has no Liquid branches, only plain HTML.
Workaround: in Zed, setting "use_on_type_format": false for the HTML language stops the behavior. That confirms the insertion comes from this request. Inside a Liquid file, Zed treats the language at the cursor as HTML, so that setting applies there. Other features (completions, diagnostics, hover) work normally.
- 主要言語
- TypeScript
- スター
- 239
- フォーク
- 104
- 平均マージ
- 1日 2時間
- マージ済み PR(30日)
- 23
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
Shopify/theme-tools のほかの issue
-
CdnPreconnect misses `href="https://cdn.shopify.com"` without a trailing path対応中かも @RaphaelFakhri が 5 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
Shopify/theme-tools#1365 ·
メンテナーはふだん 1 日以内に返信
-
theme-graph CLI never calls getWebComponentMap, so custom-element references are never resolved対応中かも @reginaldalfret が 23 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
Shopify/theme-tools#1291 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
JSONMissingBlock false positive for app block when section supports both @app and @theme対応中かも @chippleh1392 が 140 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
Shopify/theme-tools#1144 · コメント 2 件 · リアクション 8 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 5/5 1週間以上 初心者へのやさしさ 20/100
Shopify/theme-tools#1367 ·
メンテナーはふだん 1 日以内に返信
-
HardcodedRoutes flags paths that only share a prefix with a route対応中かも @RaphaelFakhri が 6 日前に担当しました。 オープン
難易度 3/5 1〜2日 初心者へのやさしさ 20/100
Shopify/theme-tools#1362 ·
メンテナーはふだん 1 日以内に返信
Shopify/theme-tools の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1〜3時間 初心者へのやさしさ 84/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 83/100
keptinventory/kept#336 ·
メンテナーはふだん 1 日以内に返信
-
good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
-
hemi-earn
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
vetro-protocol/vetro-monorepo#1013 ·
メンテナーはふだん 1 日以内に返信