https://github.com/jubilee-works/eslint-config-timetree

A sharable ESLint config for TimeTree
https://github.com/jubilee-works/eslint-config-timetree

Last synced: about 2 months ago
JSON representation

A sharable ESLint config for TimeTree

• Host: GitHub
• URL: https://github.com/jubilee-works/eslint-config-timetree
• Owner: jubilee-works
• License: mit
• Created: 2021-08-16T04:18:29.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-18T00:19:43.000Z (4 months ago)
• Last Synced: 2024-05-18T01:25:46.837Z (4 months ago)
• Language: TypeScript
• Size: 1.37 MB
• Stars: 4
• Watchers: 4
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# eslint-config-timetree

[![npm version](https://badge.fury.io/js/eslint-config-timetree.svg)](https://badge.fury.io/js/eslint-config-timetree)

A sharable ESLint config for TimeTree.

This is intended to use at a project for React + TypeScript + Prettier.

## Install

```sh

npm i --save-dev eslint prettier typescript react // install peerDependencies

npm i --save-dev eslint-config-timetree

yarn add --dev eslint prettier typescript react // install peerDependencies

yarn add --dev eslint-config-timetree

```

## How to use

Add a following `.eslintrc.js` in your project.

```js

module.exports = {

  extends: ["timetree"]

}

```

or

```js

module.exports = {

  extends: ["timetree/react"]

}

```

If your project is not React based, you can use base config.

```js

module.exports = {

  extends: ["timetree/base"]

}

```

Run `eslint`!

```sh

npx eslint src

```

If you want to lint TypeScript files including `.tsx`, you can use `--ext` option ESLint has.

```sh

npx eslint --ext .ts,.tsx src

```