An open API service indexing awesome lists of open source software.

https://github.com/michareiser/eschecker

Type Checker for ECMAScript
https://github.com/michareiser/eschecker

Last synced: 10 months ago
JSON representation

Type Checker for ECMAScript

Awesome Lists containing this project

README

          

[![Coverage Status](https://coveralls.io/repos/github/DatenMetzgerX/MichaReiser/badge.svg?branch=master)](https://coveralls.io/github/MichaReiser/ESChecker?branch=master)
[![bitHound Overall Score](https://www.bithound.io/github/MichaReiser/ESChecker/badges/score.svg)](https://www.bithound.io/github/MichaReiser/ESChecker)
[![Build Status](https://travis-ci.org/MichaReiser/ESChecker.svg?branch=master)](https://travis-ci.org/MichaReiser/ESChecker)

# ESChecker

## Development
The eschecker uses ES6 and needs to be transpiled to ES5 to be runnable on node. The ES6 source code is located in lib folder and can be transpiled using the `npm run build` script or `npm start` to run a watch task that transpiles the files whenever something has changed. The tests use `babel/register` to transpile the code during the execution. The tests can be executed using`npm test`. The code coverage can be calculated using the `npm run coverage` script, which uses `babel-node` and `isparta` to create the coverage over the ES6 source code and not against the ES5-code.

## Usage

Install ESChecker globally using npm

```
npm install -g eschecker
```

To type check a file use the command line tool and pass the path to the file as argument

```
eschecker -f ./path/to/file.js
```