Add test coverage badge to README

.gitignore

@@ -18,6 +18,7 @@ _doc
 lib
 lib-esm
 release
+coverage/
 
 # do not ignore github
 !.github

README.md

@@ -1,13 +1,14 @@
-# AngularUI Router  [![Build Status](https://github.com/angular-ui/ui-router/workflows/CI:%20UIRouter%20for%20AngularJS/badge.svg)](https://github.com/angular-ui/ui-router/actions?query=workflow%3A%22CI%3A+UIRouter+for+AngularJS%22)
+# AngularUI Router  [![Build Status](https://github.com/angular-ui/ui-router/workflows/CI:%20UIRouter%20for%20AngularJS/badge.svg)](https://github.com/angular-ui/ui-router/actions?query=workflow%3A%22CI%3A+UIRouter+for+AngularJS%22) ![](https://img.shields.io/badge/Coverage-44%25-F2C572.svg?prefix=$coverage$)
 
-**Note: this is the Angular 1.x source for UI-Router version 1.x.  If you are looking for the source for UI-Router 
+**Note: this is the Angular 1.x source for UI-Router version 1.x. If you are looking for the source for UI-Router
 version 0.x, it can be found [here](https://github.com/angular-ui/ui-router/tree/legacy)**
 
 ---
 
-
 #### The de-facto solution to flexible routing in angular
+
 ---
+
 **[Tutorials](https://ui-router.github.io/tutorials/)** |
 **[API Docs](https://ui-router.github.io/docs/latest/)** |
 **[Download stable](http://unpkg.com/@uirouter/angularjs@latest/release/angular-ui-router.js)** (or **[Minified](http://unpkg.com/@uirouter/angularjs@latest/release/angular-ui-router.min.js)**) **|**
@@ -20,36 +21,35 @@ version 0.x, it can be found [here](https://github.com/angular-ui/ui-router/tree
 
 ---
 
-Angular UI-Router is a client-side [Single Page Application](https://en.wikipedia.org/wiki/Single-page_application) 
-routing framework for [AngularJS](http://angularjs.org).  
-  
-Routing frameworks for SPAs update the browser's URL as the user navigates through the app.  Conversely, this allows 
-changes to the browser's URL to drive navigation through the app, thus allowing the user to create a bookmark to a 
+Angular UI-Router is a client-side [Single Page Application](https://en.wikipedia.org/wiki/Single-page_application)
+routing framework for [AngularJS](http://angularjs.org).
+
+Routing frameworks for SPAs update the browser's URL as the user navigates through the app. Conversely, this allows
+changes to the browser's URL to drive navigation through the app, thus allowing the user to create a bookmark to a
 location deep within the SPA.
 
-UI-Router applications are modeled as a hierarchical tree of states. UI-Router provides a 
-[*state machine*](https://en.wikipedia.org/wiki/Finite-state_machine) to manage the transitions between those 
-application states in a transaction-like manner. 
+UI-Router applications are modeled as a hierarchical tree of states. UI-Router provides a
+[_state machine_](https://en.wikipedia.org/wiki/Finite-state_machine) to manage the transitions between those
+application states in a transaction-like manner.
 
 ## Get Started
 
-
 - [UI-Router for Angular 1](https://ui-router.github.io/ng1)
 - [UI-Router for Angular 2](https://ui-router.github.io/ng2)
 - [UI-Router for React](https://ui-router.github.io/react)
 
 ## Resources
 
-* [In-Depth Guide](https://github.com/angular-ui/ui-router/wiki)
-* [Slides comparing ngRoute to ui-router](http://slid.es/timkindberg/ui-router#/)
-* [UI-Router Extras / Addons for legacy (0.x)](http://christopherthielen.github.io/ui-router-extras/#/home) (@christopherthielen)
- 
+- [In-Depth Guide](https://github.com/angular-ui/ui-router/wiki)
+- [Slides comparing ngRoute to ui-router](http://slid.es/timkindberg/ui-router#/)
+- [UI-Router Extras / Addons for legacy (0.x)](http://christopherthielen.github.io/ui-router-extras/#/home) (@christopherthielen)
+
 ### Videos
 
-* [Introduction Video](https://egghead.io/lessons/angularjs-introduction-ui-router) (egghead.io)
-* [Tim Kindberg on Angular UI-Router](https://www.youtube.com/watch?v=lBqiZSemrqg)
-* [Activating States](https://egghead.io/lessons/angularjs-ui-router-activating-states) (egghead.io)
-* [Learn Angular.js using UI-Router](http://youtu.be/QETUuZ27N0w) (LearnCode.academy)
+- [Introduction Video](https://egghead.io/lessons/angularjs-introduction-ui-router) (egghead.io)
+- [Tim Kindberg on Angular UI-Router](https://www.youtube.com/watch?v=lBqiZSemrqg)
+- [Activating States](https://egghead.io/lessons/angularjs-ui-router-activating-states) (egghead.io)
+- [Learn Angular.js using UI-Router](http://youtu.be/QETUuZ27N0w) (LearnCode.academy)
 
 ## Reporting issues and Contributing
 

jest.config.js

@@ -8,6 +8,7 @@ module.exports = {
   roots: ['src', 'test'],
   testMatch: ['**/__tests__/**/*.[jt]s?(x)', '**/?(*.)+(spec|test).[jt]s?(x)', '**/?*Spec.[jt]s'],
   setupFilesAfterEnv: ['./test/jest.init.ts'],
+  coverageReporters: ['json-summary', 'lcov', 'text', 'clover'],
   moduleNameMapper: {
     '^angular$': '<rootDir>/test/angular/jest-angular.js',
     '^jest-angular-import$': `<rootDir>/test/angular/${NG}/angular.js`,

package.json

@@ -25,13 +25,15 @@
     "test:ng16": "NG=1.6 jest",
     "test:ng17": "NG=1.7 jest",
     "test:downstream": "test_downstream_projects",
+    "test:coverage": "jest --coverage",
     "watch": "jest --watch",
     "debug": "npm run test:debug",
     "docs": "generate_docs",
     "docs:publish": "generate_docs && publish_docs",
     "release": "release --deps @uirouter/core && node ./scripts/npm_angular_ui_router_release.js && node ./scripts/bower_release.js",
     "prepublishOnly": "npm run build",
-    "artifacts": "artifact_tagging"
+    "artifacts": "artifact_tagging",
+    "coverage:badge": "coverage-badge-creator"
   },
   "homepage": "https://ui-router.github.io",
   "contributors": [
@@ -91,6 +93,7 @@
     "angular": "1.8.0",
     "bufferutil": "4.0.1",
     "canvas": "2.6.1",
+    "coverage-badge-creator": "^1.0.4",
     "dts-downlevel": "^0.4.0",
     "eslint": "^7.5.0",
     "eslint-config-prettier": "^6.11.0",