Skip to content
This repository was archived by the owner on Dec 3, 2023. It is now read-only.

Commit 28f050f

Browse files
committed
Updated README.md. Updated Coveralls reporting script.
1 parent fa78ff2 commit 28f050f

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![Build Status](https://travis-ci.org/sumtype/common-algorithms-js.svg?branch=master)](https://travis-ci.org/sumtype/common-algorithms-js) [![Coverage Status](https://coveralls.io/repos/github/sumtype/common-algorithms-js/badge.svg?branch=master)](https://coveralls.io/github/sumtype/common-algorithms-js?branch=master) [![Known Vulnerabilities](https://snyk.io/test/github/sumtype/common-algorithms-js/badge.svg)](https://snyk.io/test/github/sumtype/common-algorithms-js) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) [![npm](https://img.shields.io/npm/dt/common-algorithms-js.svg)](https://www.npmjs.com/package/common-algorithms-js)
44

5-
Common algorithms implemented in JavaScript with [Mocha](https://mochajs.org/)/[Chai](http://chaijs.com/) testing. Uses [Babel](https://babeljs.io/) and [UMD](https://github.com/umdjs/umd) to transpile algorithm modules from ES6+ to ES5. Test coverage reports are provided by [nyc](https://github.com/istanbuljs/nyc) and piped to Coveralls. Coveralls reports coverage for the ES6+ algorithms (ES6+ and transpiled ES5 algorithms are tested). All JavaScript code follows [JavaScript Standard Style](https://standardjs.com/) guidelines. README translations are provided in the [locales](https://github.com/sumtype/common-algorithms-js/tree/master/locales) directory and translated with Google Translate. Currently [Spanish](https://github.com/sumtype/common-algorithms-js/tree/master/locales/es) is available. [Contributions](https://github.com/sumtype/common-algorithms-js/blob/master/CONTRIBUTING.md) are welcome! Follow the guidelines.
5+
Common algorithms implemented in JavaScript with [Mocha](https://mochajs.org/)/[Chai](http://chaijs.com/) testing. Uses [Babel](https://babeljs.io/) and [UMD](https://github.com/umdjs/umd) to transpile algorithm modules from ES6+ to ES5. Test coverage reports are provided by [nyc](https://github.com/istanbuljs/nyc) and piped to [Coveralls](https://coveralls.io/github/sumtype/common-algorithms-js?branch=master). Coveralls reports coverage for ES6+ algorithms (although both ES6+ and transpiled ES5 algorithms are tested). All JavaScript code follows [JavaScript Standard Style](https://standardjs.com/) guidelines. README translations are provided in the [locales](https://github.com/sumtype/common-algorithms-js/tree/master/locales) directory and translated with Google Translate. Currently [Spanish](https://github.com/sumtype/common-algorithms-js/tree/master/locales/es) is available. [Contributions](https://github.com/sumtype/common-algorithms-js/blob/master/CONTRIBUTING.md) are welcome! Follow the guidelines.
66

77
### Array
88

@@ -154,7 +154,7 @@ or
154154

155155
When running `npm test` or `yarn test` all the algorithms, tests, and "./es5.js" file are transpiled based on their corresponding ES6+ files. This way when running your tests not only are your ES6+ algorithms tested in an ES6+ context, but your transpiled ES5 algorithms are tested in transpiled ES5 test contexts. Since modules in tests are loaded via "./es.js" or the transpiled "./es5.js" file the export files themselves are tested too. In addition, [standard](https://www.npmjs.com/package/standard) is run to ensure all ES6+/ES5 code is style compliant and the test breaks if there are issues.
156156

157-
This repository uses [Travis-CI](https://travis-ci.org/sumtype/common-algorithms-js) for deployment testing on Node.js versions 8.9.x and 9.4.x. Test coverage is reported by [Coveralls](https://coveralls.io/github/sumtype/common-algorithms-js?branch=master).
157+
This repository uses [Travis-CI](https://travis-ci.org/sumtype/common-algorithms-js) for deployment testing on Node.js versions 8.9.x and 9.4.x. Test coverage is reported by Coveralls. Test reports are generated by nyc.
158158

159159
## Transpiling ES5 Algorithms
160160

0 commit comments

Comments
 (0)