istanbuljs/nyc

document migrating from istanbul to nyc configuration

Open

#320 创建于 2016年7月17日

在 GitHub 查看
 (7 评论) (0 反应) (0 负责人)JavaScript (5,468 star) (392 fork)batch import
Istanbul 1.0dochelp wantedhigh-prioritypinned

描述

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.

贡献者指南

技术栈
javascriptnodejs
领域
documentationdeveloper experience
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
Basic knowledge of Istanbul/nycFamiliarity with package.json
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
65
研究方向
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.