Shopify / Shopify/theme-tools

Introduce support to `textEdit` completion items

Open
#28 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
234
Forks
92
Avg merge
1d 3h
Merged PRs (30d)
6

Description

Introduce support for textEdit Completion Items for Liquid tags.

A CompletionItem incorporates support for the textEdit field.

The objective of this task is to assess (and implement if feasible) the possibility of using textEdit to enhance code completion for Liquid tags. For instance, the language server could provide code completion for a for tag and automatically close it.


⚠️ Notice: An essential aspect of this task is to evaluate the impact on the Shopify/code-mirror-language-client, which might need to integrate support for textEdit as well.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how Liquid tag completion items are produced and where the LSP CompletionItem textEdit field could be added. Then assess the impact on Shopify/code-mirror-language-client, including whether it can consume textEdit. Done means documenting feasibility and implementing the completion behavior if the client supports it.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.