Introduce the `ObjectAttributeCompletionProvider` module #654

karreiro · 2022-11-07T14:14:26Z

Overview

The goal of this PR is fixing #642* and introducing new intelligent code completion capabilities on Theme Check.

I recommend reviewing this PR by following the sections below. I've split it into meaningful commits to approach each module individually and clarify its purpose.

Steps to review

1. Minor adjustments

c8c7f3c - First of all, we slightly adjust a detail in the Markdown documentation
911c53a - Then, we introduce the prototype implementation to support built-in types
- This module still have some TODO elements: [Intelligent code completion] Introduce basic support to Liquid built-in types #657

2. Setup our new code completion tools

52029b5 - Now, we create the variable_lookup_finder/constants module to hold some regexes (they will be used in the future commits)
753ce9a - Then, we introduce the main module of the type inference, the LiquidFixer
- It receives a Liquid string and tries to turn it in a valid/parsable Liquid string
- This module is designed to receive unfinished snippets, as while developers are typing, templates will be probably broken
6b45882 - After that, we introduce the AssignmentsFinder module
- This module relies on a Liquid visitor to get all assign occurrences
- We still have one missing detail to finish in this module here: [Intelligent code completion] AssignmentsFinder shouldn't index variables when it can't infer the proper type #655
e27f9df - With those elements in place, we can now change the VariableLookupFinder to use the AssignmentsFinder and the LiquidFixer modules
- With them, the VariableLookupFinder can follow variables and get their types based on assignments

3. Improve our code completion suggestions

13b3751 - Cool! We have our new mechanism in place; it's time to use it to provide valuable suggestions
- But, before that, we need to apply some minor changes
- The CompletionEngine works as an aggregator of all completion providers (each completion provider extends CompletionProvider)
- With that in mind, we're changing the CompletionProvider main method from completions(content, cursor) to completions(relative_path, line, col)
  - The goal of this change is empowering each provider to suggest completion items based on the file, the line, and the column (instead of content, which was ~~the current token~~ a subset of the file)
- Good! We're done with that
  - Now, let's update the existing completion providers and introduce documentation on them as well (as we have it for free now) :)

4. The new `ObjectAttributeCompletionProvider` provider

da2c38f - Ok, in the latest commits, we updated the existing completion providers, it's time to introduce the new 'ObjectAttributeCompletionProvider' provider
- Our new provider relies in the new VariableLookupFinder implementation to provide intelligent code completion for attributes
- Now, we're pretty much done

5. TODO

fc749d3 & a324fb3 - These commits just introduce some references about the pending work we have

Steps to 🎩

Setup your editor (VS Code, vim, or nvim) with your local Theme Check by following this guide
Create a new theme with shopify theme init
Open your new theme to try code completion
Notice that filters/tags/objects code completion items have documentation now
Notice that objects support multi-level attribute code completion now:

* I've been calling the features introduced by this PR as "type inference" in #642 issue. But, I've decided to break that concept into sub-components into this PR to clarify what each phase means.

…the 'LiquidFixer' modules

…e the providers API from 'completions(content, cursor)' to 'completions(relative_path, line, col)'

lib/theme_check/language_server/completion_engine.rb

lib/theme_check/language_server/variable_lookup_finder/liquid_fixer.rb

lib/theme_check/language_server/variable_lookup_finder.rb

lib/theme_check/language_server/completion_providers/object_attribute_completion_provider.rb

mgmanzella

absolute 🔥!! only question i have is the same one CP raised here

Poitrin

Code LGTM, I just found some stuff during tophatting :)

lib/theme_check/shopify_liquid/source_index/base_entry.rb

lib/theme_check/language_server/completion_providers/object_completion_provider.rb

implement `completions(context)` instead of `completions(relative_path, line, col)` to DRY IO calls

mgmanzella

🚀 🚀 🚀

lib/theme_check/language_server/completion_engine.rb

- Introduce scope support the in the `AssignmentsFinder` with the `TolerantParser` - Introduce support to variables defined in iteration statements - Fix documentation format

* Add file at desired location * Read data from JSON file * Update built_in_liquid_objects.json

lib/theme_check/language_server/completion_engine.rb

lib/theme_check/language_server/variable_lookup_finder/assignments_finder.rb

lib/theme_check/language_server/variable_lookup_finder/tolerant_parser.rb

lib/theme_check/language_server/completion_providers/object_attribute_completion_provider.rb

charlespwd

LGTM :) 🔥 🔥 🔥

