Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(prefer-es6-class): add missing prefix #1071

Merged
merged 2 commits into from May 16, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/rules/display-name.md
@@ -1,4 +1,4 @@
# Prevent missing displayName in a React component definition (display-name)
# Prevent missing displayName in a React component definition (react/display-name)

DisplayName allows you to name your component. This name is used by React in debugging messages.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/forbid-component-props.md
@@ -1,4 +1,4 @@
# Forbid certain props on Components (forbid-component-props)
# Forbid certain props on Components (react/forbid-component-props)

By default this rule prevents passing of [props that add lots of complexity](https://medium.com/brigade-engineering/don-t-pass-css-classes-between-components-e9f7ab192785) (`className`, `style`) to Components. This rule only applies to Components (e.g. `<Foo />`) and not DOM nodes (e.g. `<div />`). The list of forbidden props can be customized with the `forbid` option.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/forbid-elements.md
@@ -1,4 +1,4 @@
# Forbid certain elements (forbid-elements)
# Forbid certain elements (react/forbid-elements)

You may want to forbid usage of certain elements in favor of others, (e.g. forbid all `<div />` and use `<Box />` instead). This rule allows you to configure a list of forbidden elements and to specify their desired replacements.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/forbid-foreign-prop-types.md
@@ -1,4 +1,4 @@
# Forbid foreign propTypes (forbid-foreign-prop-types)
# Forbid foreign propTypes (react/forbid-foreign-prop-types)

This rule forbids using another component's prop types unless they are explicitly imported/exported. This allows people who want to use [babel-plugin-transform-react-remove-prop-types](https://github.com/oliviertassinari/babel-plugin-transform-react-remove-prop-types) to remove propTypes from their components in production builds, to do so safely.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/forbid-prop-types.md
@@ -1,4 +1,4 @@
# Forbid certain propTypes (forbid-prop-types)
# Forbid certain propTypes (react/forbid-prop-types)

By default this rule prevents vague prop types with more specific alternatives available (`any`, `array`, `object`), but any prop type can be disabled if desired. The defaults are chosen because they have obvious replacements. `any` should be replaced with, well, anything. `array` and `object` can be replaced with `arrayOf` and `shape`, respectively.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-boolean-value.md
@@ -1,4 +1,4 @@
# Enforce boolean attributes notation in JSX (jsx-boolean-value)
# Enforce boolean attributes notation in JSX (react/jsx-boolean-value)

[When using a boolean attribute in JSX](https://facebook.github.io/react/docs/jsx-in-depth.html#boolean-attributes), you can set the attribute value to `true` or omit the value. This rule will enforce one or the other to keep consistency in your code.

Expand Down
12 changes: 6 additions & 6 deletions docs/rules/jsx-closing-bracket-location.md
@@ -1,4 +1,4 @@
# Validate closing bracket location in JSX (jsx-closing-bracket-location)
# Validate closing bracket location in JSX (react/jsx-closing-bracket-location)

Enforce the closing bracket location for JSX multiline elements.

Expand Down Expand Up @@ -71,7 +71,7 @@ The following patterns are considered warnings:
// 'jsx-closing-bracket-location': 1
// 'jsx-closing-bracket-location': [1, 'tag-aligned']
// 'jsx-closing-bracket-location': [1, 'line-aligned']
<Hello
<Hello
firstName="John"
lastName="Smith"
/>;
Expand Down Expand Up @@ -114,7 +114,7 @@ var x = function() {
};

// 'jsx-closing-bracket-location': [1, 'after-props']
<Hello
<Hello
firstName="John"
lastName="Smith"
/>;
Expand All @@ -127,7 +127,7 @@ var x = function() {
</Say>;

// 'jsx-closing-bracket-location': [1, 'props-aligned']
<Hello
<Hello
firstName="John"
lastName="Smith" />;

Expand Down Expand Up @@ -188,7 +188,7 @@ var x = function() {
};

// 'jsx-closing-bracket-location': [1, {selfClosing: 'after-props'}]
<Hello
<Hello
firstName="John"
lastName="Smith" />;

Expand All @@ -200,7 +200,7 @@ var x = function() {
</Say>;

// 'jsx-closing-bracket-location': [1, {selfClosing: 'props-aligned', nonEmpty: 'after-props'}]
<Hello
<Hello
firstName="John"
lastName="Smith"
/>;
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-curly-spacing.md
@@ -1,4 +1,4 @@
# Enforce or disallow spaces inside of curly braces in JSX attributes. (jsx-curly-spacing)
# Enforce or disallow spaces inside of curly braces in JSX attributes. (react/jsx-curly-spacing)

While formatting preferences are very personal, a number of style guides require or disallow spaces between curly braces.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-equals-spacing.md
@@ -1,4 +1,4 @@
# Enforce or disallow spaces around equal signs in JSX attributes. (jsx-equals-spacing)
# Enforce or disallow spaces around equal signs in JSX attributes. (react/jsx-equals-spacing)

Some style guides require or disallow spaces around equal signs.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-filename-extension.md
@@ -1,4 +1,4 @@
# Restrict file extensions that may contain JSX (jsx-filename-extension)
# Restrict file extensions that may contain JSX (react/jsx-filename-extension)

## Rule Details

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-first-prop-new-line.md
@@ -1,4 +1,4 @@
# Configure the position of the first property (jsx-first-prop-new-line)
# Configure the position of the first property (react/jsx-first-prop-new-line)

Ensure correct position of the first property.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-handler-names.md
@@ -1,4 +1,4 @@
# Enforce event handler naming conventions in JSX (jsx-handler-names)
# Enforce event handler naming conventions in JSX (react/jsx-handler-names)

Ensures that any component or prop methods used to handle events are correctly prefixed.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-indent-props.md
@@ -1,4 +1,4 @@
# Validate props indentation in JSX (jsx-indent-props)
# Validate props indentation in JSX (react/jsx-indent-props)

This option validates a specific indentation style for props.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-indent.md
@@ -1,4 +1,4 @@
# Validate JSX indentation (jsx-indent)
# Validate JSX indentation (react/jsx-indent)

This option validates a specific indentation style for JSX.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-key.md
@@ -1,4 +1,4 @@
# Detect missing `key` prop (jsx-key)
# Detect missing `key` prop (react/jsx-key)

Warn if an element that likely requires a `key` prop--namely, one present in an
array literal or an arrow function expression.
Expand Down
8 changes: 4 additions & 4 deletions docs/rules/jsx-max-props-per-line.md
@@ -1,4 +1,4 @@
# Limit maximum of props on a single line in JSX (jsx-max-props-per-line)
# Limit maximum of props on a single line in JSX (react/jsx-max-props-per-line)

Limiting the maximum of props on a single line can improve readability.

Expand Down Expand Up @@ -76,9 +76,9 @@ The following patterns are not considered warnings:
```jsx
// [1, { "when": "multiline" }]
<Hello firstName="John" lastName="Smith" />
<Hello
firstName="John"
lastName="Smith"
<Hello
firstName="John"
lastName="Smith"
/>
```

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-no-bind.md
@@ -1,4 +1,4 @@
# No `.bind()` or Arrow Functions in JSX Props (jsx-no-bind)
# No `.bind()` or Arrow Functions in JSX Props (react/jsx-no-bind)

A `bind` call or [arrow function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/Arrow_functions) in a JSX prop will create a brand new function on every single render. This is bad for performance, as it will result in the garbage collector being invoked way more than is necessary.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-no-comment-textnodes.md
@@ -1,4 +1,4 @@
# Prevent comments from being inserted as text nodes (jsx-no-comment-textnodes)
# Prevent comments from being inserted as text nodes (react/jsx-no-comment-textnodes)

This rule prevents comment strings (e.g. beginning with `//` or `/*`) from being accidentally
injected as a text node in JSX statements.
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-no-duplicate-props.md
@@ -1,4 +1,4 @@
# Prevent duplicate properties in JSX (jsx-no-duplicate-props)
# Prevent duplicate properties in JSX (react/jsx-no-duplicate-props)

Creating JSX elements with duplicate props can cause unexpected behavior in your application.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-no-literals.md
@@ -1,4 +1,4 @@
# Prevent usage of unwrapped JSX strings (jsx-no-literals)
# Prevent usage of unwrapped JSX strings (react/jsx-no-literals)

In JSX when using a literal string you can wrap it in a JSX container `{'TEXT'}`.
This rules requires that you wrap all literal strings.
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-no-target-blank.md
@@ -1,4 +1,4 @@
# Prevent usage of unsafe `target='_blank'` (jsx-no-target-blank)
# Prevent usage of unsafe `target='_blank'` (react/jsx-no-target-blank)

When creating a JSX element that has an a tag, it is often desired to have
the link open in a new tab using the `target='_blank'` attribute. Using this
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-no-undef.md
@@ -1,4 +1,4 @@
# Disallow undeclared variables in JSX (jsx-no-undef)
# Disallow undeclared variables in JSX (react/jsx-no-undef)

This rule helps locate potential ReferenceErrors resulting from misspellings or missing components.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-pascal-case.md
@@ -1,4 +1,4 @@
# Enforce PascalCase for user-defined JSX components (jsx-pascal-case)
# Enforce PascalCase for user-defined JSX components (react/jsx-pascal-case)

Enforces coding style that user-defined JSX components are defined and referenced in PascalCase.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-sort-props.md
@@ -1,4 +1,4 @@
# Enforce props alphabetical sorting (jsx-sort-props)
# Enforce props alphabetical sorting (react/jsx-sort-props)

Some developers prefer to sort props names alphabetically to be able to find necessary props easier at the later time. Others feel that it adds complexity and becomes burden to maintain.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-space-before-closing.md
@@ -1,4 +1,4 @@
# Validate spacing before closing bracket in JSX (jsx-space-before-closing)
# Validate spacing before closing bracket in JSX (react/jsx-space-before-closing)

**Deprecation notice**: This rule is deprecated. Please use the `"beforeSelfClosing"` option of the [jsx-tag-spacing](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-tag-spacing.md) rule instead.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-tag-spacing.md
@@ -1,4 +1,4 @@
# Validate whitespace in and around the JSX opening and closing brackets (jsx-tag-spacing)
# Validate whitespace in and around the JSX opening and closing brackets (react/jsx-tag-spacing)

Enforce or forbid spaces after the opening bracket, before the closing bracket of self-closing elements, and between the angle bracket and slash of JSX closing or self-closing elements.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-uses-react.md
@@ -1,4 +1,4 @@
# Prevent React to be incorrectly marked as unused (jsx-uses-react)
# Prevent React to be incorrectly marked as unused (react/jsx-uses-react)

JSX expands to a call to `React.createElement`, a file which includes `React`
but only uses JSX should consider the `React` variable as used.
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-uses-vars.md
@@ -1,4 +1,4 @@
# Prevent variables used in JSX to be incorrectly marked as unused (jsx-uses-vars)
# Prevent variables used in JSX to be incorrectly marked as unused (react/jsx-uses-vars)

Since 0.17.0 the ESLint `no-unused-vars` rule does not detect variables used in JSX ([see details](http://eslint.org/blog/2015/03/eslint-0.17.0-released#changes-to-jsxreact-handling)). This rule will find variables used in JSX and mark them as used.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-wrap-multilines.md
@@ -1,4 +1,4 @@
# Prevent missing parentheses around multiline JSX (jsx-wrap-multilines)
# Prevent missing parentheses around multiline JSX (react/jsx-wrap-multilines)

Wrapping multiline JSX in parentheses can improve readability and/or convenience. It optionally takes a second parameter in the form of an object, containing places to apply the rule. By default, `"declaration"`, `"assignment"`, `"return"`, and `"arrow"` syntax is checked, but these can be explicitly disabled. Any syntax type missing in the object will follow the default behavior (become enabled).

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-array-index-key.md
@@ -1,4 +1,4 @@
# Prevent usage of Array index in keys
# Prevent usage of Array index in keys (react/no-array-index-key)

Warn if an element uses an Array index in its `key`.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-children-prop.md
@@ -1,4 +1,4 @@
# Prevent passing of children as props (no-children-prop)
# Prevent passing of children as props (react/no-children-prop)

Children should always be actual children, not passed in as a prop.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-danger-with-children.md
@@ -1,4 +1,4 @@
# Prevent problem with children and props.dangerouslySetInnerHTML (no-danger-with-children)
# Prevent problem with children and props.dangerouslySetInnerHTML (react/no-danger-with-children)

This rule helps prevent problems caused by using children and the dangerouslySetInnerHTML prop at the same time.
React will throw a warning if this rule is ignored.
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-danger.md
@@ -1,4 +1,4 @@
# Prevent usage of dangerous JSX properties (no-danger)
# Prevent usage of dangerous JSX properties (react/no-danger)

Dangerous properties in React are those whose behavior is known to be a common source of application vulnerabilities. The properties names clearly indicate they are dangerous and should be avoided unless great care is taken.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-deprecated.md
@@ -1,4 +1,4 @@
# Prevent usage of deprecated methods (no-deprecated)
# Prevent usage of deprecated methods (react/no-deprecated)

Several methods are deprecated between React versions. This rule will warn you if you try to use a deprecated method. Use the [shared settings](/README.md#configuration) to specify the React version.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-did-mount-set-state.md
@@ -1,4 +1,4 @@
# Prevent usage of setState in componentDidMount (no-did-mount-set-state)
# Prevent usage of setState in componentDidMount (react/no-did-mount-set-state)

Updating the state after a component mount will trigger a second `render()` call and can lead to property/layout thrashing.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-did-update-set-state.md
@@ -1,4 +1,4 @@
# Prevent usage of setState in componentDidUpdate (no-did-update-set-state)
# Prevent usage of setState in componentDidUpdate (react/no-did-update-set-state)

Updating the state after a component update will trigger a second `render()` call and can lead to property/layout thrashing.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-direct-mutation-state.md
@@ -1,4 +1,4 @@
# Prevent direct mutation of this.state (no-direct-mutation-state)
# Prevent direct mutation of this.state (react/no-direct-mutation-state)

NEVER mutate `this.state` directly, as calling `setState()` afterwards may replace
the mutation you made. Treat `this.state` as if it were immutable.
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-find-dom-node.md
@@ -1,4 +1,4 @@
# Prevent usage of findDOMNode (no-find-dom-node)
# Prevent usage of findDOMNode (react/no-find-dom-node)

Facebook will eventually deprecate `findDOMNode` as it blocks certain improvements in React in the future.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-is-mounted.md
@@ -1,4 +1,4 @@
# Prevent usage of isMounted (no-is-mounted)
# Prevent usage of isMounted (react/no-is-mounted)

[`isMounted` is an anti-pattern][anti-pattern], is not available when using ES6 classes, and it is on its way to being officially deprecated.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-multi-comp.md
@@ -1,4 +1,4 @@
# Prevent multiple component definition per file (no-multi-comp)
# Prevent multiple component definition per file (react/no-multi-comp)

Declaring only one component per file improves readability and reusability of components.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-render-return-value.md
@@ -1,4 +1,4 @@
# Prevent usage of the return value of React.render (no-render-return-value)
# Prevent usage of the return value of React.render (react/no-render-return-value)

> `ReactDOM.render()` currently returns a reference to the root `ReactComponent` instance. However, using this return value is legacy and should be avoided because future versions of React may render components asynchronously in some cases. If you need a reference to the root `ReactComponent` instance, the preferred solution is to attach a [callback ref](http://facebook.github.io/react/docs/more-about-refs.html#the-ref-callback-attribute) to the root element.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-set-state.md
@@ -1,4 +1,4 @@
# Prevent usage of setState (no-set-state)
# Prevent usage of setState (react/no-set-state)

When using an architecture that separates your application state from your UI components (e.g. Flux), it may be desirable to forbid the use of local component state. This rule is especially helpful in read-only applications (that don't use forms), since local component state should rarely be necessary in such cases.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-string-refs.md
@@ -1,4 +1,4 @@
# Prevent using string references (no-string-refs)
# Prevent using string references (react/no-string-refs)

Currently, two ways are supported by React to refer to components. The first way, providing a string identifier, is now considered legacy in the official documentation. The documentation now prefers a second method -- referring to components by setting a property on the `this` object in the reference callback.

Expand Down
6 changes: 3 additions & 3 deletions docs/rules/no-unescaped-entities.md
@@ -1,6 +1,6 @@
# Prevent invalid characters from appearing in markup (no-unescaped-entities)
# Prevent invalid characters from appearing in markup (react/no-unescaped-entities)

This rule prevents characters that you may have meant as JSX escape characters
This rule prevents characters that you may have meant as JSX escape characters
from being accidentally injected as a text node in JSX statements.

For example, if one were to misplace their closing `>` in a tag:
Expand All @@ -27,7 +27,7 @@ Another example is when one accidentally includes an extra closing brace.

The extra brace will be rendered, and the body text will be `Text}`.

This rule will also check for `"` and `'`, which might be accidentally included
This rule will also check for `"` and `'`, which might be accidentally included
when the closing `>` is in the wrong place.

```jsx
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-unknown-property.md
@@ -1,4 +1,4 @@
# Prevent usage of unknown DOM property (no-unknown-property)
# Prevent usage of unknown DOM property (react/no-unknown-property)

In JSX all DOM properties and attributes should be camelCased to be consistent with standard JavaScript style. This can be a possible source of error if you are used to writing plain HTML.

Expand Down
4 changes: 2 additions & 2 deletions docs/rules/no-unused-prop-types.md
@@ -1,4 +1,4 @@
# Prevent definitions of unused prop types (no-unused-prop-types)
# Prevent definitions of unused prop types (react/no-unused-prop-types)

Warns you if you have defined a prop type but it is never being used anywhere.

Expand Down Expand Up @@ -45,7 +45,7 @@ var Hello = createReactClass({

This rule can take one argument to ignore some specific props during validation.

```
```js
...
"react/no-unused-prop-types": [<enabled>, { customValidators: <customValidator>, skipShapeProps: <skipShapeProps> }]
...
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-will-update-set-state.md
@@ -1,4 +1,4 @@
# Prevent usage of setState in componentWillUpdate (no-will-update-set-state)
# Prevent usage of setState in componentWillUpdate (react/no-will-update-set-state)

Updating the state during the componentWillUpdate step can lead to indeterminate component state and is not allowed.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/prefer-es6-class.md
@@ -1,4 +1,4 @@
# Enforce ES5 or ES6 class for React Components (prefer-es6-class)
# Enforce ES5 or ES6 class for React Components (react/prefer-es6-class)

React offers you two way to create traditional components: using the ES5 `create-react-class` module or the new ES6 class system. This rule allow you to enforce one way or another.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/prefer-stateless-function.md
@@ -1,4 +1,4 @@
# Enforce stateless React Components to be written as a pure function (prefer-stateless-function)
# Enforce stateless React Components to be written as a pure function (react/prefer-stateless-function)

Stateless functional components are simpler than class based components and will benefit from future React performance optimizations specific to these components.

Expand Down
4 changes: 2 additions & 2 deletions docs/rules/prop-types.md
@@ -1,4 +1,4 @@
# Prevent missing props validation in a React component definition (prop-types)
# Prevent missing props validation in a React component definition (react/prop-types)

PropTypes improve the reusability of your component by validating the received data.

Expand Down Expand Up @@ -100,7 +100,7 @@ Hello.propTypes = {

This rule can take one argument to ignore some specific props during validation.

```
```js
...
"react/prop-types": [<enabled>, { ignore: <ignore>, customValidators: <customValidator> }]
...
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/react-in-jsx-scope.md
@@ -1,4 +1,4 @@
# Prevent missing React when using JSX (react-in-jsx-scope)
# Prevent missing React when using JSX (react/react-in-jsx-scope)

When using JSX, `<a />` expands to `React.createElement("a")`. Therefore the
`React` variable must be in scope.
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/require-default-props.md
@@ -1,4 +1,4 @@
# Enforce a defaultProps definition for every prop that is not a required prop (require-default-props)
# Enforce a defaultProps definition for every prop that is not a required prop (react/require-default-props)

This rule aims to ensure that any non-required `PropType` declaration of a component has a corresponding `defaultProps` value.

Expand Down