ESLint запрещает/блокирует тип возврата this для удобочитаемости

Вопрос или проблема

rules: {
    "no-restricted-syntax": [
        "error",
        "FunctionExpression[returnType.typeAnnotation.type="TSThisType"]",
        "ArrowFunctionExpression[returnType.typeAnnotation.type="TSThisType"]"
    ]
}

Ответ или решение

Для того чтобы использовать правило ESLint no-restricted-syntax с целью запрета использования ключевого слова this в качестве типа возвращаемого значения для функций и методов классов в TypeScript, необходимо внести изменения в конфигурацию вашего ESLint. Ниже описаны шаги, которые помогут вам достичь этой цели.

Шаги по настройке ESLint

1. Установите необходимые зависимости: Убедитесь, что у вас установлены ESLint и необходимые плагины для работы с TypeScript. Если они еще не установлены, выполните следующие команды:

   npm install eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin --save-dev

2. Создайте или отредактируйте файл конфигурации ESLint: Если у вас еще нет файла конфигурации, создайте файл .eslintrc.json в корне проекта. Если файл уже существует, добавьте в него настройки.

3. Настройка правила: Добавьте правило no-restricted-syntax в секцию rules вашего файла конфигурации ESLint следующим образом:

   {
      "parser": "@typescript-eslint/parser",
      "plugins": ["@typescript-eslint"],
      "rules": {
          "no-restricted-syntax": [
              "error",
              {
                  "selector": "FunctionExpression[returnType.typeAnnotation.type='TSThisType']",
                  "message": "Использование 'this' в качестве типа возвращаемого значения запрещено."
              },
              {
                  "selector": "ArrowFunctionExpression[returnType.typeAnnotation.type='TSThisType']",
                  "message": "Использование 'this' в качестве типа возвращаемого значения запрещено."
              }
          ]
      }
   }

4. Проверка конфигурации: После внесения изменений, запустите ESLint для проверки вашего кода на наличие нарушений:

   npx eslint .

5. Использование правила: После настройки, ESLint будет выдавать ошибки, если вы будете пытаться использовать this в качестве типа возвращаемого значения в функция или стрелочных функциях.

Пример запрещенного кода:

class Example {
    getThis(): this { // Это вызовет ошибку ESLint
        return this;
    }

    static create(): this { // Это также вызовет ошибку ESLint
        return new this();
    }
}

Заключение

Использование правила no-restricted-syntax в ESLint позволяет явно контролировать код, предотвращая возможность использования this в качестве возвращаемого типа, что может повысить читаемость и предсказуемость кода. Надеюсь, эта информация была для вас полезной. Если у вас есть дополнительные вопросы, не стесняйтесь задавать их.