зеркало из https://github.com/mozilla/gecko-dev.git
Bug 1629445
- Add a page about editor/IDE integration to the docs. r=sylvestre
This is a frequent question in #introduction / #developers. I'm not aware of any page in MDN that documents this kind of stuff. This is intended to be a catch-all page for stuff that some people may want to have like auto-completion, debugger/linter integration, etc... In the future, maybe this should be a sub-section in a more general "Improving your development environment" section or something like that, where other stuff like commit hooks / mozconfig managers like [1] could also be explained, but that seems premature, at least for now. [1]: https://github.com/emilio/mozconfigs Differential Revision: https://phabricator.services.mozilla.com/D70659 --HG-- extra : moz-landing-system : lando
This commit is contained in:
Родитель
b89bb47353
Коммит
5043703027
|
@ -0,0 +1,60 @@
|
|||
Editor / IDE integration
|
||||
========================
|
||||
|
||||
You can use any editor or IDE to contribute to Firefox, as long as it can edit
|
||||
text files. However, there are some steps specific to mozilla-central that may
|
||||
be useful for a better development experience. This page attempts to document
|
||||
them.
|
||||
|
||||
.. note::
|
||||
|
||||
This page is a work in progress. Please enhance this page with instructions
|
||||
for your favourite editor.
|
||||
|
||||
VIM
|
||||
---
|
||||
|
||||
There's C++ and Rust auto-completion support for VIM via
|
||||
`YouCompleteMe <https://github.com/ycm-core/YouCompleteMe/>`__.
|
||||
|
||||
As long as that is installed and you have run :code:`./mach build` or
|
||||
:code:`./mach configure`, it should work out of the box. Configuration for this lives
|
||||
in :code:`.ycm_extra_conf` at the root of the repo.
|
||||
|
||||
Eclipse
|
||||
-------
|
||||
|
||||
You can generate an Eclipse project by running:
|
||||
|
||||
.. code::
|
||||
|
||||
./mach ide eclipse
|
||||
|
||||
Visual Studio
|
||||
-------------
|
||||
|
||||
You can run a Visual Studio project by running:
|
||||
|
||||
.. code::
|
||||
|
||||
./mach ide visualstudio
|
||||
|
||||
CompileDB back-end / compileflags
|
||||
---------------------------------
|
||||
|
||||
You can generate a :code:`compile_commands.json` in your object directory by
|
||||
running:
|
||||
|
||||
.. code::
|
||||
|
||||
./mach build-backend --backend=CompileDB
|
||||
|
||||
This file is understood by a variety of C++ editors / IDEs to provide
|
||||
auto-completion capabilities. You can also get an individual compile command by
|
||||
running:
|
||||
|
||||
.. code::
|
||||
|
||||
./mach compileflags path/to/file
|
||||
|
||||
This is how the :ref:`VIM <VIM>` integration works, for example.
|
|
@ -9,6 +9,7 @@ source code documentation.
|
|||
:glob:
|
||||
|
||||
how_to_contribute_firefox
|
||||
editor
|
||||
reviews
|
||||
directory_structure
|
||||
|
||||
|
@ -27,4 +28,3 @@ source code documentation.
|
|||
:glob:
|
||||
|
||||
build/*
|
||||
|
||||
|
|
Загрузка…
Ссылка в новой задаче