istanbuljs/nyc

document migrating from istanbul to nyc configuration

Open

#320 ouverte le 17 juil. 2016

Voir sur GitHub
 (7 commentaires) (0 réactions) (0 assignés)JavaScript (5 468 stars) (392 forks)batch import
Istanbul 1.0dochelp wantedhigh-prioritypinned

Description

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.

Guide contributeur

Stack technique
javascriptnodejs
Domaine
documentationdeveloper experience
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
mostly clear
Prérequis
Basic knowledge of Istanbul/nycFamiliarity with package.json
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65
Direction de recherche
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.