coala / coala-bears

Bears for coala

coala-bears

coala-bears is a Python package containing all the bears that are officially supported by coala. It features more than 78 bears covering 54 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.

---

• Installation
• Languages Supported
• Usage
• Getting Involved
• Support
• Authors
• License

---

Installation

To install the latest stable version, run:

$ pip3 install coala-bears

To install the latest development version, run:

$ pip3 install coala-bears --pre

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

To also install all bears for coala at once, run:

$ pip3 install coala-bears

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

|Linux|

---

Languages Supported

To see what coala can do for your language, run:

$ coala --show-bears --filter-by-language Python

Languages coala provides algorithms for
C	Latex	SQL
C++	Lua	Stylus
C#	Markdown	Swift
CMake	Matlab/Octave	TypeScript
CoffeeScript	Natural Language (English)	Verilog
CSS	Perl	VHDL
Dart	PHP	Vimscript
Fortran	Python 2	XML
Go	Python 3	YAML
Haskell	R
HTML	reStructured Text
Java	Ruby
JavaScript	Scala
JSP	SCSS
Julia	sh & bash scripts

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, so we'll be able to include it here and spread the word about it.

---

Usage

For more information about how to do basic analysis, check out the coala README.

---

Getting Involved

If you would like to be a part of the coala community, you can check out our Getting In Touch page or ask us at our active Gitter channel, where we have maintainers from all over the world. We appreciate any help!

We also have a Newcomers' Guide to help you get started by fixing an issue yourself! If you get stuck anywhere or need some help, feel free to contact us on Gitter or drop a mail at our newcomer mailing list.

---

Support

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

If you are interested in commercial support, please contact us on the Gitter channel as well.

You can also drop an email at our mailing list.

---

Authors

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

---

License

coala-bears's Issues

Move bears here

all bears should be moved into this repository, ideally todayish

Clone Decection: Make variable/constatn/function a property of the CVs

From @sils1297 on July 24, 2015 14:10

Copied from original issue: coala/coala#867

shellcheck bear

From @sils1297 on February 18, 2016 0:45

https://github.com/koalaman/shellcheck

Copied from original issue: coala/coala#1564

Add rultor

@sils1297 could you please do this ?

Bear: Check for broken links

From @AbdealiJK on February 10, 2016 16:25

Owing to the numerous broken links we have coala/coala#1383 coala/coala#1350 it would be really awesome if we could make a bear which tests whether a markdown or rst file has any broken links

We could simply use the URL regex which will be able to give us a lost of links. After which we simply test that each link gives a 200 HTTP code ?
We can skip this test if the bear is unable to find google (or some well known site) because they test runner may not have internet connection.

Copied from original issue: coala/coala#1396

DocumentationFormatBear

From @Makman2 on December 16, 2015 23:34

The documentation extraction routines are ready now, what needs to be done next:

1. documentation parsing machinery:
   This should work with regexes or similar. Also this shall be configured for each language inside a coafile!
2. documentation reassembling:
   Shouldn't be problematic using the current DocumentationComment class. Just a nice function like assemble_documentation_comment/similar.
3. The actual DocumentationFormatBear

• extract documentation from given source code
• parse it
• check it against the user defined style/regex
• for patching: reassemble the wanted documentation comment

See #919.

Copied from original issue: coala/coala#1140

Naming scheme for test classes using verify_local_bear

From @AbdealiJK on February 17, 2016 19:58

The naming of classes and functions in tests should be normalized.
Specially those using verify_local_bear where the names are as bad as ProseLintBear1Test, ProseLintBear2Test, etc

Copied from original issue: coala/coala#1560

Detect messy code in PHP

From @sils1297 on February 17, 2016 15:37

https://github.com/phpmd/phpmd

either that can be used directly or the lib it uses.

Copied from original issue: coala/coala#1555

Julia bear integration

From @sudheesh001 on February 14, 2016 18:57

Julia is a high-level, high-performance dynamic programming language for technical computing, with syntax that is familiar to users of other technical computing environments.

It looks like there's a linter available here https://github.com/tonyhffong/Lint.jl

Copied from original issue: coala/coala#1482

XML Bear

From @sils1297 on February 7, 2016 16:8

apparently I did coala/coala@20fdbd8 not sure how good this is reusable

