resin-io/node-resin-lint

Name: node-resin-lint

Owner: Resin.io

Description: null

Created: 2017-06-07 07:32:55.0

Updated: 2018-01-05 11:33:51.0

Pushed: 2018-01-05 11:33:51.0

Homepage: null

Size: 44

Language: TypeScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

resin-lint

resin-lint is a linter based on coffeelint, coffeescope2 and tslint that detects style errors based on Resin.io coding guidelines.

Overview

resin-lint uses Resin's coffeelint.json and tslint.json. If a coffeelint.json or tslint.json is found in the to-be-linted project directory or its parents then the rules found in it will override the default resin-lint ones. Another way to to override the default resin-lint rules is by specifying a configuration file with the -f parameter. By default, only .coffee files will be linted. .ts and .tsx files can be linted by using the --typescript parameter.

Usage

You can use this module as:

  1. A standalone project by installing it with npm install -g resin-lint:

    as@macbook:~/resin/test$ resin-lint src/
    c/test.coffee
    
    ! » 0 errors and 0 warnings in 1 file
    
  2. A development dependency in package.json with `npm install --save-dev resin-lint`. Then you can use the module in your build/testing process:

    age.json
    --------
    
    ipts": {
    t": "resin-lint src/ && echo \"Done!\""
    
    
    
    as@macbook:~/resin/test$ npm run lint
    
    st@1.0.0 lint /Users/kostas/resin/test
    sin-lint src/ && echo "Done!"
    
    c/test.coffee
    
    ! » 0 errors and 0 warnings in 1 file
    
    !
    
Support

If you're having any problem, please raise an issue on GitHub and the Resin.io team will be happy to help.

Tests

Run the test suite by doing:

m install && npm test
Contribute

Before submitting a PR, please make sure that you include tests, and that npm run lint runs without a warning.

License

The project is licensed under the Apache 2.0 license.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.