istanbuljs/nyc

Feature: rename/suppress path root

Open

#370 opened on Aug 27, 2016

View on GitHub
 (0 comments) (1 reaction) (0 assignees)JavaScript (5,468 stars) (392 forks)batch import
Great First Contributionenhancementhelp wanted

Description

I love the text summary output, but it doesn't work so well with 2 cases I run into frequently.

super long package names

------------------------------------------|----------|----------|----------|----------|----------------|
File                                      |  % Stmts | % Branch |  % Funcs |  % Lines |Uncovered Lines |
------------------------------------------|----------|----------|----------|----------|----------------|
All files                                 |    94.23 |    77.42 |    88.89 |    94.23 |                |
 framework-prefixed-long-package-name     |       95 |       75 |      100 |       95 |                |
  index.js                                |       95 |       75 |      100 |       95 |             25 |
 framework-prefixed-long-package-name/lib |    93.75 |    78.95 |    85.71 |    93.75 |                |
  tunnel.js                               |    93.75 |    78.95 |    85.71 |    93.75 |          37,53 |
------------------------------------------|----------|----------|----------|----------|----------------|

paths that are hash package name and environment (CI)

----------------|----------|----------|----------|----------|----------------|
File            |  % Stmts | % Branch |  % Funcs |  % Lines |Uncovered Lines |
----------------|----------|----------|----------|----------|----------------|
All files       |    94.23 |    77.42 |    88.89 |    94.23 |                |
 abcdef0123     |       95 |       75 |      100 |       95 |                |
  index.js      |       95 |       75 |      100 |       95 |             25 |
 abcdef0123/lib |    93.75 |    78.95 |    85.71 |    93.75 |                |
  tunnel.js     |    93.75 |    78.95 |    85.71 |    93.75 |          37,53 |
----------------|----------|----------|----------|----------|----------------|

I'm not sure why the paths are reported relative to .. instead of ., but it would be nice if that could be overridden.

Contributor guide

Tech stack
javascriptnodejs
Domain
clideveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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
JavaScript knowledgenyc CLI basicspath manipulation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate the nyc source code to locate the text summary output formatter, likely in the `lib` directory of the `istanbul reports` package. Understand how paths are currently displayed and where they are constructed. Then design a CLI option (e.g., path root or rename path) that allows users to rename or suppress the path root prefix. Ensure backward compatibility and update documentation.