Socket
Book a DemoInstallSign in
Socket

@opencreek/eslint-plugin-storybook

Package Overview
Dependencies
Maintainers
3
Versions
51
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@opencreek/eslint-plugin-storybook

Liniting rules to prevent storybook pitfalls

0.4.4
latest
Source
npmnpm
Version published
Maintainers
3
Created
Source

@opencreek/eslint-plugin-storybook

Liniting storybook mistakes

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install @opencreek/eslint-plugin-storybook:

npm install @opencreek/eslint-plugin-storybook --save-dev
yarn  add --dev @opencreek/eslint-plugin-storybook

Usage

Add @opencreek/ts to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
    "plugins": ["@opencreek/ts"]
}

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

{
    "rules": {
        "@opencreek/storybook/nextjs-pages-no-default-export-function": "error"
    }
}

Supported Rules

@opencreek/storybook/no-default-export-with-modification Dissallows export default function with modiciation to the exporet value.

Because of how storybook uses acorn, and it interplays with react doc gen and default exports that have values attached, we need to always have them extra.

Fails:

export default function BlaPage() {
    //...
}

BlaPage.Layout = "layout"

Passes:

function BlaPage() {
    //...
}

BlaPage.Layout = "layout"

export default function BlaPage
export default function BlaPage() {
    //...
}

Keywords

eslint

FAQs

Package last updated on 28 Dec 2022

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

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.