Copied from original issue: coala/coala#1309

Add rust-clippy bear for rust support

From @sudheesh001 on February 8, 2016 19:19

Rust clippy is one of the linters for rustc the Rust programming language.
https://github.com/Manishearth/rust-clippy#usage

It gives the linter warning in the following format

src/main.rs:8:5: 11:6 warning: you seem to be trying to use match for destructuring a single type. Consider using `if let`, #[warn(single_match)] on by default
src/main.rs:8     match x {
src/main.rs:9         Some(y) => println!("{:?}", y),
src/main.rs:10         _ => ()
src/main.rs:11     }
src/main.rs:8:5: 11:6 help: Try
if let Some(y) = x { println!("{:?}", y) }

Copied from original issue: coala/coala#1324

Make coala-bears PyPI package

@AbdealiJK needs to get me at least a basic setup.py, then I can register a PyPI package and solve #3

Make each bear an own PyPI package

Puppet Bear for linting puppet files

From @sudheesh001 on February 14, 2016 18:49

bears/configfiles
difficulty/low

https://github.com/rodjek/puppet-lint

Copied from original issue: coala/coala#1480

Make LocalBearTestHelper robust

From @AbdealiJK on December 8, 2015 13:31

Currently, LocalBearTestHelper simply checks if there are results that are yielded or not.
Would be considerably better is we give it a list of line, cols where the result should yield in a given file.

Copied from original issue: coala/coala#1111

PyImportSortBear add more args

From @AbdealiJK on February 10, 2016 20:42

https://github.com/timothycrosley/isort/wiki/isort-Settings

known first and third party imports needs to be added to PyImportSortBear

Copied from original issue: coala/coala#1403

Add errcheck bear for Go

From @sudheesh001 on February 9, 2016 5:44

Following up with #1267
Breaking that issue into smaller bugs as recommended by @sils1297 for indiahacks

http://dominik.honnef.co/posts/2014/12/an_incomplete_list_of_go_tools/

Copied from original issue: coala/coala#1335

set up requires.io correctly

From @sils1297 on February 11, 2016 17:24

doesn't seem to work

Copied from original issue: coala/coala#1421

clang doesn't find stddef.h

From @sils1297 on December 3, 2015 14:2

A bug related to all clang bears.

https://stackoverflow.com/questions/19642590/libtooling-cant-find-stddef-h-nor-other-headers/23314921#23314921

Copied from original issue: coala/coala#1104

InvalidLinkBear: Don't include trailing | in URL

We shouldn't do that because rst uses this style for links: |http://url/| and the last | is matched by the current regex.

CSSCombBear

From @sils1297 on February 10, 2016 16:29

http://csscomb.com

Copied from original issue: coala/coala#1398

GoVetBear - skip condition invalid

From @AbdealiJK on February 9, 2016 3:20

I have ubuntu 14.04 and was trying to get all the tests in coala to work for me.
I noticed that GoVetBearTest kept failing and found out that in GoVet the skip condition is set to go.
This is not right because that isn't the correct thing to check. I had go installed but not go vet.

I had to install golang-go.tools to get the vet package in go.

Copied from original issue: coala/coala#1329

RadonBear throws exceptions

From @sils1297 on February 18, 2016 14:10

[DEBUG][15:10:00] The bear RadonBear raised an exception. If you are the writer of this bear, please make sure to catch all exceptions. If not and this error annoys you, you might want to get in contact with the writer of this bear.

Traceback information is provided below:

Traceback (most recent call last):
  File "/home/lasse/prog/coala/coalib/bears/Bear.py", line 97, in execute
    return list(self.run_bear_from_section(args, kwargs) or [])
  File "/home/lasse/prog/coala/coalib/misc/../../bears/python/RadonBear.py", line 42, in run
    filename, visitor.lineno, visitor.col_offset, visitor.endline)
  File "/home/lasse/prog/coala/coalib/results/SourceRange.py", line 43, in from_values
    return cls(start, end)
  File "/home/lasse/prog/coala/coalib/misc/Decorators.py", line 298, in decorated
    return function(*args, **kwargs)
  File "/home/lasse/prog/coala/coalib/results/SourceRange.py", line 25, in __init__
    TextRange.__init__(self, start, end)
  File "/home/lasse/prog/coala/coalib/misc/Decorators.py", line 298, in decorated
    return function(*args, **kwargs)
  File "/home/lasse/prog/coala/coalib/results/TextRange.py", line 33, in __init__
    raise ValueError("End position can't be less than start position.")
