# @taikonauten/linters-typescript

> This package provides the Typescript linter used at Taikonauten

Latest version **1.2.0** (published 2022-02-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install @taikonauten/linters-typescript
pnpm add @taikonauten/linters-typescript
yarn add @taikonauten/linters-typescript
bun add @taikonauten/linters-typescript
```

## 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.2.0 |
| Published | 2022-02-09 |
| First published | 2020-10-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | engineering@taikonauten.com |
| Maintainers | sf-taiko, taiko-org, nicolaisteinel, schllng, lempa, tststststststs |
| Keywords | lint, linting, JavaScript, TypeScript, ESLint |

## Links

- npm: https://www.npmjs.com/package/@taikonauten/linters-typescript
- Repository: https://github.com/taikonauten/linters-typescript
- Homepage: https://github.com/taikonauten/linters-typescript#readme
- Issues: https://github.com/taikonauten/linters-typescript/issues
- npm.io page: https://npm.io/package/@taikonauten/linters-typescript

## 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.2.0 (latest) — 2022-02-09
- 1.1.0 — 2020-11-07
- 1.0.2 — 2020-10-20
- 1.0.1 — 2020-10-16
- 1.0.0 — 2020-10-16

## README

<p align="center">
  <img src="https://i.imgur.com/dV1aZjJ.png" title="Taikonauten">
</p>

<h1 align="center">Taikonauten TypeScript Linter</h1>

<p>&nbsp;</p>

This package provides the TypeScript linter used at [Taikonauten](https://taikonauten.com).

## Description

[ESLint](https://eslint.org/) is a modern tool to lint JavaScript files. The `.eslintrc` file shipped with this repository contains the configuration to properly setup ESLint, while the `eslint/index.js` file contains the current ruleset used at Taikonauten. Most of the rules are default settings for ESLint and more or less a standard for writing JavaScript.

## Installation

Run the following two commands in your terminal to install the package:

```bash
npm install --save-dev @taikonauten/linters-typescript @taikonauten/linters-js eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin babel-eslint
```

Create a `.eslintrc.js` file in your project root and use the following content for it:

```javascript
module.exports = {
  env: {
    es2021: true
  },
  extends: [
    'eslint:recommended',
    './node_modules/@taikonauten/linters-js/eslint/index.js',
    'plugin:react/recommended',
  ],
  parser: 'babel-eslint',
  parserOptions: {
    ecmaFeatures: {},
    ecmaVersion: 12,
    sourceType: 'module',
  },
  plugins: [],
  overrides: [
    {
      files: ['*.ts', '*.tsx'],
      parser: '@typescript-eslint/parser',
      parserOptions: {
        project: ['./tsconfig.json'],
      },
      extends: [
        'plugin:@typescript-eslint/recommended',
        'plugin:@typescript-eslint/recommended-requiring-type-checking',
        './node_modules/@taikonauten/linters-typescript/eslint/index.js',
      ],
      plugins: [
        '@typescript-eslint',
      ],
    }
  ],
};
```

This is an example config and in most cases you will need to fine tune it depending on the project.
More information on how to configure: [Configuring ESLint](https://eslint.org/docs/user-guide/configuring)

## Using with your IDE or Editor

After that, make sure your editor or IDE supports the `.eslintrc` file. PhpStorm works with it right out of the box.
For Sublime Text, install the [SublimeLinter-eslint](https://github.com/SublimeLinter/SublimeLinter-eslint) plugin.
For Atom, install the [linter-eslint](https://atom.io/packages/linter-eslint) plugin.
For VS Code, install the [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) plugin.

---

Made with ♡ at Taikonauten

---
_Source: https://npm.io/package/@taikonauten/linters-typescript · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._