jsx-eslint/eslint-plugin-react

Rule proposal: disallow string interpolation for className

Open

#460 创建于 2016年2月22日

在 GitHub 查看
 (1 评论) (4 反应) (0 负责人)JavaScript (8,630 star) (2,797 fork)batch import
help wantednew rule

描述

Using string interpolation in classNames can make it difficult to determine whether some CSS is actually used in your project. To make this easier, some folks might want to enforce preventing string interpolation in classNames.

Bad:

function MyComponent({ someProp }) {
  const classNames = `my-component my-component-${someProp}`;

  return (
    <div className={classNames}>
      Hi mom
    </div>
  )
}

Bad:

function MyComponent({ someProp }) {
  const classNames = 'my-component my-component-' + someProp;

  return (
    <div className={classNames}>
      Hi mom
    </div>
  )
}

Bad:

function MyComponent({ someProp }) {
  const classNames = ['my-component'];
  classNames.push('my-component-' + someProp);

  return (
    <div className={classNames.join(' ')}>
      Hi mom
    </div>
  )
}

Good:

function MyComponent({ someProp }) {
  const classNames = ['my-component'];
  if (someProp === 'some-value') {
    classNames.push('my-component-some-value');
  } else if (someProp === 'another-value') {
    classNames.push('my-component-another-value');
  }

  return (
    <div className={classNames.join(' ')}>
      Hi mom
    </div>
  )
}

Of course, the classnames package can be useful here.

I don't know yet, but this may be useful for other props, so perhaps it could be configured for a list of props.

贡献者指南

Rule proposal: disallow string interpolation for className · jsx-eslint/eslint-plugin-react#460 | Good First Issue