ValueError: End position can't be less than start position.

Copied from original issue: coala/coala#1578

ESLint Bear

From @sils1297 on February 10, 2016 17:2

http://eslint.org/docs/user-guide/formatters/#json

The json output even contains fixes - let's take this it's awesome.

Copied from original issue: coala/coala#1399

Cleanup GoReturnsBearTest by removing unnecessary information

From @sudheesh001 on February 15, 2016 19:48

the GoReturnsBearTest contains the following which needs to be removed

a = ['import "errors"', '',
     'func F() (*MyType, int, error) { return nil, 0, errors.New("foo") }']
b = ['package main', '', 'import "os"', '',
     'func main() {', '\tf, _ := os.Open("foo")', '}']

Put the good_files in the same line like the bad_files

(good_file1,
     good_file2,),
    (bad_file1, bad_file2,))

Also correct GoReturnsBear's run() documentation to show using goreturns instead of using gofmt

difficulty/newcomer

Copied from original issue: coala/coala#1516

indentation bear

From @sils1297 on February 5, 2015 16:43

shouldn't be that complex, usually you only have to look at brackets (and strings and commits because you should ignore brackets there.) and colons or so. I think we can do a pretty generic algorithm for that.

Copied from original issue: coala/coala#225

RadonBear throws exceptions

From @sils1297 on February 18, 2016 14:10

[DEBUG][15:10:00] The bear RadonBear raised an exception. If you are the writer of this bear, please make sure to catch all exceptions. If not and this error annoys you, you might want to get in contact with the writer of this bear.

Traceback information is provided below:

Traceback (most recent call last):
  File "/home/lasse/prog/coala/coalib/bears/Bear.py", line 97, in execute
    return list(self.run_bear_from_section(args, kwargs) or [])
  File "/home/lasse/prog/coala/coalib/misc/../../bears/python/RadonBear.py", line 42, in run
    filename, visitor.lineno, visitor.col_offset, visitor.endline)
  File "/home/lasse/prog/coala/coalib/results/SourceRange.py", line 43, in from_values
    return cls(start, end)
  File "/home/lasse/prog/coala/coalib/misc/Decorators.py", line 298, in decorated
    return function(*args, **kwargs)
  File "/home/lasse/prog/coala/coalib/results/SourceRange.py", line 25, in __init__
    TextRange.__init__(self, start, end)
  File "/home/lasse/prog/coala/coalib/misc/Decorators.py", line 298, in decorated
    return function(*args, **kwargs)
  File "/home/lasse/prog/coala/coalib/results/TextRange.py", line 33, in __init__
    raise ValueError("End position can't be less than start position.")
ValueError: End position can't be less than start position.

Copied from original issue: coala/coala#1578

Move bear related issues to this repository

after the move

Add a README

hlint for haskell

From @sils1297 on February 18, 2016 0:49

this one suggests fixes sometimes with hints, awesome!

Copied from original issue: coala/coala#1565

Add OSX and Windows (Travis, Appveyor)

annotation bear

From @sils1297 on November 13, 2015 13:28

a bear that takes the language definition and annotates each line with simple properties like "from here to there is a comment", "from here to there is a string" and so on. This is intended to be used by other bears for simpler analysis functionality

Copied from original issue: coala/coala#1040

Move test dir to root level

difficulty/low

Use golang dependency manager to go get the dependencies

From @sudheesh001 on February 15, 2016 13:10

Similar to how we have requirements.txt for pip and package.json for npm we can also have a file holding the dependencies for golang

Copied from original issue: coala/coala#1501

ClangCodeCloneDetectionBear: Add switch/case support

From @sils1297 on June 11, 2015 18:40

Counting conditions for clang currently ignore that which is bad.

Copied from original issue: coala/coala#652

JSONFormatBear: Parse exception message

From @sils1297 on December 13, 2015 13:31

Would be a nice feature to show line and column automatically, instead of having it in the message:

