https://github.com/xojs/eslint-config-xo-typescript

ESLint shareable config for TypeScript to be used with eslint-config-xo
https://github.com/xojs/eslint-config-xo-typescript

eslint eslint-config eslint-rules nodejs npm-package typescript xo

Last synced: 23 days ago
JSON representation

ESLint shareable config for TypeScript to be used with eslint-config-xo

• Host: GitHub
• URL: https://github.com/xojs/eslint-config-xo-typescript
• Owner: xojs
• License: mit
• Created: 2018-05-30T08:56:16.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-03-08T15:50:54.000Z (8 months ago)
• Last Synced: 2024-05-16T02:12:30.756Z (6 months ago)
• Topics: eslint, eslint-config, eslint-rules, nodejs, npm-package, typescript, xo
• Language: JavaScript
• Size: 164 KB
• Stars: 164
• Watchers: 6
• Forks: 25
• Open Issues: 10
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# eslint-config-xo-typescript

> ESLint [shareable config](https://eslint.org/docs/developer-guide/shareable-configs.html) for TypeScript

This config also includes [eslint-config-xo](https://github.com/xojs/eslint-config-xo).

**This config assumes your project is [ESM](https://nodejs.org/api/esm.html) and that you use a [strict config](https://github.com/sindresorhus/tsconfig/blob/main/tsconfig.json).**

## Install

```sh

npm install --save-dev eslint-config-xo-typescript

```

## Use with XO

[XO has built-in support for TypeScript](https://github.com/xojs/xo#typescript), using this package under the hood, so you do not have to configure anything.

## Standalone Usage

Add some ESLint config to your package.json (or `.eslintrc`):

```js

// eslint.config.js

import xoTypeScript from 'eslint-config-xo-typescript';

export default [

	...xoTypeScript,

];

```

Use the `space` sub-config if you want 2 space indentation instead of tabs:

```js

import xoTypeScriptSpace from 'eslint-config-xo-typescript/space';

export default [

	...xoTypeScriptSpace,

];

```

## Related

- [XO](https://github.com/xojs/xo)