GithubHelp home page GithubHelp logo

anishhota / coala-quickstart Goto Github PK

View Code? Open in Web Editor NEW

This project forked from coala/coala-quickstart

0.0 2.0 0.0 160 KB

A tool that generates an initial coala config lightning fast for you!

License: GNU Affero General Public License v3.0

Shell 0.20% Batchfile 0.93% Python 98.87%

coala-quickstart's Introduction

https://cloud.githubusercontent.com/assets/7521600/19196124/e6ea06dc-8cd1-11e6-84a8-c51c899a1f36.png

coala-quickstart: personalized coala setup for your project

coala-quickstart is a tool that helps users to quickly get started with coala. It can generate a .coafile ( coala's configuration file) that is tailored to your project. This supports projects in several languages, including popular languages such as C/C++, Python, JavaScript, CSS, Java.

Please note that you will want to manually adapt the configuration to your needs!



Features

  • Out-of-the-box support for projects using various popular languages, such as C/C++, Python, Javascript, CSS, Java and many others with built-in check routines.
  • Automatic identification of relevant bears for your project based on the languages used.
  • A clean and simple interface with a well defined flow.

Installation

To install the latest stable version run:

$ pip3 install coala-quickstart

Stable

To install the latest development version run:

$ pip3 install coala-quickstart --pre

The latest code from the master branch is automatically deployed as the development version in PyPI.

PyPI Windows Linux


Usage

coala-quickstart is designed with ease of use and simplicity in mind. To get started, simply run:

$ coala-quickstart

This should prompt you for the project directory. If you want to use the current directory, just press the return key and we'll be on our way!

At the end, you should have a file named .coafile generated at the root of your project directory. This contains all the settings needed by coala to lint and fix your code.

When this is done, simply fire up coala from your project's root directory:

$ coala

You can also open the .coafile in your favorite editor and edit the settings to suit your needs. Check out our coafile specification to learn more.


Support

Feel free to contact us at our Gitter channel, we'd be happy to help!

You can also drop an email at our mailing list.


Authors

coala-quickstart is maintained by a growing community. Please take a look at the meta information in setup.py for the current maintainers.


License

AGPL

coala-quickstart's People

Contributors

adrianzatreanu avatar adtac avatar andreidinu avatar andreiraduta11 avatar divya063 avatar guesswhosamfoo avatar hemangsk avatar illdepence avatar jayvdb avatar laxmena avatar marian-ald avatar mohitkyadav avatar namanyadav12 avatar nvzard avatar paniabhisek avatar plentymore avatar redridge avatar satwikkansal avatar seeeturtle avatar sils avatar supergr35 avatar vamshi99 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.