istanbuljs/nyc

document migrating from istanbul to nyc configuration

Open

#320 opened on Jul 17, 2016

View on GitHub
 (7 comments) (0 reactions) (0 assignees)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.

Contributor guide

Tech stack
javascriptnodejs
Domain
documentationdeveloper experience
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic knowledge of Istanbul/nycFamiliarity with package.json
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
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.