istanbuljs/nyc

Provide --complete-copy Option for Instrumentation as in Istanbul

Open

#678 opened on Sep 20, 2017

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (5,468 stars) (392 forks)batch import
Great First Contributionenhancementhelp wantedtriaged

Description

I used to run my instrumentation step with istanbul using something like this:

cross-env NODE_ENV=test istanbul instrument -i ./src/main/webapp/src -o ./src/main/webapp/instrumented --complete-copy

It basically instrumented all of the .js files, but also copied everything else, so that I could then build that folder and package it with my backend code (in this case a Java backend).

I'm trying to find a way to do it with nyc. When I run:

cross-env NODE_ENV=test nyc instrument ./src/main/webapp/src ./src/main/webapp/instrumented

That takes care of the files needing instrumentation, but I cannot get the --complete-copy behaviour present in istanbul.

I am currently doing the build with Webpack and babel-plugin-istanbul, which takes care of the problem for now, but it would be great if there was an equivalent using nyc instrument.

Contributor guide

Tech stack
javascriptnodejs
Domain
testingtooling
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-2 days
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
Node.jsnyc CLI usagebasic understanding of code instrumentation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Review the nyc instrument command implementation in the CLI code, particularly how files are handled. Look at the underlying Istanbul library for the complete copy feature. The issue describes desired behavior: instrument JS files and copy non JS files to the output directory. Newcomer should examine the bin/nyc.js and related modules to understand current instrument logic, then design a complete copy flag.