Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/niosus/EasyClangComplete

:boom: Robust C/C++ code completion for Sublime Text 3/4
https://github.com/niosus/EasyClangComplete

auto-complete c clang cmake code-completion compilation-database compile cplusplus cpp libclang plugin sublime-text sublime-text-3 sublime-text-4

Last synced: about 2 months ago
JSON representation

:boom: Robust C/C++ code completion for Sublime Text 3/4

Awesome Lists containing this project

README 

        
# EasyClangComplete #



Plugin for Sublime Text 3 for easy to use, out of the box autocompletions for

C, C++, Objective-C, and Objective-C++.



![Example](docs/img/AutoComplete.gif)



[![Documentation][img-docs]][docs]

[![Release][img-release]][release]

[![Downloads Month][img-downloads]][downloads]

[![GitHub build][img-github-actions]][github-actions]

[![Coverage Badge][img-coverage]][coverage]

[![Donate][img-paypal]][donate-paypal]

[![OpenCollective Backers][img-open-backers]][opencollective]



# Simple start in just 3 steps! #



## 1. Install this plugin ##

- In Sublime Text press CTRL+Shift+P and

  install **EasyClangComplete** using [Package Control](https://packagecontrol.io/installation).



## 2. Install clang ##

- **Ubuntu**        : `sudo apt-get install clang`

- **OSX**           : ships `clang` by default. You are all set!

- **Windows**       : install the latest release from clang website.

- **Other Systems** : use your package manager or install from clang website.

- clang website: http://llvm.org/releases/download.html



## 3. Configure your compiler flags and include folders ##



#### Do you use CMake?

You're in luck! The plugin will run cmake on a proper `CMakeLists.txt` in your

project folder and will use information from it to complete your code out of

the box! For more details, read the plugin

[docs](https://niosus.github.io/EasyClangComplete/configs/#using-cmake-recommended)

about CMake.



#### Bazel? (Linux and MacOS only)

If you use Bazel, you can run a command `Generate compilation database` that is shipped with this plugin, which will generate a `compile_commands.json` in the source folder of your project. The plugin will take it from there. 



#### Don't like CMake or Bazel?

Don't worry! There are plenty of ways to configure the plugin! Read the

[related documentation](https://niosus.github.io/EasyClangComplete/configs/)

for more info!



## [Extensive documentation](https://niosus.github.io/EasyClangComplete/)

There are so many things I want to tell you! There is so much the plugin is

capable of! Read the [docs](https://niosus.github.io/EasyClangComplete/) to get

started!



## [Contribute to the project](.github/CONTRIBUTING.md)

This project exists thanks to all the people who contribute. Feel free to open

an issue if something is not clear or a PR if you want to implement some

missing functionality or fix a bug. Check out the contribution

[guide](.github/CONTRIBUTING.md) for that.



## [**Support this project!**](https://niosus.github.io/EasyClangComplete/support/)



  




                         ╔═╗┌─┐┌─┐┬ ┬  ╔═╗┬  ┌─┐┌┐┌┌─┐  ╔═╗┌─┐┌┬┐┌─┐┬  ┌─┐┌┬┐┌─┐

                         ║╣ ├─┤└─┐└┬┘  ║  │  ├─┤││││ ┬  ║  │ ││││├─┘│  ├┤  │ ├┤

                         ╚═╝┴ ┴└─┘ ┴   ╚═╝┴─┘┴ ┴┘└┘└─┘  ╚═╝└─┘┴ ┴┴  ┴─┘└─┘ ┴ └─┘



[release]: https://github.com/niosus/EasyClangComplete/releases

[downloads]: https://packagecontrol.io/packages/EasyClangComplete

[github-actions]: https://github.com/niosus/EasyClangComplete/actions

[coverage]: https://app.codecov.io/gh/niosus/EasyClangComplete/branch/master

[gitter]: https://gitter.im/niosus/EasyClangComplete?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge

[donate-paypal]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=2QLY7J4Q944HS

[donate-flattr]: https://flattr.com/submit/auto?user_id=niosus&url=https://github.com/niosus/EasyClangComplete&title=EasyClangComplete&language=Python&tags=github&category=software

[libclang-issue]: https://github.com/niosus/EasyClangComplete/issues/88

[cmake-issue]: https://github.com/niosus/EasyClangComplete/issues/19

[bountysource-link]: https://www.bountysource.com/teams/easyclangcomplete

[beerpay]: https://beerpay.io/niosus/EasyClangComplete

[gratipay]: https://gratipay.com/EasyClangComplete/

[maintainerd]: https://github.com/divmain/maintainerd

[docs]: https://niosus.github.io/EasyClangComplete/

[opencollective]: https://opencollective.com/easyclangcomplete/#contributors



[img-gratipay]: https://img.shields.io/gratipay/user/niosus.svg?style=flat-square

[img-beerpay]: https://beerpay.io/niosus/EasyClangComplete/badge.svg?style=flat-square

[img-bountysource]: https://img.shields.io/bountysource/team/easyclangcomplete/activity.svg?style=flat-square

[img-github-actions]: https://img.shields.io/github/workflow/status/niosus/EasyClangComplete/test?style=flat-square

[img-coverage]: https://img.shields.io/codecov/c/gh/niosus/EasyClangComplete?style=flat-square&token=KJ8IuinGs1

[img-release]: https://img.shields.io/github/release/niosus/EasyClangComplete.svg?style=flat-square

[img-downloads]: https://img.shields.io/packagecontrol/dt/EasyClangComplete.svg?maxAge=3600&style=flat-square

[img-downloads-month]: https://img.shields.io/packagecontrol/dm/EasyClangComplete.svg?maxAge=2592000&style=flat-square

[img-subl]: https://img.shields.io/badge/Sublime%20Text-3-green.svg?style=flat-square

[img-mit]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square

[img-paypal]: https://img.shields.io/badge/Donate-PayPal-blue.svg?style=flat-square

[img-flattr]: https://img.shields.io/badge/Donate-Flattr-blue.svg?style=flat-square

[img-gitter]: https://badges.gitter.im/niosus/EasyClangComplete.svg?style=flat-square

[img-docs]: https://img.shields.io/badge/docs-ready-brightgreen.svg?longCache=true&style=flat-square

[img-open-backers]: https://opencollective.com/easyclangcomplete/backers/badge.svg?style=flat-square

[img-open-sponsors]: https://opencollective.com/easyclangcomplete/sponsors/badge.svg?style=flat-square