https://github.com/mcmath/tslint-config

TSLint config for TypeScript projects
https://github.com/mcmath/tslint-config

config tslint tslint-config typescript

Last synced: about 2 months ago
JSON representation

TSLint config for TypeScript projects

• Host: GitHub
• URL: https://github.com/mcmath/tslint-config
• Owner: mcmath
• License: mit
• Created: 2017-04-19T00:26:34.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-04-20T00:13:06.000Z (over 7 years ago)
• Last Synced: 2024-10-28T14:25:55.593Z (2 months ago)
• Topics: config, tslint, tslint-config, typescript
• Size: 7.81 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @mcmath/tslint-config

[![Version][version-badge]][npm]

[![Build][build-badge]][travis]

TSLint configuration for TypeScript projects

## Install

Install as an [npm][npm] development dependency. [TypeScript][typescript] and

[TSLint][tslint] should also be installed.

```sh

npm install --save-dev typescript tslint @mcmath/tslint-config

```

## Usage

Create a `tslint.json` file in the root of your project:

```json

{ "extends": "@mcmath/tslint-config" }

```

New rules may be added or existing ones modified like so:

```json

{

  "extends": "@mcmath/tslint-config",

  "rules": {

    "no-reference": false,

    "quotemark": [true, "single"]

  }

}

```

[version-badge]: https://img.shields.io/npm/v/@mcmath/tslint-config.svg?style=flat-square

[build-badge]: https://img.shields.io/travis/mcmath/tslint-config/master.svg?style=flat-square

[npm]: https://www.npmjs.com/package/@mcmath/tslint-config

[travis]: https://travis-ci.org/mcmath/tslint-config

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

[tslint]: https://palantir.github.io/tslint/