Skip to content

Latest commit

 

History

History
69 lines (55 loc) · 1.57 KB

README.md

File metadata and controls

69 lines (55 loc) · 1.57 KB
Raw

eslint-plugin-redundant-stack

Designed to work with projects using braid-design-system, this plugin detects when a Stack element is redundant.

Braid Stacks are used to manage the vertical spacing between elements. If you have only a single element inside a Stack (or none), there's nothing for it to be spaced from, and so you don't need to include a Stack.

Usually this comes about because you did need a Stack originally, but refactored away the other child elements, not realising there was only one left.

Examples

// ok
<Stack space="medium">
  <Text>First item</Text>
  <Text>Second item</Text>
</Stack>
// also ok, because it will generate several children
<Stack space="large">
  {jobs.map((job) => (
    <JobsCard job={job} />
  ))}
</Stack>
// error - single child
<Stack space="medium">
  <Text>Single item</Text>
</Stack>
// error - empty
<Stack space="medium"></Stack>

Usage

pnpm add -D @bjervis/eslint-plugin-redundant-stack

Then in your eslint config

plugins: ['@bjervis/redundant-stack'],
rules: {
  '@bjervis/redundant-stack/no-redundant-stack': 2,
},

If you're using Braid, you're probably also using sku, so:

// sku.config.js
module.exports = {
  ...,
  dangerouslySetESLintConfig: (skuConfig) => ({
    ...skuConfig,
    plugins: ['@bjervis/redundant-stack'],
    rules: {
      '@bjervis/redundant-stack/no-redundant-stack': 2,
    },
  }),
}