sinonjs/sinon

Document how to do simple dependency injection

Open

#1458 opened on Jun 15, 2017

View on GitHub
 (5 comments) (2 reactions) (0 assignees)JavaScript (9,548 stars) (764 forks)batch import
DocumentationHelp wantedgood first issuehacktoberfestpinned

Description

There are usually three main categories of stubbing when dealing with network requests:

  1. stubbing out the api doing the actual network calls using a link seam
  2. stubbing out the api doing the actual network calls using dependency injection of some sort
  3. stubbing out the network layer in the underlying engine (browser or Node)

Presently we only have one article covering the first option, and very little on the two next approaches. We should create a small how-to for the article section that covers how to do basic (no framework) dependency injection.

I have already written a lot of text that could serve as the basis for such an article.

Contributor guide

Tech stack
javascript
Domain
testingdocumentation
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.
half day
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.
clear
Prerequisites
JavaScript basicssinon stubs and mocks
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the provided Stack Overflow answers and GitHub comments to extract patterns for dependency injection without a framework. Synthesize this into a concise how to article covering constructor injection, property injection, and method injection. Reference the existing article on link seams to provide context.