VSCodeVim/Vim

Use objects as poor man's keyword arguments for some functions

Open

#522 opened on Jul 26, 2016

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (12,664 stars) (1,271 forks)batch import
help wantedkind/refactorsize/S

Description

A couple of our functions have a few trailing boolean arguments, which makes invocations impossible to read.

Make these arguments into objects and use destructuring to improve readability.

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.
2
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
TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Identify functions in the codebase that have multiple trailing boolean arguments. Change these to accept an options object and use destructuring to improve readability. Focus on files in the src/ directory. Ensure no breaking changes by providing default values if necessary.