coala-语言独立且易于扩展的代码分析应用python库

Coala提供了一个统一的接口,用于使用单个配置文件来整理和修复代码,而与所使用的编程语言无关。您可以在自己喜欢的编辑器中使用Coala,将其与CI集成,以JSON格式获取结果,或者使用其灵活的配置语法根据需要对其进行自定义。

Coala支持流行的编程语言,包括Python,C / C ++,Java,JavaScript,CSS以及其他几种现成的语言。

安装coala

只需安装coala

如果发生任何依赖错误,请使用virtualenv!

有关完整的安装文档,请检查 coala.io/install

为了使用COALA,你应该有 Python的> = 3.4和 PIP> = 8安装

现在只需通过以下方式下载安装coala

$ pip3 install Coala-bears

您可以附加--pre到该命令以直接从master获得最新的预发行版!

考虑使用virtualenv:

$ pip3 install virtualenv

$ virtualenv venv        # On Linux

$ venv\scripts\activate  # On Windows

开始使用

有两种方法可以让Coala知道它应该对哪种代码执行哪种分析。

命令行接口

为了指定要分析的文件,可以使用--files Coala的参数,如下所示。对于所有文件路径,您可以指定(递归)glob。

因为分析例程可以完成许多不同的事情,所以我们将它们命名为 bears 。bears 可以检查您的代码中是否存在潜在问题,计算指标,甚至为您的代码提供更正。

您可以使用以下--bears 参数指定要让其运行的bears :

cd coala-tutorial

coala --files=src/\*.c --bears=SpaceConsistencyBear --save

示例

$ echo "import osprint( 'Hello World' )" > hello.py$ coala --files hello.py --bears PEP8Bear,PyUnusedCodeBearExecuting section Default...hello.py|   1| import·os|    | [NORMAL] PyUnusedCodeBear:|    | This file contains unused source code.|----|    | /home/user/hello/hello.py|    |++++| /home/user/hello/hello.py|   1|    |-import os|   2|   1||   3|   2| print( 'Hello World' )|   4|   3||    | *0: Do nothing|    |  1: Open file(s)|    |  2: Apply patch|    |  3: Add ignore comment|    | Enter number (Ctrl-D to exit): hello.py|   3| print(·'Hello·World'·)|   4||    | [NORMAL] PEP8Bear:|    | The code does not comply to PEP8.|----|    | /home/user/hello/hello.py|    |++++| /home/user/hello/hello.py|   1|   1| import os|   2|   2||   3|    |-print( 'Hello World' )|   4|    |-|    |   3|+print('Hello World')|    | *0: Do nothing|    |  1: Open file(s)|    |  2: Apply patch|    |  3: Add ignore comment|    | Enter number (Ctrl-D to exit): 1 $
(0)

相关推荐