HowTo Use OpenFOAM with Visual Studio Code

From OpenFOAMWiki
Revision as of 22:15, 14 October 2020 by Volker Weißmann (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

The C++ language server (ccls) can read and analyze C++ source code to provide features like "Go to Definition" in many Editors. Because ccls needs to know how the files are compiled, you need to do a bit of configuration. This guide shows how to set this up for OpenFOAM in Visual Studio Code.

Please note, that this depends on OpenFOAM commits that still lie in the future. I will remove this note once the commits get approved.

  1. Install VS Code
  2. Install the ccls vs code extension
  3. Install bear
  4. Rebuild OpenFOAM and all your custom libraries that use wmake
  5. Run the command setupVScodeFOAM (you need to set the environment for that)
  6. In VS Code, open the folder where you ran the setupVScodeFOAM command. Note that it does not matter whether the source files are in this folder or not.

For questions about this setup ask Volker Weißmann.

If you find that "Go to Definition" or some other features do not work on some specific function, please file a bug report for the ccls plugin.