sinonjs/sinon

Create an article on how ES2015 classes relate to stubbing/spying

Open

#1121 opened on Aug 8, 2016

View on GitHub
 (6 comments) (13 reactions) (1 assignee)JavaScript (9,548 stars) (764 forks)batch import
DocumentationES2015+Help wantedhacktoberfestpinned

Description

A couple of issues with a huge pile of comments shows there is some confusion as to how (if at all possible) one can stub constructors in ES6/ES2015 classes. This has been answered in the comments, but it should be expanded to an article showing what can and cannot be done.

Compiled it down to this list of issues/links (from here), which can serve as the basis for one or more articles. Also, this search could prove useful.

Show how to stub ES6 constructor #1265

https://github.com/sinonjs/sinon/issues/1265 What: Feature request to automatically call stubbed/spied constructors with new. Why: Often asked for. People get confused about Function#constructor and the constructor keyword. Should either make a small tutorial to document how to "stub" (make a new) constructor and/or introduce a small Sinon NPM plugin to do so (in the article).

ES6 classes and stubbing out dependencies using proxyquire

https://github.com/sinonjs/sinon/issues/831#issuecomment-209648966 https://gist.github.com/fatso83/329da40002d45533b1e74db825f2bf54 What: how to use proxyquire to intercept dependencies Why: often asked for

Document how to configure Node to allow stubbing EcmaScript modules #1832

https://github.com/sinonjs/sinon/issues/1832 Why: Often asked for. Needs extra tools (esm).

Stubbing instance methods

https://github.com/sinonjs/sinon/issues/878#issuecomment-250198255

Cannot stub arrow function in a class #1136

https://github.com/sinonjs/sinon/issues/1136#issuecomment-244608044

Contributor guide

Tech stack
javascript
Domain
documentationtesting
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.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Sinon stubbing/spyingES6 classesJavaScript testing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Read the linked issues and comments (especially #1265, #831, #1832, #878, #1136) to understand common confusions. Review the Sinon documentation on stubbing and spying. Write an article that explains how to stub constructors, instance methods, and arrow functions in ES6 classes, and how to use proxyquire and esm for module stubbing. The article should be added to the Sinon documentation or as a guide.