istanbuljs/nyc

document migrating from istanbul to nyc configuration

Open

#320 geöffnet am 17. Juli 2016

Auf GitHub ansehen
 (7 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (5.468 Stars) (392 Forks)batch import
Istanbul 1.0dochelp wantedhigh-prioritypinned

Beschreibung

see https://github.com/istanbuljs/nyc/issues/309

Open Questions

  • should we support both the nyc and the istanbul configuration key in package.json (it's a bit confusing for folks using libraries like babel-plugin-istanbul that they need to set an nyc stanza).
    • I could see the other argument, whatever, nyc is the name of the actual reporting tool get used to it.
  • do we need a tool for migration, or could we get away with documenting this on our website?

CC: @jamestalmage, @gotwarlost curious about your thoughts.

Contributor Guide

Tech Stack
javascriptnodejs
Domain
documentationdeveloper experience
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
Basic knowledge of Istanbul/nycFamiliarity with package.json
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65
Research-Richtung
Review the linked issue #309 and the open questions in this issue. The key decision is whether to support both 'nyc' and 'istanbul' config keys in package.json, or only 'nyc'. Also decide if a migration tool is needed or if documentation on the project website suffices. Engage with maintainers (e.g., @jamestalmage, @gotwarlost) to clarify the preferred approach before writing documentation. The deliverable is a documentation PR on the istanbuljs.github.io repo or a new guide in the nyc repo.