Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wcandillon/eslint-plugin-reanimated
https://github.com/wcandillon/eslint-plugin-reanimated
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/wcandillon/eslint-plugin-reanimated
- Owner: wcandillon
- Created: 2021-01-09T12:29:33.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-08-21T07:27:46.000Z (over 1 year ago)
- Last Synced: 2024-11-09T19:46:47.215Z (about 2 months ago)
- Language: TypeScript
- Size: 552 KB
- Stars: 76
- Watchers: 4
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: Readme.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
[![NPM](https://img.shields.io/npm/v/eslint-plugin-reanimated)](https://www.npmjs.com/package/eslint-plugin-reanimated) [![CI & CD](https://github.com/wcandillon/eslint-plugin-reanimated/workflows/CI%20&%20CD/badge.svg)](https://github.com/wcandillon/eslint-plugin-reanimated/actions?query=branch%3Amaster)
The goal of this plugin is to help you when writing animation worklets with Reanimated.
## Installation
This plugin requires your project to use TypeScript (>=4.1.3).
```sh
yarn add eslint-plugin-reanimated --dev
```External type declaration need to expose the `@worklet` JSDoc.
In the case of `react-native-redash`, this is done starting version `16.0.6` ([see js-function-in-worklet](https://github.com/wcandillon/eslint-plugin-reanimated/blob/master/docs/js-function-in-worklet.md)).## Example Configuration
The plugin relies on TypeScript compiler services to resolve types.
You need to set your `tsconfig.json` file in your eslint configuration via `parserOptions`.```json
{
"extends": "react-native-wcandillon",
"plugins": ["reanimated"],
"parserOptions": {
"project": "./tsconfig.json"
},
"rules": {
"reanimated/js-function-in-worklet": 2,
}
}
```## Rules
* [js-function-in-worklet](./docs/js-function-in-worklet.md)
* [unsupported-syntax](./docs/unsupported-syntax.md)
* [no-multiple-animated-style-usages](./docs/no-multiple-animated-style-usages.md)