GithubHelp home page GithubHelp logo

julienben / eslint-plugin-no-this-in-jsx-component-name Goto Github PK

View Code? Open in Web Editor NEW
2.0 0.0 0.0 6 KB

Checks JSX tags for <this.ComponentName /> since user-defined components must be capitalized

JavaScript 100.00%

eslint-plugin-no-this-in-jsx-component-name's Introduction

eslint-plugin-no-this-in-jsx-component-name

This ESLint rule checks JSX tags for <this.ComponentName /> since user-defined components must be capitalized.

More here: https://facebook.github.io/react/docs/jsx-in-depth.html#user-defined-components-must-be-capitalized

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-no-this-in-jsx-component-name:

$ npm install eslint-plugin-no-this-in-jsx-component-name --save-dev

Note: If you installed ESLint globally, you must also install eslint-plugin-no-this-in-jsx-component-name globally.

Usage

Add no-this-in-jsx-component-name to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
    "plugins": [
        "no-this-in-jsx-component-name"
    ]
}

Then add no-this-in-jsx-component-name's only rule under the rules section.

{
    "rules": {
        "no-this-in-jsx-component-name/no-this-in-jsx-component-name": "error"
    }
}

Rule Details

This rule aims to avoid compilation errors in React when a component's name starts with "this".

The following patterns are considered warnings:

<this.ComponentName />
<this.ComponentName>Content</this.ComponentName>

The following patterns are not warnings:

<div />
<MyComponent />

As alternatives, use either of these options in your render method:

const Component = this.Component;
<Component />

const { ComponentA, ComponentB } = this;
<ComponentA />
<ComponentB />

eslint-plugin-no-this-in-jsx-component-name's People

Contributors

julienben avatar

Stargazers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.