Merge pull request #2578 from RobbieTheWagner/feat/native-controller-class-order-support

Add native class support for order-in-controllers

Author: NullVoxPopuli

docs/rules/order-in-controllers.md

@@ -125,8 +125,4 @@ export default Controller.extend({
 });
 ```
 
-## Help Wanted
-
-| Issue                                      | Link                                                                |
-| :----------------------------------------- | :------------------------------------------------------------------ |
-| ❌ Missing native JavaScript class support | [#560](https://github.com/ember-cli/eslint-plugin-ember/issues/560) |
+This rule checks ordering only; it does not enforce indentation or other whitespace formatting.

lib/rules/order-in-controllers.js

@@ -91,6 +91,40 @@ module.exports = {
           return;
         }
 
+        reportUnorderedProperties(
+          node,
+          context,
+          'controller',
+          order,
+          importedEmberName,
+          importedInjectName,
+          importedObserverName,
+          importedControllerName,
+          scopeManager
+        );
+      },
+      ClassDeclaration(node) {
+        if (!ember.isEmberController(context, node)) {
+          return;
+        }
+
+        reportUnorderedProperties(
+          node,
+          context,
+          'controller',
+          order,
+          importedEmberName,
+          importedInjectName,
+          importedObserverName,
+          importedControllerName,
+          scopeManager
+        );
+      },
+      ClassExpression(node) {
+        if (!ember.isEmberController(context, node)) {
+          return;
+        }
+
         reportUnorderedProperties(
           node,
           context,

tests/lib/rules/order-in-controllers.js

@@ -10,7 +10,13 @@ const RuleTester = require('eslint').RuleTester;
 // ------------------------------------------------------------------------------
 
 const eslintTester = new RuleTester({
-  parserOptions: { ecmaVersion: 2022, sourceType: 'module' },
+  parserOptions: {
+    ecmaVersion: 2022,
+    sourceType: 'module',
+    babelOptions: {
+      configFile: require.resolve('../../../.babelrc'),
+    },
+  },
   parser: require.resolve('@babel/eslint-parser'),
 });
 
@@ -146,6 +152,51 @@ eslintTester.run('order-in-controllers', rule, {
       ],
       parserOptions: { ecmaVersion: 2022, sourceType: 'module' },
     },
+    `import Controller from '@ember/controller';
+      import { inject as service } from '@ember/service';
+      export default class UserController extends Controller {
+        @service currentUser;
+        queryParams = [];
+        customProp = 'test';
+        actions() {}
+      }`,
+    {
+      code: `import Controller from '@ember/controller';
+        import { inject as service } from '@ember/service';
+        export default class UserController extends Controller {
+          queryParams = [];
+          @service currentUser;
+          actions() {}
+        }`,
+      options: [
+        {
+          order: ['query-params', 'service', 'single-line-function'],
+        },
+      ],
+    },
+    {
+      code: `import Controller from '@ember/controller';
+        import { inject as service } from '@ember/service';
+        export default class UserController extends Controller {
+          @service currentUser;
+          queryParams = [];
+          customProp = 'test';
+        }`,
+      options: [
+        {
+          order: [['service', 'query-params'], 'property'],
+        },
+      ],
+    },
+    // spacing/indentation is intentionally not validated by this rule;
+    // only member ordering should matter.
+    `import Controller from '@ember/controller';
+      import { inject as service } from '@ember/service';
+      export default class UserController extends Controller {
+            @service currentUser;
+        queryParams = [];
+                 customProp = 'test';
+      }`,
   ],
   invalid: [
     {
@@ -524,5 +575,76 @@ eslintTester.run('order-in-controllers', rule, {
         },
       ],
     },
+    {
+      code: `import Controller from '@ember/controller';
+        import { inject as service } from '@ember/service';
+        export default class UserController extends Controller {
+          queryParams = [];
+          @service currentUser;
+          customProp = 'test';
+        }`,
+      output: `import Controller from '@ember/controller';
+        import { inject as service } from '@ember/service';
+        export default class UserController extends Controller {
+          @service currentUser;
+          queryParams = [];
+          customProp = 'test';
+        }`,
+      errors: [
+        {
+          message:
+            'The "currentUser" service injection should be above the "queryParams" property on line 4',
+          line: 5,
+        },
+      ],
+    },
+    {
+      code: `import Controller from '@ember/controller';
+        export default class UserController extends Controller {
+          customProp = 'test';
+          queryParams = [];
+          actions() {}
+        }`,
+      output: `import Controller from '@ember/controller';
+        export default class UserController extends Controller {
+          queryParams = [];
+          customProp = 'test';
+          actions() {}
+        }`,
+      errors: [
+        {
+          message: 'The "queryParams" property should be above the "customProp" property on line 3',
+          line: 4,
+        },
+      ],
+    },
+    {
+      code: `import Controller from '@ember/controller';
+        import { inject as service } from '@ember/service';
+        export default class UserController extends Controller {
+          @service currentUser;
+          queryParams = [];
+          actions() {}
+        }`,
+      output: `import Controller from '@ember/controller';
+        import { inject as service } from '@ember/service';
+        export default class UserController extends Controller {
+          queryParams = [];
+          @service currentUser;
+          actions() {}
+        }`,
+      options: [
+        {
+          order: ['query-params', 'service', 'single-line-function'],
+        },
+      ],
+      errors: [
+        {
+          message:
+            'The "queryParams" property should be above the "currentUser" service injection on line 4',
+          line: 5,
+        },
+      ],
+    },
   ],
 });

tests/lib/utils/ember-test.js

@@ -1706,6 +1706,8 @@ describe('isFunctionExpression', () => {
       test: () => {}
     }`);
     expect(emberUtils.isFunctionExpression(property.value)).toBeTruthy();
+
+    expect(emberUtils.isFunctionExpression(null)).toBeFalsy();
   });
 });