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.