@nationalbankbelgium/code-style/README.md

Front-End code style

<h1 align="center">
   NBB Code style
</h1>

> A library containing code style configuration used in applications at the National Bank of Belgium

[![NPM version](https://img.shields.io/npm/v/@nationalbankbelgium/code-style.svg)](https://www.npmjs.com/package/@nationalbankbelgium/code-style)
[![npm](https://img.shields.io/npm/dm/@nationalbankbelgium/code-style.svg)](https://www.npmjs.com/package/@nationalbankbelgium/code-style)
[![Build Status](https://github.com/NationalBankBelgium/code-style/workflows/build/badge.svg)](https://github.com/NationalBankBelgium/code-style/actions?query=workflow%3Abuild)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
[![License](https://img.shields.io/cocoapods/l/AFNetworking.svg)](LICENSE)

## About

This package hosts style configuration useful in Front-End development at the [National Bank of Belgium](https://www.nbb.be).

It currently provides the following configurations:

| Library                                               | Path                                      | Latest supported version                                                                                            |
| ----------------------------------------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| [codelyzer](https://github.com/mgechev/codelyzer)     | [lib/codelyzer](/lib/codelyzer/README.md) | ![codelyzer version](https://img.shields.io/npm/dependency-version/@nationalbankbelgium/code-style/dev/codelyzer)   |
| [Prettier](https://github.com/prettier/prettier)      | [lib/prettier](/lib/prettier/README.md)   | ![Prettier version](https://img.shields.io/npm/dependency-version/@nationalbankbelgium/code-style/dev/prettier)     |
| [stylelint](https://github.com/stylelint/stylelint)   | [lib/stylelint](/lib/stylelint/README.md) | ![stylelint version](https://img.shields.io/npm/dependency-version/@nationalbankbelgium/code-style/dev/stylelint)   |
| [TSLint](https://github.com/palantir/tslint)          | [lib/tslint](/lib/tslint/README.md)       | ![TSLint version](https://img.shields.io/npm/dependency-version/@nationalbankbelgium/code-style/dev/tslint)         |
| [Typescript](https://github.com/microsoft/typescript) | [lib/tsconfig](/lib/tsconfig/README.md)   | ![Typescript version](https://img.shields.io/npm/dependency-version/@nationalbankbelgium/code-style/dev/typescript) |

## Installation

With npm:

> npm install @nationalbankbelgium/code-style

With yarn:

> yarn add @nationalbankbelgium/code-style

## Contributing

Please follow our [contribution guidelines](/CONTRIBUTING.md).

To know how to release code-style, refer to [this page](/RELEASE.md).

## Authors

### Alexis Georges

- [@GitHub](https://github.com/SuperITMan)

### Christopher Cortes

- [@GitHub](https://github.com/christophercr)

### Michaël Henkens

- [@GitHub](https://github.com/mhenkens)

## License

This project and all associated source code is licensed under the terms of the [MIT License](/LICENSE).

## Thank you notes :)

We'd like to thank the following companies who support the open source community with great tools and platforms.

### Jetbrains

We're supported by [Jetbrains](https://www.jetbrains.com) and their awesome [support for open source](https://www.jetbrains.com/buy/opensource/), thanks to which we are able to use the best products on the market to work on this open source project!

<a href="https://www.jetbrains.com"><img src="http://www.underconsideration.com/brandnew/archives/jetbrains_logo_detail.jpg" width="144px"></a>

### GitHub Actions

We're supported by [GitHub Actions](https://github.com/features/actions)

<a href="https://github.com/features/actions"><img src="https://github.githubassets.com/images/modules/site/features/actions-icon-actions.svg" width="144px"></a>