Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

eslint-plugin-react-hooks-docs

Package Overview
Dependencies
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

eslint-plugin-react-hooks-docs

Eslint plugin to enforce react hooks documentation

  • 0.0.3
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
142
increased by73.17%
Maintainers
1
Weekly downloads
 
Created
Source

eslint-plugin-react-hooks-docs

GitHub stars GitHub forks GitHub issues GitHub license NPM

🚨 Eslint plugin to enforce react hooks documentation.

Built with ❤︎ by Ahmed Tokyo


Installation

npm i eslint eslint-plugin-react-hooks-docs --save-dev

OR

yarn add -D eslint eslint-plugin-react-hooks-docs --save-dev

Usage

Add react-hooks-docs to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
  "plugins": ["react-hooks-docs"]
}

Then configure the rules you want to use under the rules section.

{
  "rules": {
    "react-hooks-docs/docs": [
      2,
      {
        "skipDeclarations": true,
        "skipHooks": [
          "useCustomEffect"
        ]
      }
    ]
  }
}

Keywords

FAQs

Package last updated on 17 Jan 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc