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.

Sign up for GitHub

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

Jump to bottom

Add instance-methods and instance-variables to sort-comp. #1470

Merged
merged 4 commits into from
Nov 27, 2017
Merged

Add instance-methods and instance-variables to sort-comp. #1470

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b2fefdc
Add instance-methods and instance-variables to sort-comp.
RDGthree Oct 10, 2017
3d0dc23
Update docs.
RDGthree Oct 10, 2017
0eacd40
Improve tests.
RDGthree Oct 10, 2017
7efe31a
Account for class methods.
RDGthree Oct 10, 2017
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
4 changes: 3 additions & 1 deletion docs/rules/sort-comp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,9 +89,11 @@ The default configuration is:
* `lifecycle` is referring to the `lifecycle` group defined in `groups`.
* `everything-else` is a special group that match all the methods that do not match any of the other groups.
* `render` is referring to the `render` method.
* `type-annotations`. This group is not specified by default, but can be used to enforce flow annotations to be at the top.
* `type-annotations`. This group is not specified by default, but can be used to enforce flow annotations positioning.
* `getters` This group is not specified by default, but can be used to enforce class getters positioning.
* `setters` This group is not specified by default, but can be used to enforce class setters positioning.
* `instance-variables` This group is not specified by default, but can be used to enforce all other instance variables positioning.
* `instance-methods` This group is not specified by default, but can be used to enforce all other instance methods positioning.

You can override this configuration to match your needs.

Expand Down
24 changes: 24 additions & 0 deletions lib/rules/sort-comp.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,20 @@ module.exports = {
}
}

if (indexes.length === 0 && method.instanceVariable) {
const annotationIndex = methodsOrder.indexOf('instance-variables');
if (annotationIndex >= 0) {
indexes.push(annotationIndex);
}
}

if (indexes.length === 0 && method.instanceMethod) {
const annotationIndex = methodsOrder.indexOf('instance-methods');
if (annotationIndex >= 0) {
indexes.push(annotationIndex);
}
}

// No matching pattern, return 'everything-else' index
if (indexes.length === 0) {
for (i = 0, j = methodsOrder.length; i < j; i++) {
Expand Down Expand Up @@ -384,6 +398,16 @@ module.exports = {
getter: node.kind === 'get',
setter: node.kind === 'set',
static: node.static,
instanceVariable: !node.static &&
node.type === 'ClassProperty' &&
node.value &&
node.value.type !== 'ArrowFunctionExpression' &&
node.value.type !== 'FunctionExpression',
instanceMethod: !node.static &&
node.type === 'ClassProperty' &&
node.value &&
(node.value.type === 'ArrowFunctionExpression' ||
node.value.type === 'FunctionExpression'),
typeAnnotation: !!node.typeAnnotation && node.value === null
}));

Expand Down
90 changes: 90 additions & 0 deletions tests/lib/rules/sort-comp.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,6 +310,50 @@ ruleTester.run('sort-comp', rule, {
'render'
]
}]
}, {
// Instance methods should be at the top
code: [
'class Hello extends React.Component {',
' foo = () => {}',
' constructor() {}',
' classMethod() {}',
' static bar = () => {}',
' render() {',
' return <div>{this.props.text}</div>;',
' }',
'}'
].join('\n'),
parser: 'babel-eslint',
options: [{
order: [
'instance-methods',
'lifecycle',
'everything-else',
'render'
]
}]
}, {
// Instance variables should be at the top
code: [
'class Hello extends React.Component {',
' foo = \'bar\'',
' constructor() {}',
' state = {}',
' static bar = \'foo\'',
' render() {',
' return <div>{this.props.text}</div>;',
' }',
'}'
].join('\n'),
parser: 'babel-eslint',
options: [{
order: [
'instance-variables',
'lifecycle',
'everything-else',
'render'
]
}]
}],

invalid: [{
Expand Down Expand Up @@ -515,5 +559,51 @@ ruleTester.run('sort-comp', rule, {
'render'
]
}]
}, {
// Instance methods should not be at the top
code: [
'class Hello extends React.Component {',
' constructor() {}',
' static bar = () => {}',
' classMethod() {}',
' foo = function() {}',
' render() {',
' return <div>{this.props.text}</div>;',
' }',
'}'
].join('\n'),
parser: 'babel-eslint',
errors: [{message: 'foo should be placed before constructor'}],
options: [{
order: [
'instance-methods',
'lifecycle',
'everything-else',
'render'
]
}]
}, {
// Instance variables should not be at the top
code: [
'class Hello extends React.Component {',
' constructor() {}',
' state = {}',
' static bar = {}',
' foo = {}',
' render() {',
' return <div>{this.props.text}</div>;',
' }',
'}'
].join('\n'),
parser: 'babel-eslint',
errors: [{message: 'foo should be placed before constructor'}],
options: [{
order: [
'instance-variables',
'lifecycle',
'everything-else',
'render'
]
}]
}]
});