Настройка VSCode

Этот гайд проведет вас через первоначальную настройку VSCode для разработчиков Baserow. Он обеспечит возможность запуска и отладки всех тестов, а также включит все необходимые линтеры и автоматические исправители стиля, чтобы сделать вашу жизнь как можно проще.

Этот гайд предполагает, что у вас есть базовое понимание git, python, virtualenvs, postgres и командных строк.

1. Сначала клонируйте свежую копию Baserow: git clone git@gitlab.com:baserow/baserow.git (или ваш личный форк проекта)
2. cd baserow
3. ./config/vscode/apply_standard_baserow_vscode_config.sh
   1. Введите Y и нажмите Enter, чтобы применить стандартную конфигурацию Baserow
4. Откройте VSCode и на экране "Добро пожаловать в VSCode" нажмите кнопку "Открыть" и откройте папку baserow, которую вы склонировали выше.
5. Убедитесь, что у вас установлен и включен плагин Python для VSCode.
6. Теперь мы создадим виртуальное окружение Python и настроим VSCode для его использования при запуске тестов и линтеров:
   1. Выберите место для вашего виртуального окружения, рекомендуется хранить его отдельно от папки с исходным кодом Baserow, чтобы VSCode не индексировал его.
   2. Создайте виртуальное окружение: mkdir $HOME/.virtualenvs; python3 -m venv $HOME/.virtualenvs/baserow или $HOME/.virtualenvs; virtualenv -p python $HOME/.virtualenvs/baserow
   3. Активируйте виртуальное окружение: source $HOME/.virtualenvs/baserow/bin/activate (может отличаться в зависимости от вашей оболочки)
   4. Выполните which pip и убедитесь, что вывод этой команды указывает на бин в вашем новом виртуальном окружении
   5. Перейдите в директорию с исходным кодом Baserow: cd path/to/your/baserow
   6. Установите все требования Python для Baserow в ваше виртуальное окружение: pip install -r backend/requirements/dev.txt -r backend/requirements/base.txt
   7. Затем вам, вероятно, потребуется выбрать его в качестве интерпретатора по умолчанию для проекта:
      1. Нажмите: Ctrl + Shift + P или откройте палитру команд
      2. Введите: Python: select interpreter
      3. Найдите и выберите исполняемый файл bin/python вашего виртуального окружения
   8. Если вы не видите тесты Python в меню тестирования:
      1. Нажмите: Ctrl + Shift + P или откройте палитру команд
      2. Введите: Python: Configure Tests
7. Установите и запустите локальную базу данных PostgreSQL:
   1. https://www.postgresql.org/docs/11/tutorial-install.html
   2. Измените порт по умолчанию PostgreSQL, иначе он будет конфликтовать при запуске с Baserow (стандартная конфигурация VSCode в репозитории предполагает, что ваша тестовая база данных работает на порту 5430)
      1. https://stackoverflow.com/questions/187438/change-pgsql-port
   3. Создайте пользователя Baserow с именем baserow и паролем baserow и предоставьте ему права на создание баз данных

      1. https://medium.com/coding-blocks/creating-user-database-and-adding-access-on-postgresql-8bfcd2f4a91e

         CREATE USER baserow WITH ENCRYPTED PASSWORD 'baserow';
         ALTER USER baserow CREATEDB;
   4. Возможно, вам также потребуется выполнить pip install psycopg2-binary или sudo apt install libpq-dev
8. Теперь вы должны иметь возможность запускать тесты Python для backend из меню тестирования, попробуйте запустить backend/tests/baserow/core/test_core_models.py, например.
9. Теперь давайте настроим ваш frontend для разработки, перейдя в директорию baserow/web-frontend
10. Используйте nvm для установки правильной версии node. Чтобы определить версию Node.js, которую следует использовать, посмотрите значение runtimeVersion внутри файла launch.json. Например, если версия — v16.15.0, вы можете установить ее с помощью: nvm install v16.15.0 и затем активировать с помощью nvm use v16.15.0. Альтернативно, см. baserow/docs/installation/supported.md, чтобы определить поддерживаемую версию Node.js.
11. Установите yarn глобально: npm install -g yarn
12. Теперь выполните yarn install, чтобы установить зависимости.
13. Выберите "Trust Project", если увидите всплывающее окно VSCode после выполнения yarn install
14. Если вы не видите тесты Jest в меню тестирования:
    1. Нажмите: Ctrl + Shift + P или откройте палитру команд
    2. Введите: Jest: Start All Runners
15. Подтвердите, что вы можете запустить юнит-тест frontend из VSCode

Рекомендуемые плагины

Вы можете использовать VSC Export & Import для установки того, что находится внутри config/vscode/vsc-extensions.txt. Или вы можете установить их вручную:

1. Python
2. Volar
3. Eslint
4. Gitlab Workflow
5. Gitlens
6. Jest
7. SCSS Formatter
8. Stylelint
9. Mypy
10. Docker
11. Coverage Gutters