Skip to main content

Bears for coala (Code Analysis Application)

Project description

                                                     .o88Oo._
                                                    d8P         .ooOO8bo._
                                                    88                  '*Y8bo.
                                      __            YA                      '*Y8b   __
                                    ,dPYb,           YA                        68o68**8Oo.
                                    IP'`Yb            "8D                       *"'    "Y8o
                                    I8  8I             Y8     'YB                       .8D
                                    I8  8P             '8               d8'             8D
                                    I8  8'              8       d8888b          d      AY
     ,gggo,    ,ggggo,    ,gggo,gg  I8 dP    ,gggo,gg   Y,     d888888         d'  _.oP"
    dP"  "Yb  dP"  "Y8go*8P"  "Y8I  I8dP    dP"  "Y8I    q.    Y8888P'        d8
   i8'       i8'    ,8P i8'    ,8I  I8P    i8'    ,8I     "q.  `Y88P'       d8"
  ,d8,_    _,d8,   ,d8' d8,   ,d8b,,d8b,_ ,d8,   ,d8b,       Y           ,o8P
ooP""Y8888PP*"Y8888P"   "Y8888P"`Y88P'"Y88P"Y8888P"`Y8            oooo888P"

About

coala-bears is a Python package containing all the bears that are officially supported by coala. It features more than 65 bears covering 35 languages. Here is a generated list that contains information about each bear, such as the languages it supports and what fixes it can apply to your code.

Languages coala provides algorithms for

C++

Lua

TypeScript

C#

Markdown

VHDL

CMake

Matlab/Octave

Vimscript

CoffeeScript

Natural Language (English)

XML

CSS

Perl

YAML

Dart

PHP

Fortran

Python 2

Go

Python 3

Haskell

R

HTML

reStructured Text

Java

Ruby

JavaScript

Scala

JSP

SCSS

Julia

sh & bash scripts

Latex

SQL

The number of bears grows every day! If you want to see any particular functionality be sure to submit an issue, but please read the Getting Involved section before doing so.

You can read more at our documentation. There you can learn how to easily write bears yourself! Be sure to let us know if you do so, then we’ll be able to include it here and spread the word about it.

Installation

To install coala-bears, you first need Python 3 or higher. If you do not have it, it is recommended that you install Python3 >= 3.4 from here.

Once Python is installed, coala-bears can be installed with pip3 install coala-bears. If you need more information about the installation and dependencies, take a look at our installation documentation.

The latest code from master is automatically deployed to PyPI as a development version. Get it with pip3 install coala-bears --pre.

Be sure to use the latest pip, the default pip from Debian doesn’t support our dependency version number specifiers. You will have to use a virtualenv in this case.

PyPI

Usage

Basic analysis:

echo "print('Hi!') " >> hw.py
coala --files hw.py --bears SpaceConsistencyBear

Finding out what analysis routines exist:

coala -l JavaScript  # Shows bears for JS
coala -A  # Shows all bears
coala -B -b SpaceConsistencyBear  # Shows full bear documentation

If you want to learn more about coala-bears, its functionality and its usage, please take a look at our tutorial.

Authors

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

Getting Involved

If you want to contribute to coala-bears, please take a look at the Getting Involved Information.

We appreciate any help! Join us on one of:

(All channels are linked with gitter. Approach @sils1297 if the link doesn’t work properly.)

Project Status

Linux Build Status Windows Build status

Documentation Status codecov.io

License

AGPL

This code falls under the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Please note that some files or content may be copied from other places. Most of them are GPL compatible. There is a small portion of code in the tests that falls under the Creative Commons license, see https://creativecommons.org/licenses/by-sa/3.0/deed.de for more information.

Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

coala-bears-0.8.0.dev20160724073944.tar.gz (85.2 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file coala-bears-0.8.0.dev20160724073944.tar.gz.

File metadata

File hashes

Hashes for coala-bears-0.8.0.dev20160724073944.tar.gz
Algorithm Hash digest
SHA256 fbebe9d7560455801a41a88c1a11094095b049faf7ba21ca6a76ffc8c4e4d0bb
MD5 06955ffe70814e34fa80de3b7a76f763
BLAKE2b-256 1c16f29a09454ac3eb99967fa4696016a3b3cf9013e856255a42754879e2eaf2

See more details on using hashes here.

Provenance

File details

Details for the file coala_bears-0.8.0.dev20160724073944-py3-none-any.whl.

File metadata

File hashes

Hashes for coala_bears-0.8.0.dev20160724073944-py3-none-any.whl
Algorithm Hash digest
SHA256 e8882b5f93abe8552274790e5b783ebefd66a389d1e524891d32cf369e53d11b
MD5 f1ac537ec7ab5cbd70dd59c348752645
BLAKE2b-256 331adaa9017f4a9fb0acf85a19e3606870eaeb470bf8a5103d798116363b0c4d

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page