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 support and enforcement for spread syntax in order-in-* rules #934

Merged
merged 1 commit into from Sep 7, 2020
Merged

Add support and enforcement for spread syntax in order-in-* rules #934

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions docs/rules/order-in-components.md
View file
Open in desktop
Expand Up @@ -10,6 +10,7 @@ const rules = {
2,
{
order: [
'spread',
'service',
'property',
'empty-method',
Expand Down
1 change: 1 addition & 0 deletions docs/rules/order-in-controllers.md
View file
Open in desktop
Expand Up @@ -10,6 +10,7 @@ const rules = {
2,
{
order: [
'spread',
'controller',
'service',
'query-params',
Expand Down
1 change: 1 addition & 0 deletions docs/rules/order-in-models.md
View file
Open in desktop
Expand Up @@ -11,6 +11,7 @@ const rules = {
{
// eslint-disable-next-line prettier/prettier
order: [
'spread',
'attribute',
'relationship',
'single-line-function',
Expand Down
1 change: 1 addition & 0 deletions docs/rules/order-in-routes.md
View file
Open in desktop
Expand Up @@ -10,6 +10,7 @@ const rules = {
2,
{
order: [
'spread',
'service',
'inherited-property',
'property',
Expand Down
1 change: 1 addition & 0 deletions lib/rules/order-in-components.js
View file
Open in desktop
Expand Up @@ -7,6 +7,7 @@ const reportUnorderedProperties = propOrder.reportUnorderedProperties;
const addBackwardsPosition = propOrder.addBackwardsPosition;

const ORDER = [
'spread',
'service',
'property',
'empty-method',
Expand Down
1 change: 1 addition & 0 deletions lib/rules/order-in-controllers.js
View file
Open in desktop
Expand Up @@ -7,6 +7,7 @@ const reportUnorderedProperties = propOrder.reportUnorderedProperties;
const addBackwardsPosition = propOrder.addBackwardsPosition;

const ORDER = [
'spread',
'controller',
'service',
'query-params',
Expand Down
8 changes: 7 additions & 1 deletion lib/rules/order-in-models.js
View file
Open in desktop
Expand Up @@ -6,7 +6,13 @@ const propOrder = require('../utils/property-order');
const reportUnorderedProperties = propOrder.reportUnorderedProperties;
const addBackwardsPosition = propOrder.addBackwardsPosition;

const ORDER = ['attribute', 'relationship', 'single-line-function', 'multi-line-function'];
const ORDER = [
'spread',
'attribute',
'relationship',
'single-line-function',
'multi-line-function',
];

//------------------------------------------------------------------------------
// Organizing - Organize your models
Expand Down
1 change: 1 addition & 0 deletions lib/rules/order-in-routes.js
View file
Open in desktop
Expand Up @@ -7,6 +7,7 @@ const reportUnorderedProperties = propOrder.reportUnorderedProperties;
const addBackwardsPosition = propOrder.addBackwardsPosition;

const ORDER = [
'spread',
'service',
'inherited-property',
'property',
Expand Down
14 changes: 12 additions & 2 deletions lib/utils/ember.js
View file
Open in desktop
Expand Up @@ -473,7 +473,12 @@ function isRouteProperty(name) {
}

function isRouteDefaultProp(property) {
return isRouteProperty(property.key.name) && property.key.name !== 'actions';
return (
types.isProperty(property) &&
types.isIdentifier(property.key) &&
isRouteProperty(property.key.name) &&
property.key.name !== 'actions'
);
}

function isControllerProperty(name) {
Expand All @@ -490,7 +495,12 @@ function isControllerProperty(name) {
}

function isControllerDefaultProp(property) {
return isControllerProperty(property.key.name) && property.key.name !== 'actions';
return (
types.isProperty(property) &&
types.isIdentifier(property.key) &&
isControllerProperty(property.key.name) &&
property.key.name !== 'actions'
);
}

function getModuleProperties(module) {
Expand Down
13 changes: 9 additions & 4 deletions lib/utils/property-order.js
View file
Open in desktop
Expand Up @@ -42,6 +42,7 @@ const NAMES = {
serialize: 'lifecycle hook',
service: 'service injection',
setupController: 'lifecycle hook',
spread: 'spread property',
unknown: 'unknown property type',
willClearRender: 'lifecycle hook',
willDestroyElement: 'lifecycle hook',
Expand All @@ -60,18 +61,18 @@ function determinePropertyType(node, parentType, ORDER) {
return 'controller';
}

if (node.key.name === 'init') {
if (types.isIdentifier(node.key) && node.key.name === 'init') {
return 'init';
}

if (parentType === 'component') {
if (ember.isComponentLifecycleHook(node)) {
if (types.isIdentifier(node.key) && ember.isComponentLifecycleHook(node)) {
return node.key.name;
}
}

if (parentType === 'controller') {
if (node.key.name === 'queryParams') {
if (types.isIdentifier(node.key) && node.key.name === 'queryParams') {
return 'query-params';
} else if (ember.isControllerDefaultProp(node)) {
return 'inherited-property';
Expand Down Expand Up @@ -131,6 +132,10 @@ function determinePropertyType(node, parentType, ORDER) {
return 'method';
}

if (node.type === 'ExperimentalSpreadProperty') {
return 'spread';
}

return 'unknown';
}

Expand Down Expand Up @@ -166,7 +171,7 @@ function getNodeKeyName(node) {

function getName(type, node) {
let prefix;
if (!node.computed && type !== 'actions' && type !== 'model') {
if (!node.computed && type !== 'actions' && type !== 'model' && type !== 'spread') {
prefix = getNodeKeyName(node);
}

Expand Down
3 changes: 3 additions & 0 deletions lib/utils/types.js
View file
Open in desktop
Expand Up @@ -110,6 +110,9 @@ function isCallExpression(node) {
* @return {boolean} Whether or not the node is a call with a function expression as the first argument
*/
function isCallWithFunctionExpression(node) {
if (!isCallExpression(node)) {
return false;
}
const callObj = isMemberExpression(node.callee) ? node.callee.object : node;
const firstArg = callObj.arguments ? callObj.arguments[0] : null;
return (
Expand Down
24 changes: 22 additions & 2 deletions tests/lib/rules/order-in-components.js
View file
Open in desktop
Expand Up @@ -11,20 +11,24 @@ const RuleTester = require('eslint').RuleTester;

const eslintTester = new RuleTester({
parserOptions: { ecmaVersion: 6, sourceType: 'module' },
parser: require.resolve('babel-eslint'),
});

eslintTester.run('order-in-components', rule, {
valid: [
'export default Component.extend();',
'export default Component.extend({ ...foo });',
`export default Component.extend({
role: "sloth",
...foo,
role: "sloth",

vehicle: alias("car"),

levelOfHappiness: computed("attitude", "health", () => {
}),

actions: {}
actions: {},

});`,
`export default Component.extend({
role: ${`${'sloth'}`},
Expand Down Expand Up @@ -1027,5 +1031,21 @@ eslintTester.run('order-in-components', rule, {
},
],
},
{
code: `export default Component.extend({
role: "sloth",
...spread,
});`,
output: `export default Component.extend({
...spread,
role: "sloth",
});`,
errors: [
{
message: 'The spread property should be above the "role" property on line 2',
line: 3,
},
],
},
],
});
2 changes: 2 additions & 0 deletions tests/lib/rules/order-in-controllers.js
View file
Open in desktop
Expand Up @@ -11,11 +11,13 @@ const RuleTester = require('eslint').RuleTester;

const eslintTester = new RuleTester({
parserOptions: { ecmaVersion: 6, sourceType: 'module' },
parser: require.resolve('babel-eslint'),
});

eslintTester.run('order-in-controllers', rule, {
valid: [
'export default Controller.extend();',
'export default Controller.extend({ ...foo });',
`export default Controller.extend({
application: controller(),
currentUser: service(),
Expand Down
2 changes: 2 additions & 0 deletions tests/lib/rules/order-in-models.js
View file
Open in desktop
Expand Up @@ -11,11 +11,13 @@ const RuleTester = require('eslint').RuleTester;

const eslintTester = new RuleTester({
parserOptions: { ecmaVersion: 6, sourceType: 'module' },
parser: require.resolve('babel-eslint'),
});

eslintTester.run('order-in-models', rule, {
valid: [
'export default Model.extend();',
'export default Model.extend({ ...foo });',
`export default Model.extend({
shape: attr("string"),
behaviors: hasMany("behaviour"),
Expand Down
2 changes: 2 additions & 0 deletions tests/lib/rules/order-in-routes.js
View file
Open in desktop
Expand Up @@ -11,11 +11,13 @@ const RuleTester = require('eslint').RuleTester;

const eslintTester = new RuleTester({
parserOptions: { ecmaVersion: 6, sourceType: 'module' },
parser: require.resolve('babel-eslint'),
});

eslintTester.run('order-in-routes', rule, {
valid: [
'export default Route.extend();',
'export default Route.extend({ ...foo });',
`export default Route.extend({
currentUser: service(),
queryParams: {},
Expand Down
10 changes: 10 additions & 0 deletions tests/lib/utils/property-order-test.js
View file
Open in desktop
Expand Up @@ -198,6 +198,16 @@ describe('determinePropertyType', () => {
expect(propertyOrder.determinePropertyType(node, 'component', [])).toStrictEqual('property');
});

it('should determine spread syntax as a spread property', () => {
const context = new FauxContext(
`export default Component.extend({
...foo
});`
);
const node = context.ast.body[0].declaration.arguments[0].properties[0];
expect(propertyOrder.determinePropertyType(node, 'component', [])).toStrictEqual('spread');
});

it('should determine empty methods', () => {
const context = new FauxContext(
`export default Component.extend({
Expand Down