• This repository has been archived on 05/Dec/2022
  • Stars
    star
    172
  • Rank 220,618 (Top 5 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created over 7 years ago
  • Updated almost 2 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

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

angular-tslint-rules npm version npm downloads

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

CircleCI semantic-release Conventional Commits Angular Style Guide

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, 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.

Contributing

If you want to file a bug, contribute some code, or improve documentation, please read up on the following contribution guidelines:

Thanks to

  • JetBrains, for their support to this open source project with free WebStorm licenses.

License

The MIT License (MIT)

Copyright (c) 2019 Burak Tasci

More Repositories

1

universal

Seed project for Angular Universal apps featuring Server-Side Rendering (SSR), Webpack, CLI scaffolding, dev/prod modes, AoT compilation, HMR, SCSS compilation, lazy loading, config, cache, i18n, SEO, and TSLint/codelyzer
TypeScript
703
star
2

ngx-meta

Dynamic page title & meta tags utility for Angular (w/server-side rendering)
TypeScript
334
star
3

ngx-cache

Cache utility for Angular
TypeScript
155
star
4

ngx-config

Configuration utility for Angular
TypeScript
144
star
5

ngx-auth

Auth0 platform implementation and JWT authentication utility for Angular & Angular Universal
TypeScript
57
star
6

fullstack-monorepo

Polyglot monorepo starter project
TypeScript
53
star
7

azure-functions-typescript

Seed project for backend development on Azure Functions with TypeScript
TypeScript
45
star
8

ngx-i18n-router

Route internationalization utility for Angular
TypeScript
35
star
9

example-app

Example app showcasing fulls1z3's Angular libraries
TypeScript
27
star
10

ngx-universal

Server platform libraries for Angular
25
star
11

azure-functions-ts-essentials

Essential interfaces and tools for backend development on Azure Functions with TypeScript
TypeScript
21
star
12

ngx-translate

Loader for @ngx-translate that provides translations to browser/server platforms
TypeScript
17
star
13

xunit-orderer

Implementation of ITestCaseOrderer enforcing xUnit to run the facts in strict order
C#
15
star
14

go-kit-example

Crash course on go-kit
Go
5
star
15

azure-functions-mongooser

Mongoose-based RESTful API implementation on Azure Functions with TypeScript
TypeScript
4
star
16

node-tslint-rules

Shared TSLint rules to enforce a consistent code style for Node.js development with TypeScript
JavaScript
3
star
17

html-elements-webpack-plugin

Webpack plugin to append head elements during the creation of index.html
JavaScript
3
star
18

elasticizer

Lightweight ElasticSearch repository implementation for .NET
C#
3
star
19

azure-functions-elasticizer

Elasticsearch-based RESTful API implementation on Azure Functions with TypeScript
TypeScript
2
star