VSCodeVim/Vim

Remove subclassing from actions.ts

Open

#519 opened on Jul 26, 2016

View on GitHub
 (0 comments) (1 reaction) (0 assignees)TypeScript (12,664 stars) (1,271 forks)batch import
help wantedkind/refactorsize/M

Description

We have this pattern going on in actions.ts where, if we want to implement an action that's similar to another action, we make a new class that just extends the old class and reimplements what changed.

I am not a big fan of this. The main problem is that if someone changes the base class, it's not obvious at all that the subclasses could have been depending on the behavior of the base class.

I would like to refactor actions.ts so that no concrete actions extend from other concrete actions. This can be done in two steps.

  • For all actions that are synonyms (ctrl-[ and esc, for example), we need to make the keys variable accept a list of key sequences rather than just one.
  • For all actions that are not synonyms but actually have differing implementations (not sure how many of these we even have), I am ok with extending from a shared "abstract" base class.

Contributor guide

Tech stack
typescript
Domain
developer experience
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
TypeScriptVSCode extension developmentclass inheritance concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue is about refactoring actions.ts to remove concrete subclassing. The first step (synonym actions) is already done. The remaining work involves identifying all concrete actions that extend other concrete actions and refactoring them to use a shared abstract base class. Examine the actions.ts file for current inheritance patterns and ensure that no concrete class extends another concrete class. Follow the pattern from step 1 and the maintainer's comments in the issue body.