https://github.com/commenthol/blanc-typescript

boilerplate for mocha nyc using typescript
https://github.com/commenthol/blanc-typescript

Last synced: 12 days ago
JSON representation

boilerplate for mocha nyc using typescript

• Host: GitHub
• URL: https://github.com/commenthol/blanc-typescript
• Owner: commenthol
• License: mit
• Created: 2020-03-11T06:33:49.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-03-22T08:39:59.000Z (over 6 years ago)
• Last Synced: 2025-02-26T18:53:40.113Z (over 1 year ago)
• Language: TypeScript
• Size: 8.79 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# blanc-typescript

> A node module boilerplate for typescript using mocha and nyc

[![NPM version](https://badge.fury.io/js/blanc-typescript.svg)](https://www.npmjs.com/package/blanc-typescript/)

[![Build Status](https://secure.travis-ci.org/commenthol/blanc-typescript.svg?branch=master)](https://travis-ci.org/commenthol/blanc-typescript)

This is a boilerplate for a node module using:

* [typescript][],

* [eslint][] using [standard][] syntax for code linting,

* [mocha][] tests,

* [nyc][] for code coverage,

* [rollup][] for bundling (Not yet working)

The files contain examples to show the usage of the different tools in your code.

## Table of Contents

* [Description](#description)

  * [Example ...](#example-)

* [Contribution and License Agreement](#contribution-and-license-agreement)

* [License](#license)

* [References](#references)

## Description

Run the different tools from `npm`

* `npm run all`      - Run all stuff

* `npm test`         - Run tests

* `npm run coverage` - Run nyc code coverage

* `npm run lint`     - Linting the source

* `npm run doc`      - Generate documentation from source (open `doc/index.html` after run)

### Example ...

## Contribution and License Agreement

If you contribute code to this project, you are implicitly allowing your

code to be distributed under the MIT license. You are also implicitly

verifying that all code is your original work or correctly attributed

with the source of its origin and licence.

## License

Copyright (c) commenthol (MIT License)

See [LICENSE][] for more info.

## References

* [eslint][eslint]

* [eslint-config-standard][eslint-config-standard]

* [jsdox][jsdox]

* [LICENSE][LICENSE]

* [mocha][mocha]

* [nyc][nyc]

* [rollup][rollup]

* [standard][standard]

* [tsconfig][tsconfig]

* [typescript][typescript]

[LICENSE]: ./LICENSE

[mocha]: http://mochajs.org/

[eslint]: http://eslint.org

[eslint-config-standard]: https://github.com/feross/eslint-config-standard

[standard]: http://standardjs.com

[jsdox]: http://jsdox.org/

[nyc]: https://istanbul.js.org/

[typescript]: https://www.typescriptlang.org/

[tsconfig]: https://www.typescriptlang.org/v2/en/tsconfig

[rollup]: https://rollupjs.org