jasmine-mock-factory - npm Package Compare versions

Comparing version 1.0.1 to 1.0.3

package.json

 {
   "name": "jasmine-mock-factory",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "A Jasmine helper for creating mocked classes",
@@ -34,2 +34,3 @@ "license": "MIT",
     "core-js": "^2.4.1",
+    "coveralls": "^2.13.1",
     "jasmine-core": "~2.6.2",
@@ -40,3 +41,4 @@ "jasmine-spec-reporter": "~4.1.0",
     "karma-cli": "~1.0.1",
-    "karma-coverage-istanbul-reporter": "^1.2.1",
+    "karma-coverage-istanbul-reporter": "^1.3.0",
+    "karma-firefox-launcher": "^1.0.1",
     "karma-jasmine": "~1.1.0",
@@ -43,0 +45,0 @@ "karma-jasmine-html-reporter": "^0.2.2",

README.md

 # Jasmine Mock Factory
 
+[![Build Status](https://api.travis-ci.org/henrysun918/jasmine-mock-factory.svg?branch=master)](https://travis-ci.org/henrysun918/jasmine-mock-factory) [![Coverage Status](https://coveralls.io/repos/github/henrysun918/jasmine-mock-factory/badge.svg?branch=master)](https://coveralls.io/github/henrysun918/jasmine-mock-factory?branch=master)
+
 A Jasmine test util that uses a TyoeScript class or an instance of a class to create a mock instance of that class.
 
+## Quick Start
+
+```TypeScript
+import { SomeClass } from 'some-library';
+import { MockFactory} from 'jasmine-mock-factory';
+
+it('should pass', () => {
+    const mockInstance = MockFactory.create(SomeClass);
+    mockInstance.doSomething.and.returnValue('awesome!');
+
+    mockInstance.doSomething();  // returns 'awesome!'
+
+    expect(mockInstance.doSomething).toHaveBeenCalled();
+}
+```
+
 ## Prerequisite
@@ -15,9 +33,11 @@
 ### Install
-`npm install mock-factory --save-dev`
+```Shell
+npm install jasmine-mock-factory --save-dev
+```
 
 ### Import
 Import the library with ES6 Module Syntax:
+```TypeScript
+import { MockFactory } from 'jasmine-mock-factory'
 ```
-import { MockFactory } from 'mock-factory'
-```
 
@@ -27,3 +47,3 @@ ### Creating a mock
 #### From a TypeScript class
-```
+```TypeScript
 class RealClass {
@@ -39,4 +59,4 @@ // This is a typescript class
 #### From an instance of a class
-```
-const realInstance: RealInterface;
+```TypeScript
+const realInstance: RealInterface = new RealClass();
 
@@ -55,3 +75,3 @@ ...
 ### Examples
-```
+```TypeScript
 class RealClass {
@@ -58,0 +78,0 @@ public doSomething(...arg: any[]) { ... }

No alert changes

Improved metrics

Total package byte prevSize

7721

increased by34.7%

Number of package files

5

increased by25%

Number of lines in readme file

99

increased by25.32%

Worsened metrics

Dev dependency count

26

increased by8.33%

No dependency changes