eslint-plugin-react-web-api

v2.13.0
  • Types
  • ESM

ESLint React's ESLint plugin for interacting with Web APIs

License
MIT
Install Size
27.2 kB/-
Vulns
0
Published

Get started

$npm install eslint-plugin-react-web-api
$pnpm add eslint-plugin-react-web-api
$yarn add eslint-plugin-react-web-api
$bun add eslint-plugin-react-web-api
$deno add npm:eslint-plugin-react-web-api
$vlt install eslint-plugin-react-web-api
# Usually installed as a dev dependency
$npm install -D eslint-plugin-react-web-api
$pnpm add -D eslint-plugin-react-web-api
$yarn add -D eslint-plugin-react-web-api
$bun add -d eslint-plugin-react-web-api
$deno add -D npm:eslint-plugin-react-web-api
$vlt install -D eslint-plugin-react-web-api

Readme

eslint-plugin-react-web-api

ESLint React's ESLint plugin for React to interact with Web APIs.

Install

# npm
npm install --save-dev eslint-plugin-react-web-api

Setup

import js from "@eslint/js";
import webApi from "eslint-plugin-react-web-api";
import { defineConfig } from "eslint/config";
import tseslint from "typescript-eslint";

export default defineConfig(
  {
    files: ["**/*.{ts,tsx}"],
    extends: [
      js.configs.recommended,
      tseslint.configs.recommended,
      // Add configs from eslint-plugin-react-web-api
      webApi.configs.recommended,
    ],
    rules: {
      // Put rules you want to override here
      "react-web-api/no-leaked-event-listener": "warn",
    },
  },
);

Rules

https://eslint-react.xyz/docs/rules/overview#web-api-rules

Rules to be implemented

Rule Description
no-leaked-idle-callback Prevents leaked requestIdleCallback
no-leaked-animation-frame Prevents leaked requestAnimationFrame
no-leaked-event-source Prevents leaked EventSource
no-leaked-intersection-observer Prevents leaked IntersectionObserver
no-leaked-mutation-observer Prevents leaked MutationObserver
no-leaked-performance-observer Prevents leaked PerformanceObserver
no-leaked-websocket Prevents leaked WebSocket
no-leaked-broadcast-channel Prevents leaked BroadcastChannel
no-leaked-geolocation Prevents leaked Geolocation.watchPosition()
no-leaked-absolute-orientation-sensor Prevents leaked AbsoluteOrientationSensor
no-leaked-relative-accelerometer Prevents leaked Accelerometer
no-leaked-ambient-light-sensor Prevents leaked AmbientLightSensor
no-leaked-gravity-sensor Prevents leaked GravitySensor
no-leaked-gyroscope Prevents leaked Gyroscope
no-leaked-linear-acceleration-sensor Prevents leaked LinearAccelerationSensor
no-leaked-magnetometer Prevents leaked Magnetometer
no-leaked-orientation-sensor Prevents leaked OrientationSensor