# angular-tslint-rules

> Shared TSLint & codelyzer rules to enforce a consistent code style for Angular development

Latest version **1.20.4** (published 2020-03-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install angular-tslint-rules
pnpm add angular-tslint-rules
yarn add angular-tslint-rules
bun add angular-tslint-rules
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.20.4 |
| Published | 2020-03-10 |
| First published | 2017-05-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 16.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 169 |
| Author | Burak Tasci |
| Maintainers | fulls1z3 |
| Keywords | linting-rules, tslint, frontend, angular |

## Links

- npm: https://www.npmjs.com/package/angular-tslint-rules
- Repository: https://github.com/fulls1z3/angular-tslint-rules
- Homepage: https://github.com/fulls1z3/angular-tslint-rules#readme
- Issues: https://github.com/fulls1z3/angular-tslint-rules/issues
- npm.io page: https://npm.io/package/angular-tslint-rules

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 1.20.4 (latest) — 2020-03-10
- 1.20.3 — 2019-12-02
- 1.20.2 — 2019-12-02
- 1.20.1 — 2019-09-19
- 1.20.0 — 2019-09-17
- 1.19.0 — 2019-09-17
- 1.18.3 — 2019-09-17
- 1.18.2 — 2019-09-17
- 1.18.1 — 2019-09-17
- 1.18.0 — 2019-07-04
- 1.17.0 — 2019-07-04
- 1.16.0 — 2019-07-04
- 1.15.0 — 2019-07-04
- 1.14.5 — 2019-07-04
- 1.14.4 — 2019-07-04
- … 18 more at https://npm.io/package/angular-tslint-rules/versions

## README

# angular-tslint-rules [![npm version](https://badge.fury.io/js/angular-tslint-rules.svg)](https://www.npmjs.com/package/angular-tslint-rules) [![npm downloads](https://img.shields.io/npm/dm/angular-tslint-rules.svg)](https://www.npmjs.com/package/angular-tslint-rules)

Shared [TSLint] & [codelyzer] rules to enforce a consistent code style for [Angular] development

[![CircleCI](https://circleci.com/gh/fulls1z3/angular-tslint-rules.svg?style=svg)](https://circleci.com/gh/fulls1z3/angular-tslint-rules)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
[![Angular Style Guide](https://mgechev.github.io/angular2-style-guide/images/badge.svg)](https://angular.io/styleguide)

> Please support this project by simply putting a Github star. Share this library with friends on Twitter and everywhere else you can.

The value of the software produced is directly affected by the **quality of the codebase**, and not every developer might
- be **aware of the potential pitfalls** of certain constructions in [TypeScript],
- be **introduced into certain conventions** when using the [Angular] framework,
- know that not every developer is as capable in **understanding an elegant** (*but abstract*) **solution** as the original
developer.

For that purpose, we need to use **static code analysis tools** such as [TSLint] and [codelyzer] to check readability, maintainability,
and functionality errors.

Although complying with these tools may seem to appear as **undesired overhead** or may **limit creativity**, it becomes
**easier** for any new developers to **read**, **preventing** a lot of **time/frustration spent** figuring out the structure
and characteristics of the code.

Containing a set of [TSLint] and [codelyzer] rules, **`angular-tslint-rules`** has been compiled using many contributions
from colleagues, commercial/open-source projects and some other sources from the Internet, as well as years of development
using the [Angular] framework.

#### NOTE
All [TSLint] rules covered by this project are explained on this article [https://medium.com/burak-tasci/angular-tslint-rules-a-configuration-preset-for-both-tslint-codelyzer-8b5fa1455908](https://medium.com/burak-tasci/angular-tslint-rules-a-configuration-preset-for-both-tslint-codelyzer-8b5fa1455908), in depth. 

If you have questions, comments or suggestions, just create an issue on this repository. I'll try to revise and republish
these rules with new insights, experiences and remarks in alignment with the updates on [TSLint] and [codelyzer].

## <a name="contributing"></a> Contributing
If you want to file a bug, contribute some code, or improve documentation, please read up on the following contribution guidelines:
- [Issue guidelines](CONTRIBUTING.md#submit)
- [Contributing guidelines](CONTRIBUTING.md)
- [Coding rules](CONTRIBUTING.md#rules)
- [ChangeLog](CHANGELOG.md)

#### Thanks to
- [JetBrains], for their support to this open source project with free [WebStorm] licenses.

## <a name="license"></a> License
The MIT License (MIT)

Copyright (c) 2019 [Burak Tasci]

[TSLint]: https://github.com/palantir/tslint
[codelyzer]: https://github.com/mgechev/codelyzer
[Angular]: https://angular.io
[TypeScript]: https://github.com/Microsoft/TypeScript
[JSDoc]: http://usejsdoc.org
[JetBrains]: https://www.jetbrains.com/community/opensource
[WebStorm]:   https://www.jetbrains.com/webstorm
[Burak Tasci]: https://github.com/fulls1z3

---
_Source: https://npm.io/package/angular-tslint-rules · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
