Eliminating getters from yargs Options

Offen
  • Stimmt etwas nicht?
#272 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
35/100
Issue-Typ
Refactoring
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
typescript
Bereich
cli

Rechercherichtung

Start with the getters for openReport, dryRun, interactive, verbose, and rcPath, and review the earlier changes in pull request #270. Trace how each option is read and identify the code changes needed to preserve behavior when removing the getters. Done means all five getters are removed without behavior changes; the issue does not name specific tests to run.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

TL;DR

Some Parameter have a get function which will cause issues when migrating to ESM and require using incorrect typing.

These need to be removed.

Description

Using the getter for a parameter is requiring use to use Type Assertions.

This is an issue because it will not work property in some cases and typescript will ignore the error.

As an example we can look at the verbose param:

// packages/cli/src/lib/global/options/verbose.ts

import { argv } from 'yargs';
import { Param } from './verbose.model';
import { ArgvOption } from '../../core/yargs/types';
import { GlobalOptionsArgv } from './types';
import { getEnvPreset } from '../../pre-set';


export const param: Param = {
  verbose: {
    alias: 'v',
    type: 'boolean',
    description: 'Run with verbose logging',
    default: getEnvPreset().verbose
  }
};

// We don't rely on yargs option normalization features as this can happen before cli bootstrap
export function get(): boolean  {
  const {verbose} = argv as unknown as GlobalOptionsArgv;
  return verbose;
}

Going around the yargs parser is problematic as it means we cannot simply expect it to work in the same way it yargs is suppose to.

Many of the getters for the options are being removed in this MR: https://github.com/push-based/user-flow/pull/270

However some require making further modifications to the code base to not have any behaviour changes.

In particular I am referring to the the following yargs options:

  • openReport
  • dryRun
  • interactive
  • verbose
  • rcPath
Issue with getters in ESM

I believe the issue is related to live bindings. Or more broadly the way ES6 Modules export works.

More resources on the topic:

What do ES6 modules export? by Axel Rauschmayer
ES modules: A cartoon deep-dive by Lin Clark
Chapter on Modules in Exploring JS by Axel Rauschmayer

Vorherrschende Sprache
HTML
Sterne
131
Forks
7
Ø Merge
1 T. 1 Std.
Gemergte PRs (30 T.)
10

Entwicklungsumgebung

Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus push-based/user-flow

Alle Issues in push-based/user-flow

Ähnliche Issues

Weitere Issues zu CLI

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.