Используйте TypeScript для облачных функций

Для разработчиков, предпочитающих писать функции на TypeScript, Cloud Functions предоставляет два типа поддержки:

  • Создайте и настройте проекты TypeScript для автоматической транспиляции при инициализации ( firebase init functions ).
  • Транспилируйте существующий исходный код TypeScript в JavaScript во время развертывания с помощью хука predeploy .

Следуя инструкциям в этом руководстве, вы можете перенести существующий проект JavaScript на TypeScript и продолжить развертывание функций с помощью predeploy hook для транспиляции исходного кода. TypeScript предлагает множество преимуществ по сравнению с ванильным JavaScript при написании функций:

  • TypeScript поддерживает новейшие функции JavaScript, такие как async/await, упрощая управление обещаниями.
  • Линтер Cloud Functions выявляет распространенные проблемы во время кодирования
  • Безопасность типов помогает избежать ошибок во время выполнения развернутых функций.

Если вы новичок в TypeScript, ознакомьтесь со статьей TypeScript за 5 минут .

Инициализация нового проекта Cloud Functions с помощью TypeScript

Запустите firebase init functions в новом каталоге. Инструмент предоставляет вам возможность построить проект с помощью JavaScript или TypeScript. Выберите TypeScript , чтобы вывести следующую структуру проекта:

myproject
 +- functions/     # Directory containing all your functions code
      |
      +- package.json  # npm package file describing your Cloud Functions code
      |
      +- tsconfig.json
      |
      +- .eslintrc.js # Optional file if you enabled ESLint
      +- tsconfig.dev.json # Optional file that references .eslintrc.js
      |
      +- src/     # Directory containing TypeScript source
      |   |
      |   +- index.ts  # main source file for your Cloud Functions code
      |
      +- lib/
          |
          +- index.js  # Built/transpiled JavaScript code
          |
          +- index.js.map # Source map for debugging

После завершения инициализации раскомментируйте пример в index.ts и запустите npm run serve чтобы увидеть функцию «Hello World» в действии.

Использование существующего проекта TypeScript

Если у вас есть существующий проект TypeScript, вы можете добавить predeploy hook, чтобы убедиться, что ваш проект транспилируется каждый раз, когда вы развертываете свой код в Cloud Functions for Firebase . Вам понадобится правильно сформированный файл tsconfig.json и проект Firebase, а также вам нужно будет внести следующие изменения в конфигурацию Firebase:

  1. Отредактируйте package.json , чтобы добавить скрипт bash для сборки вашего проекта TypeScript. Например:

     {
   "name": "functions",
   "scripts": {
     "build": "npm run lint && tsc"
   }
 ...

  2. Отредактируйте firebase.json , чтобы добавить predeploy hook для запуска скрипта сборки. Например:

     {
   "functions": {
     "predeploy": "npm --prefix functions run build",
   }
 }

При такой конфигурации команда firebase deploy --only functions создает ваш код TypeScript и развертывает его как функции.

Миграция существующего проекта JavaScript на TypeScript

Если у вас есть существующий проект Cloud Functions , который вы инициализировали и разработали на JavaScript, вы можете перенести его на TypeScript. Настоятельно рекомендуется создать контрольную точку git или другую резервную копию перед началом.

Чтобы перенести существующий проект JavaScript Cloud Functions :

  1. Создайте контрольную точку git и сохраните копии существующих исходных файлов JavaScript.
  2. В каталоге проекта запустите firebase init functions и выберите TypeScript при появлении запроса на выбор языка для написания функций.
  3. При появлении запроса на перезапись существующего файла package.json выберите «Нет» , если вы не уверены, что хотите сохранить существующий файл.
  4. Удалите index.ts в каталоге functions/src , заменив его существующим исходным кодом.
  5. В файле tsconfig.json , созданном при инициализации, установите параметры компилятора, разрешающие JavaScript: "allowJs": true .
  6. Скопируйте сохраненный файл package.json в каталог functions и отредактируйте его, установив для "main" значение "lib/index.js" .

  7. Также в package.json добавьте скрипт сборки для TypeScript, например, следующий:

     {
   "name": "functions",
   "scripts": {
     "build": "npm run lint && tsc"
   }
 ...

  8. Добавьте "typescript" в качестве зависимости разработки, выполнив npm install --save-dev typescript @typescript-eslint/eslint-plugin @typescript-eslint/parser .

  9. Для всех зависимостей выполните npm install --save @types/<dependency> .

  10. Перепишите исходный код из .js в .ts по желанию.

Эмуляция функций TypeScript

Для локального тестирования функций TypeScript можно использовать инструменты эмуляции, описанные в разделе Запуск функций локально . Важно скомпилировать код перед использованием этих инструментов, поэтому обязательно запустите npm run build внутри каталога функций перед запуском firebase emulators:start или firebase functions:shell . В качестве альтернативы запустите npm run serve или npm run shell в качестве ярлыка; эти команды запускают как сборку, так и serve/start оболочку функций.

Журналы функций для проектов TypeScript

Во время firebase deploy index.ts вашего проекта транспилируется в index.js , что означает, что журнал Cloud Functions выведет номера строк из файла index.js , а не написанный вами код. Чтобы вам было проще найти соответствующие пути и номера строк в index.ts , firebase deploy создает файл functions/lib/index.js.map . Вы можете использовать эту исходную карту в предпочитаемой вами IDE или через модуль node .