Merge pull request #1301 from bmish/rules-type-jsdoc

Add jsdoc `type` annotation to rules

lib/rules/alias-model-in-controller.js

@@ -7,6 +7,9 @@ const ember = require('../utils/ember');
 // Controllers - Alias your model
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',

lib/rules/avoid-leaking-state-in-ember-objects.js

@@ -48,6 +48,9 @@ function isAllowed(value) {
 // (Don't use arrays or objects as default props)
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'problem',

lib/rules/avoid-using-needs-in-controllers.js

@@ -6,6 +6,9 @@ const ember = require('../utils/ember');
 // Ember object rule - Avoid using needs in controllers
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',

lib/rules/classic-decorator-hooks.js

@@ -5,6 +5,9 @@ const ERROR_MESSAGE_DESTROY_IN_NON_CLASSIC =
 const ERROR_MESSAGE_CONSTRUCTOR_IN_CLASSIC =
   'You cannot use the constructor in a classic class. If the class can be converted, you can convert it to remove all classic APIs and remove the @classic decorator, then switch to the constructor.';
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   ERROR_MESSAGE_INIT_IN_NON_CLASSIC,
   ERROR_MESSAGE_DESTROY_IN_NON_CLASSIC,

lib/rules/classic-decorator-no-classic-methods.js

@@ -18,6 +18,9 @@ function disallowedMethodErrorMessage(name) {
   return `The this.${name}() method is a classic ember object method, and can't be used in octane classes. You can refactor this usage to use a utility version instead (e.g. get(this, 'foo')), or to use native/modern syntax instead. Alternatively, you can add the @classic decorator to this class to continue using classic APIs.`;
 }
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   disallowedMethodErrorMessage,
 

lib/rules/closure-actions.js

@@ -8,6 +8,9 @@ const types = require('../utils/types');
 
 const ERROR_MESSAGE = 'Use closure actions';
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',

lib/rules/computed-property-getters.js

@@ -13,6 +13,9 @@ const PREVENT_GETTER_MESSAGE = 'Do not use a getter inside computed properties.'
 const ALWAYS_WITH_SETTER_MESSAGE =
   'Always define a getter inside computed properties when using a setter.';
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',

lib/rules/jquery-ember-run.js

@@ -29,6 +29,9 @@ const EMBER_RUNLOOP_FUNCTIONS = [
   'throttle',
 ];
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'problem',

lib/rules/named-functions-in-promises.js

@@ -6,6 +6,9 @@ const types = require('../utils/types');
 // General rule - Use named functions defined on objects to handle promises
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',

lib/rules/new-module-imports.js

@@ -22,6 +22,9 @@ const GLOBALS = MAPPING.reduce((memo, exportDefinition) => {
 // General rule - Use "New Module Imports" from Ember RFC #176
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'problem',

lib/rules/no-actions-hash.js

@@ -3,6 +3,9 @@ const utils = require('../utils/utils');
 
 const ERROR_MESSAGE = 'Use the @action decorator instead of declaring an actions hash';
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   ERROR_MESSAGE,
   meta: {

lib/rules/no-arrow-function-computed-properties.js

@@ -6,6 +6,9 @@ const { getImportIdentifier } = require('../utils/import');
 
 const ERROR_MESSAGE = 'Do not use arrow functions in computed properties';
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   ERROR_MESSAGE,
 

lib/rules/no-assignment-of-untracked-properties-used-in-tracking-contexts.js

@@ -83,6 +83,9 @@ class Stack {
   }
 }
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'problem',

lib/rules/no-attrs-in-components.js

@@ -9,6 +9,9 @@ const ERROR_MESSAGE = 'Do not use `this.attrs`';
 // General rule - Don't use this.attrs
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'problem',

lib/rules/no-attrs-snapshot.js

@@ -17,6 +17,9 @@ const hasAttrsSnapShot = function (node) {
   return (methodName === 'didReceiveAttrs' || methodName === 'didUpdateAttrs') && hasParams;
 };
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'problem',

lib/rules/no-capital-letters-in-routes.js

@@ -7,6 +7,9 @@ const types = require('../utils/types');
 // Routing - No capital letters in routes
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'problem',

lib/rules/no-classic-classes.js

@@ -35,6 +35,9 @@ function isEmberImport(classImportedFrom) {
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   ERROR_MESSAGE_NO_CLASSIC_CLASSES,
 

lib/rules/no-classic-components.js

@@ -6,6 +6,9 @@ const assert = require('assert');
 const ERROR_MESSAGE =
   'Use Glimmer components(@glimmer/component) instead of classic components(@ember/component)';
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',

lib/rules/no-component-lifecycle-hooks.js

@@ -16,6 +16,9 @@ const report = (context, node) => {
   context.report(node, ERROR_MESSAGE_NO_COMPONENT_LIFECYCLE_HOOKS);
 };
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   ERROR_MESSAGE_NO_COMPONENT_LIFECYCLE_HOOKS,
   meta: {

lib/rules/no-computed-properties-in-native-classes.js

@@ -26,6 +26,9 @@ function findComputedNodes(nodeBody) {
 // General rule - Do not use computed properties in native classes
 //----------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',

lib/rules/no-controller-access-in-routes.js

@@ -11,6 +11,9 @@ const ERROR_MESSAGE =
 // Routing - No controller access in routes
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'problem',

lib/rules/no-controllers.js

@@ -5,6 +5,9 @@ const assert = require('assert');
 
 const ERROR_MESSAGE = 'Avoid using controllers except for specifying `queryParams`';
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   ERROR_MESSAGE,
   meta: {

lib/rules/no-current-route-name.js

@@ -2,6 +2,9 @@
 
 const ERROR_MESSAGE = 'Use currentURL() instead of currentRouteName()';
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',

lib/rules/no-deeply-nested-dependent-keys-with-each.js

@@ -10,6 +10,9 @@ const { getImportIdentifier } = require('../utils/import');
 const ERROR_MESSAGE =
   'Dependent keys containing `@each` only work one level deep. You cannot use nested forms like: `todos.@each.owner.name`. Please create an intermediary computed property instead.';
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'problem',

lib/rules/no-duplicate-dependent-keys.js

@@ -11,6 +11,9 @@ const ERROR_MESSAGE = 'Dependent keys should not be repeated';
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'problem',

lib/rules/no-ember-super-in-es-classes.js

@@ -1,5 +1,8 @@
 'use strict';
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'problem',

lib/rules/no-ember-testing-in-module-scope.js

@@ -9,6 +9,9 @@ const ERROR_MESSAGES = [
   'Can not use destructuring to reference Ember.testing',
 ];
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'problem',

lib/rules/no-empty-attrs.js

@@ -6,6 +6,9 @@ const ember = require('../utils/ember');
 // Ember Data - Be explicit with Ember data attribute types
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',

lib/rules/no-empty-glimmer-component-classes.js

@@ -8,6 +8,9 @@ const ERROR_MESSAGE = 'Do not create empty backing classes for Glimmer component
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',

lib/rules/no-function-prototype-extensions.js

@@ -6,6 +6,9 @@ const types = require('../utils/types');
 // General rule - Don't use Ember's function prototype extensions like .property() or .observe()
 //----------------------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',

lib/rules/no-get-with-default.js

@@ -5,6 +5,9 @@ const { getImportIdentifier } = require('../utils/import');
 
 const ERROR_MESSAGE = 'Use `||` or the ternary operator instead of `getWithDefault()`';
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   ERROR_MESSAGE,
   meta: {

lib/rules/no-get.js

@@ -80,6 +80,9 @@ function fixGet({
   return fixer.replaceText(node, `${objectTextSafe}${objectPathSeparator}${replacementPath}`);
 }
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   ERROR_MESSAGE_GET,
   ERROR_MESSAGE_GET_PROPERTIES,

lib/rules/no-global-jquery.js

@@ -9,6 +9,9 @@ const ERROR_MESSAGE = 'Do not use global `$` or `jQuery`';
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',

lib/rules/no-html-safe.js

@@ -7,6 +7,9 @@ const { getImportIdentifier } = require('../utils/import');
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',

lib/rules/no-implicit-service-injection-argument.js

@@ -10,6 +10,9 @@ const { getImportIdentifier } = require('../utils/import');
 
 const ERROR_MESSAGE = "Don't omit the argument for the injected service name.";
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',

lib/rules/no-incorrect-calls-with-inline-anonymous-functions.js

@@ -17,6 +17,9 @@ const functionRules = [
 
 const allDedupingRunMethodNames = new Set(functionRules.map((rule) => rule.importName));
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   ERROR_MESSAGE,
 

lib/rules/no-incorrect-computed-macros.js

@@ -5,6 +5,9 @@ const types = require('../utils/types');
 
 const ERROR_MESSAGE_AND_OR = 'Computed property macro should be used with 2+ arguments';
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'problem',

lib/rules/no-invalid-debug-function-arguments.js

@@ -12,6 +12,9 @@ const ERROR_MESSAGE =
 
 const DEBUG_FUNCTIONS = ['assert', 'deprecate', 'warn'];
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'problem',

lib/rules/no-invalid-dependent-keys.js

@@ -35,6 +35,9 @@ function hasMiddleBrackets(str) {
   return str.includes('[].');
 }
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'problem',

lib/rules/no-invalid-test-waiters.js

@@ -20,6 +20,9 @@ function isDirectVariableDeclaration(node) {
   return node.parent.type === 'VariableDeclarator';
 }
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 module.exports = {
   meta: {
     type: 'suggestion',