pnp/cli-microsoft365

Centralise default config values

Open

#6,186 opened on Jul 27, 2024

View on GitHub
 (5 comments) (0 reactions) (0 assignees)TypeScript (399 forks)auto 404
enhancementhelp wantedkeep-open

Repository metrics

Stars
 (1,390 stars)
PR merge metrics
 (PR metrics pending)

Description

In a lot of commands, we retrieve config values as follows:

cli.getSettingWithDefaultValue<boolean>(settingsNames.autoOpenLinksInBrowser, false)

I don't think it's a good approach to define the default value in the command itself. A better approach would be that we centralize all default values and provide a new function where the user should only specify the config variable. E.g.:

cli.getSetting<boolean>(settingsNames.autoOpenLinksInBrowser)

Contributor guide

Research direction
Search the codebase for all occurrences of 'getSettingWithDefaultValue' and list the settings names and their default values. Then propose a centralized mapping or a new function that retrieves the default value automatically.
Tech stack
typescript
Domain
clidevtools
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.
1-3 hours
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
TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80