|
| 1 | +Using coala-quickstart to Generate a coala Configuration File |
| 2 | +============================================================= |
| 3 | + |
| 4 | +This document aims to make people aware of coala-quickstart by providing a |
| 5 | +brief introduction about its features and how to quickly generate |
| 6 | +coala configuration files for your projects. |
| 7 | + |
| 8 | +What is coala-quickstart? |
| 9 | +------------------------- |
| 10 | + |
| 11 | +coala-quickstart is a CLI tool that helps users to quickly get started with |
| 12 | +coala by generating a ``.coafile`` tailored for their project. The ``.coafile`` |
| 13 | +is generated based on the questions answered by the users about their project. |
| 14 | + |
| 15 | +Features |
| 16 | +-------- |
| 17 | + |
| 18 | +coala-quickstart offers the following features: |
| 19 | + |
| 20 | +- Out-of-the-box support for projects using various popular languages such as |
| 21 | + C/C++, Python, JavaScript and many more with built-in check routines. |
| 22 | +- Automatic detection of languages used in your project. |
| 23 | +- Automatic identification of bears that might be relevant for your project and |
| 24 | + detection of bear settings based on the languages used. |
| 25 | +- A clean and simple interface with a well defined flow. |
| 26 | + |
| 27 | +Installation |
| 28 | +------------ |
| 29 | + |
| 30 | +To install the latest stable version run: |
| 31 | + |
| 32 | +:: |
| 33 | + |
| 34 | + $ pip3 install coala-quickstart |
| 35 | + |
| 36 | +To install the latest development version run: |
| 37 | + |
| 38 | +:: |
| 39 | + |
| 40 | + $ git clone https://github.com/coala/coala-quickstart.git |
| 41 | + $ cd coala-quickstart |
| 42 | + $ pip3 install . |
| 43 | + |
| 44 | +Usage |
| 45 | +----- |
| 46 | + |
| 47 | +To get started simply run: |
| 48 | + |
| 49 | +:: |
| 50 | + |
| 51 | + $ coala-quickstart |
| 52 | + |
| 53 | +This should prompt you for your project's directory. If you want to use your |
| 54 | +current directory, just press the return key. |
| 55 | + |
| 56 | +It will detect the languages used in your project and provide a percentage |
| 57 | +distribution of those languages in your project. You will now be presented |
| 58 | +with a list of bears that might be relevant to your project to choose from. |
| 59 | +Once you choose your bears you are done. |
| 60 | + |
| 61 | +At the end, you should have a file named ``.coafile`` generated at the root of |
| 62 | +your project directory. This contains all the settings needed by coala to lint |
| 63 | +and fix your code. You can also open the .coafile in your favorite editor and |
| 64 | +edit the settings to suit your needs. |
| 65 | + |
| 66 | +Once you have completed these steps just execute coala from your project's |
| 67 | +root: |
| 68 | + |
| 69 | +:: |
| 70 | + |
| 71 | + $ coala |
0 commit comments