tree: f0f0654d9c50c6f0e3afc32d88f6f664f19b8f6c [path history] [tgz]
  1. README.md
  2. default_settings.json
  3. paths.py
  4. ycm_extra_conf.py
scripts/youcompleteme/README.md

YouCompleteMe for Fuchsia Developers

You can use YouCompleteMe to provide error checking, completion and source navigation within the Fuchsia tree.

YouCompleteMe works natively with Vim but it can also be integrated with other editors through ycmd.

Install

See the installation guide.

Note: Installing YCM on MacOS with Homebrew is not recommended because of library compatibility errors. Use the official installation guide instead.

gLinux (Googlers only)

(compiling on gLinux, even if editing over SSHFS on MacOS) Ignore the above. Search the Google intranet for “YouCompleteMe” for installation instructions.

Configure

Vim

The general Vim Fuchsia instructions will do this automatically.

The setup will use a compilation database (and the clangd backend if you are a Googler) provided one is detected, and fallback on a ycm_extra_conf.py configuration otherwise. You can build a compilation database with fx compdb, or fx -i compdb if you want it rebuilt automatically as you edit files.

Other editors (ycmd)

You'll need to set the ycmd config option global_ycm_extra_conf to point to ${FUCHSIA_DIR}/scripts/youcompleteme/ycm_extra_conf.py. Note you may need to manually replace ${FUCHSIA_DIR} with the correct path.

Alternatively, you can create a .ycm_extra_conf.py symbolic link to let YCM automatically find the config for any fuchsia repository:

ln -s $FUCHSIA_DIR/scripts/youcompleteme/ycm_extra_conf.py $FUCHSIA_DIR/.ycm_extra_conf.py

Googlers only: you‘ll also need to setup ${FUCHSIA_DIR}/scripts/youcompleteme/default_settings.json as the default settings path in your editor, in order to disable the internal use_clangd flag. If you want to use clangd, you can additionally edit that file to set use_clangd to 1, and clang_binary_path to ${FUCHSIA_BUILDTOOLS_DIR}/clang/bin/clangd. Remember that in that case, you’ll need to build a compilation database with fx compdb.

See also

Zircon editor integration