microsoft/Terminal

Code Health: Update existing winrt properties to use `GETSET_PROPERTY` when possible

Open

#3,988 opened on Dec 17, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C++ (3,212 forks)batch import
Area-CodeHealthHelp WantedIssue-TaskProduct-Terminal

Repository metrics

Stars
 (35,764 stars)
PR merge metrics
 (Avg merge 27d 19h) (24 merged PRs in 30d)

Description

Pretty self explanatory. Classes with a bunch of


    uint32_t TerminalSettings::DefaultForeground()
    {
        return _defaultForeground;
    }

    void TerminalSettings::DefaultForeground(uint32_t value)
    {
        _defaultForeground = value;
    }

Is an enormous amount of boilerplate we don't need.

GETSET_PROPERTY(uint32_t, DefaultForeground, DEFAULT_FOREGROUND_WITH_ALPHA);

is better.

Contributor guide

Research direction
Find all classes with manual getter/setter pairs for properties that can be replaced with the GETSET PROPERTY macro and make the substitutions.
Tech stack
cpp
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80