# tslint-config-oberon

> Oberon's default tslint config

Latest version **1.3.0** (published 2019-11-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install tslint-config-oberon
pnpm add tslint-config-oberon
yarn add tslint-config-oberon
bun add tslint-config-oberon
```

## 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.3.0 |
| Published | 2019-11-12 |
| First published | 2018-04-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 8.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Oberon |
| Maintainers | jariz, richardvw, rikschefferoberon |

## Links

- npm: https://www.npmjs.com/package/tslint-config-oberon
- Repository: https://github.com/oberonamsterdam/tslint-config-oberon
- Homepage: https://github.com/oberonamsterdam/tslint-config-oberon#readme
- Issues: https://github.com/oberonamsterdam/tslint-config-oberon/issues
- npm.io page: https://npm.io/package/tslint-config-oberon

## Dependencies (5)

- [tslint-react](https://npm.io/package/tslint-react.md) ^4.0.0
- [tslint-react-hooks](https://npm.io/package/tslint-react-hooks.md) ^2.2.1
- [tslint-eslint-rules](https://npm.io/package/tslint-eslint-rules.md) ^5.4.0
- [tslint-config-prettier](https://npm.io/package/tslint-config-prettier.md) ^1.18.0
- [tslint-whitespace-before-colon](https://npm.io/package/tslint-whitespace-before-colon.md) ^0.2.0

## Recent versions

- 1.3.0 (latest) — 2019-11-12
- 1.2.2 — 2019-11-12
- 1.2.1 — 2019-11-12
- 1.2.0 — 2019-09-02
- 1.1.1 — 2019-05-31
- 1.1.0 — 2019-05-31
- 1.0.4 — 2018-05-14
- 1.0.3 — 2018-05-14
- 1.0.2 — 2018-05-13
- 1.0.1 — 2018-05-07
- 1.0.0 — 2018-04-30

## README

# Oberon TSlint config & standard

The Oberon typescript code standard & config.

## Codestyle

### The gist  

- **Semicolons at the end of each statement.**
- **camelCasing should be used on all object properties.**
- **Always use [curly brace conventions](https://eslint.org/docs/rules/curly).** Even if your block only consists of a single statement. 
- **Single quotes are the default.** But use double quotes within JSX. 
- **Indents with 4 spaces**, no tabs allowed.
- **Always use === for comparing equality**
- **Don't use var**, use const/let instead.
- **Don't declare multiple variables on a single line.** Except for uninitialized variables.
This is **allowed**:
```js
const a, b, c;
```  
This **isn't:**
```js
const a = false, b = true, c = false;
```

### Full set

Read the set of rules here [here](https://github.com/oberonamsterdam/tslint-config-oberon/blob/master/tslint-config-oberon.json)
Additionally, be aware of the [tslint recommended rules](https://github.com/palantir/tslint/blob/master/src/configs/recommended.ts), they also apply.

## Usage
Add a `tslint.json` file to your project:  


```json
{
    "extends": ["tslint-config-oberon"]
}
```

Install tslint & tslint-config-oberon locally (`npm i -D tslint tslint-config-oberon`)
Optionally, add tslint as a precommit hook by installing [husky](https://github.com/typicode/husky) (`npm i -D husky`) and adding a `precommit` script to your package.json `scripts`:
```json
{
      "scripts": {
           ...
          "precommit": "tslint --project ."  
      }
}

```
### Optional prettier setup:

In order to enforce good practices concerning code quality, it is advised to let prettier handle the code formatting and tslint the semantics and syntax. To install prettier please follow the readme of the [oberon-config-prettier](https://github.com/oberonamsterdam/prettier-config-oberon). To resolve conflicts between tslint and prettier you also need to install tslint-config-prettier (`npm i -D tslint-config-prettier`) and add it to the `tslint.json` file:

```json
{
    "extends": ["tslint-config-oberon", "tslint-config-prettier"]
}
```

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