JSPM

  • Created
  • Published
  • Downloads 6319
  • Score
    100M100P100Q131733F

Grunt plugin for TypeScript Linter

Package Exports

  • grunt-tslint

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (grunt-tslint) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

grunt-tslint NPM version

A grunt plugin for tslint.

Getting Started

This plugin requires Grunt ~0.4.1

npm install grunt-tslint --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks("grunt-tslint");

The "tslint" task

Overview

In your project's Gruntfile.js, add a section named tslint to the data object passed into grunt.initConfig():

grunt.initConfig({
    tslint: {
        options: {
            // Task-specific options go here.
        },
        your_target: {
            // Target-specific file lists and/or options go here.
        },
    },
})

Options

options.configuration

Type: Object

A JSON configuration object passed into tslint.

Usage Example

grunt.initConfig({
    tslint: {
        options: {
            // can be a configuration object or a filepath to tslint.json
            configuration: "tslint.json"
        },
        files: {
            src: [
                "src/file1.ts",
                "src/file2.ts"
            ]
        }
    }
})

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.