Microsoft/vscode

[html] provide rename for embedded JavaScript

Open

#31,141 opened on Jul 20, 2017

View on GitHub
 (6 comments) (14 reactions) (2 assignees)TypeScript (74,848 stars) (10,221 forks)batch import
feature-requesthelp wantedhtmljavascriptkeep

Description

  • VSCode Version: v1.14.1
  • OS Version: macOS Sierra v10.12.6
  • Reproduces without extensions: Yes

Steps to Reproduce:

  1. Create these two files:

my-custom-element.js

class MyCustomElement extends HTMLElement {
  static get is() {
    return 'my-custom-element';
  }
}

customElements.define(MyCustomElement.is, MyCustomElement);

my-custom-element.html

<script>
  class MyCustomElement extends HTMLElement {
    static get is() {
      return 'my-custom-element';
    }
  }

  customElements.define(MyCustomElement.is, MyCustomElement);
</script>
  1. Try the Rename Refactoring with F2 in both files:

With the same code, the "Rename Refactoring" doesn't work in HTML language.

Contributor guide

Tech stack
htmljavascripttypescript
Domain
developer experiencetooling
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic understanding of VSCode's language service APIFamiliarity with rename providers
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Examine the HTML rename provider in VSCode's source code (likely in extensions/html language features). Understand how it currently works for HTML elements and attributes. Identify why it does not handle embedded JavaScript inside <script> tags. Look at the JavaScript rename provider to see if it can be reused. Consider adding detection of script context within the HTML rename provider.