This file does not contain parsable JSON. 'Expecting property name enclosed in double quotes: line 2 column 7 (char 8)'

Copied from original issue: coala/coala#1130

InvalidLinkBear: Show URL that doesn't work

This way the user can check if it even matched it right or it's a bug.

PyLintBear: Use checker/rule as origin

From @sils1297 on February 11, 2016 13:19

this way the user can even ignore one pylint rule individually.

If a newcomer wants to do this please ask us, this description isn't the best one... or just look in Lint.py and CheckstyleBear.py which actually does this.

Copied from original issue: coala/coala#1408

Add issue labels

We at least want the difficulty labels and some others to categorize issues in this repository. @AbdealiJK can you do that?

setup.py downloads possibly evil file via unsecured connection

From @sils1297 on February 11, 2016 13:40

I got this comment on my blog recently:

Interesting project! Just one minor issue: Why has setup.py code in it to download a jar file? What is supposed to be in the file? If it is free software, why not use its source code and compile it? Why download it over unsecured HTTP? Is the content not relevant? Thanks!

And I think we should think about that. We're downloading checkstyle.jar there which shouldn't be evil. Compiling it from source though sounds like to be avoided IMO.

Copied from original issue: coala/coala#1410

feature: Make PyLintBear global

From @sils1297 on July 6, 2015 12:44

Shouldn't be that hard actually, add {file} to the msg pattern and parse it. Attention: that msg pattern may contain any signs dependent on the platform, so we probably want some multi-char delimiter like PYLINT_PATH_DELIM for seperating it from the rest, anyone using a PYLINT_PATH_DELIM in his path is hereby declared stupid and coala-hostile :)

Copied from original issue: coala/coala#735

InferBear

From @sils1297 on February 9, 2016 23:23

http://fbinfer.com/ - works on Objective-C, Java, or C code and seems to do quite some cool stuff. I'm not sure where we want to put it as it doesn't really belong in one of the language folders, maybe in the c_languages...

This is a simple wrapper if infer is done properly it should be simple to do.

Copied from original issue: coala/coala#1364

Code Duplication Bear

From @sils1297 on December 22, 2015 13:32

Would be nice to have a code duplication bear for other languages than C. https://github.com/codeclimate/codeclimate-duplication provides that for some languages, would be awesome to integrate with that.

Copied from original issue: coala/coala#1158

SwiftLint for Swift

we can use https://github.com/realm/SwiftLint

German sample in LanguageToolBearTest isn't good german

From @sils1297 on February 14, 2016 16:57

A german newcomer will probably get that right easily :)

difficulty/newcomer
area/bears
type/test

Copied from original issue: coala/coala#1473

Appveyor not installing go dependencies

From @AbdealiJK on February 15, 2016 13:50

https://ci.appveyor.com/project/sils1297/coala/build/1.0.3270

Says:

go get -u github.com/golang/lint/golint
package github.com/golang/lint/golint: directory "c:\\gopath\\src\\github.com\\golang\\lint\\golint" is not using a known version control system

Copied from original issue: coala/coala#1503

checkstyle.jar: Download it as requirement-install-step

From @Makman2 on February 13, 2016 22:33

I would propose for a clean requirement-install-handling to populate ./setup.py with two new commands, e.g. install-test-requirements and install-requirements. These two commands shall do the pip install via pip3 install -r requirements.txt (or test-requirements.txt) and also allows to handle custom install steps like the checkstyle.jar download.

This also needs adaption inside the docs and CI-scripts!

Copied from original issue: coala/coala#1465

bug: PHPLintBearTest.test_run fails on test

From @aayn on February 19, 2016 13:58

All other tests pass. Only this one fails.

Steps to reproduce

1. Run py.test.

Actual results

Expected results

Test should pass.

Additional info

Output to some commands:

/cc @AbdealiJK

Copied from original issue: coala/coala#1592

Bear for R

From @AbdealiJK on February 16, 2016 12:45

We can use lintr - https://github.com/jimhester/lintr

Copied from original issue: coala/coala#1534

Add circleci, codecov and rultor

Add circleci, rultor and codecov

• Circleci needs to be enabled on their website
• Codecov needs to be enabled (maybe also ass a secret token on circleci?)
• Add pypi pushing in rultor - Needs that secret key thing to be done