- Use a single instance of `CompletionContext` on all providers - Remove variable from all parent scopes when it is defined in a block - Extra visitor and node handler from `AssignmentsFinder` - Remove `index!` in favor of an alternative - Introduce documentation for `TolerantBlockBody` - Rename `ObjectAttributeCompletionProvider#property_doc` to `[...]#property_to_completion`

* Define the domain for the `theme-liquid-docs` files (#643) * Introduce the `ObjectAttributeCompletionProvider` module (#654) * Download theme-liquid-docs on package deploy or while running theme-check (#661) * Download theme-liquid-docs on package deploy * Add data fixtures to test downloading theme-liquid-docs * Introduce the `AssignmentsCompletionProvider` to suggest variables (#667) * Refresh theme-liquid-docs on theme-check startup (#671) * Add async download in SourceManager#refresh and mechanism to notify SourceIndex liquid schema is out of date * Tests for SourceIndex state classes and SourceManager#refresh, create helper for shared stubs * Cleanup -- fix test dir name to source_index, aggr requires * Remove class method mock (Net::HTTP.any_instance), affects other tests * Change SourceIndex#local_path to #local_path! to indicate danger, fix syntax of filename const * Suggest filters compatible with the object type (#669) ### WHY are these changes introduced? Fixes #658 ### WHAT is this pull request doing? 1. Adds logic to `FilterCompletionProvider` to… - determine the type of the variable/literal (string, number, array, …) sitting before the filter separator ("input type") - suggest filters that match the specific input type, and filters whose input type is _variable_ (i.e. for more than 1 specific type, e.g. ` | default`) 2. Displays deprecated filters too, so that users can still see the filter they wanted to use. Co-authored-by: Morisa Manzella <[email protected]> Co-authored-by: Julien Poitrin <[email protected]> Co-authored-by: Julien Poitrin <[email protected]>

karreiro added 9 commits November 7, 2022 19:18

Markdown adjusts in the documentation

c8c7f3c

Add built-in types in the 'SourceIndex'

911c53a

Introduce the 'variable_lookup_finder/constants' module to hold regexes

52029b5

Introduce the 'LiquidFixer' module

753ce9a

Introduce the 'AssignmentsFinder' module

6b45882

Change the 'VariableLookupFinder' to use the 'AssignmentsFinder' and …

e27f9df

…the 'LiquidFixer' modules

Update existing completion providers to provide documentation + chang…

13b3751

…e the providers API from 'completions(content, cursor)' to 'completions(relative_path, line, col)'

Introduce the new 'ObjectAttributeCompletionProvider' provider

da2c38f

Require new modules and add some TODOs

fc749d3

karreiro force-pushed the fix-642 branch from 4e79a68 to fc749d3 Compare November 7, 2022 18:19

Add URLs for TODOs

a324fb3

karreiro force-pushed the fix-642 branch from 353584e to a324fb3 Compare November 8, 2022 10:31

karreiro marked this pull request as ready for review November 8, 2022 10:34

karreiro requested review from mgmanzella, Poitrin and charlespwd November 8, 2022 10:34

charlespwd reviewed Nov 9, 2022

View reviewed changes

mgmanzella reviewed Nov 10, 2022

View reviewed changes

Poitrin approved these changes Nov 14, 2022

View reviewed changes

lib/theme_check/shopify_liquid/source_index/base_entry.rb Show resolved Hide resolved

Poitrin reviewed Nov 14, 2022

View reviewed changes

lib/theme_check/language_server/completion_providers/object_completion_provider.rb Outdated Show resolved Hide resolved

lib/theme_check/language_server/completion_providers/object_completion_provider.rb Outdated Show resolved Hide resolved

Introduce \CompletionContext\, so now CompletionProvider classes

00b0fa4

implement `completions(context)` instead of `completions(relative_path, line, col)` to DRY IO calls

karreiro mentioned this pull request Nov 14, 2022

[Intelligent code completion] Introduce support to iterator assignments in the AssignmentsFinder #663

Closed

mgmanzella mentioned this pull request Nov 16, 2022

Download theme-liquid-docs on package deploy or while running theme-check #661

Merged

mgmanzella approved these changes Nov 16, 2022

View reviewed changes

lib/theme_check/language_server/completion_engine.rb Show resolved Hide resolved

karreiro and others added 2 commits November 22, 2022 17:08

Apply PR comments:

08bf7fd

- Introduce scope support the in the `AssignmentsFinder` with the `TolerantParser` - Introduce support to variables defined in iteration statements - Fix documentation format

Introduce basic support to Liquid built-in types (#666)

527b6e2

* Add file at desired location * Read data from JSON file * Update built_in_liquid_objects.json