๐Ÿ”Debugging in VS Code

Multiple launch configurations and tasks are defined for AppFlowy. These are used in the build process in order to generate needed files, clean up temporary files, and compile the source code.

Launch Configurations

A launch configuration is what is used when you type F5 or Ctrl-F5to launch the application.

You can select your preferred launch configuration by going to the Run and Debug tab in VS Code.

Launch configurations are defined in the /frontend/.vscode/launch.json file

Tasks

Tasks are be launched manually (although you are free to keybind them locally). You can see a list of all tasks available by initiating the command palette (Ctrl-Shift-P) and then typing "run task".

You can now type "AF:" to see a list of all AppFlowy provided tasks. Click on the desired task to trigger it.

We recommend binding the Alt-T key combination to the "Tasks: Run Task" command. This is done by initiating the command palette (Ctrl-Shift-P) and then typing "Open Keyboard Shortcuts".

Note that Ctrl-Shift-B will trigger the default build task. We have configured AF: Code Gen as the default build task.

In order to make them easy to identify, all AppFlowy defined tasks are prefixed with "AF: "

Tasks are defined in the /frontend/.vscode/tasks.json file.

Last updated