tslint-config-smsenesac v1.0.0

Synopsis

My recommended standards for coding in the TypeScript programming language represented as a set of TSLint configurations.

Motivation

I believe that code quality is of paramount import. These configurations represent what I feel to be a set of standards that when followed increase the consistency, readability and correctness of software written in the TypeScript language.

Installation

npm install --save-dev tslint-config-smsenesac tslint@3.15.x tslint-eslint-rules@2.2.x tslint-react@1.1.x typescript@2.0.x @angular/compiler@2.2.x @angular/core@2.2.x codelyzer@1.0.0-beta.4 rxjs@5.0.0-beta.12 zone.js@0.6.x

Usage

This package exports the following TSLint configurations.

• smsenesac - default config, TypeScript
• smsenesac/node - Node.js
• smsenesac/angular - Angular
• smsenesac/react - React/JSX
• smsenesac/jsdoc - JSDoc

smsenesac

TSLint rules for TypeScript.

Requires:

• tslint
• tslint-eslint-rules

Installation:

1. npm install --save-dev tslint-config-smsenesac tslint@3.15.x tslint-eslint-rules@2.2.x
2. add "extends": ["smsenesac"] to your tslint.json config.

smsenesac/node

TSLint rules for Node.js.

Requires:

• tslint
• tslint-eslint-rules

Installation:

1. npm install --save-dev tslint-config-smsenesac tslint@3.15.x tslint-eslint-rules@2.2.x
2. add "extends": ["smsenesac/node"] to your tslint.json config.

smsenesac/angular

TSLint rules for Angular.

Requires:

• tslint
• codelyzer
• @angular/compiler
• @angular/core
• rxjs
• zone.js

Installation:

1. npm install --save-dev tslint-config-smsenesac tslint@3.15.x codelyzer@1.0.0-beta.4 @angular/compiler@2.2.x @angular/core@2.2.x rxjs@5.0.0-beta.12 zone.js@0.6.x
2. add "extends": ["smsenesac/angular"] to your tslint.json config.

smsenesac/react

TSLint rules for React.

Requires:

• tslint
• tslint-react

Installation:

1. npm install --save-dev tslint-config-smsenesac tslint@3.15.x tslint-react@1.1.x
2. add "extends": ["smsenesac/react"] to your tslint.json config.

smsenesac/jsdoc

TSLint rules for JSDoc comments.

Requires:

• tslint
• tslint-eslint-rules

Installation:

1. npm install --save-dev tslint@3.15.x tslint-eslint-rules@2.2.x
2. add "extends": ["smsenesac/jsdoc"] to your tslint.json config.

Contributors

As these configurations represent my personal opinions, I am not currently accepting external contributions. The open source community is extremely important to me, however, which is why I have chosen to make these opinions publicly available to anyone who may agree with them and find them of use.

License

MIT