使用coala开发多语言外部Bears指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01069/article/details/148575614

使用coala开发多语言外部Bears指南

coala coala provides a unified command-line interface for linting and fixing all your code, regardless of the programming languages you use. 项目地址: https://gitcode.com/gh_mirrors/co/coala

概述

coala是一个强大的静态代码分析框架，它允许开发者使用多种编程语言编写分析规则（称为Bears）。本文将详细介绍如何利用coala的@external_bear_wrap装饰器开发非Python语言的外部Bears。

为什么需要外部Bears

coala的核心优势在于其语言无关性，而外部Bears机制进一步扩展了这一特性：

开发者可以使用自己熟悉的编程语言编写分析规则
能够复用现有的代码分析工具和库
充分发挥各语言在特定领域的优势
便于集成已有工具链

工作原理

外部Bears通过标准输入输出与coala核心交互：

coala通过stdin向外部程序发送JSON格式的分析数据
外部程序执行实际分析逻辑
分析结果通过stdout以JSON格式返回给coala

这种设计使得几乎任何能够处理标准输入输出的语言都可以用来开发Bears。

开发流程

1. 准备工作

在开始前，确保：

已安装coala核心
熟悉基本的Bear开发概念
了解JSON数据格式

2. 使用C++开发Bear示例

我们将创建一个检查"coala"拼写错误的Bear：

2.1 创建项目结构

mkdir coalaCheckBear && cd coalaCheckBear

2.2 生成Bear包装器

使用coala提供的工具生成Python包装代码：

coala-bears-create -ext

按照提示输入：

Bear名称：coalaCheckBear
可执行文件名：coalaCheck_cpp

2.3 实现C++核心逻辑

#include <iostream>
#include <string>
#include "json.hpp"

using json = nlohmann::json;
using namespace std;

json in;
json out;
string origin;

void init_results(string bear_name) {
    origin = bear_name;
    out["results"] = json::array({});
}

void add_result(string message, int line, int column, int severity) {
    json result = {
        {"origin", origin},
        {"message", message},
        {"affected_code", json::array({{
            {"file", in["filename"]},
            {"start", {
                {"column", column},
                {"file", in["filename"]},
                {"line", line}
            }},
            {"end", {
                {"column", column+6},
                {"file", in["filename"]},
                {"line", line}
            }}
        }})},
        {"severity", severity}
    };
    out["results"] += result;
}

int main() {
    cin >> in;
    init_results("coalaCheckBear");
    
    int i = 0;
    for (auto it=in["file"].begin(); it !=in["file"].end(); it++) {
        i++;
        string line = *it;
        size_t found = line.find("Coala");
        while (found != string::npos) {
            add_result("Did you mean 'coala'?", i, found, 2);
            found = line.find("Coala", found+1);
        }
    }
    
    cout << out;
    return 0;
}

2.4 编译与测试

创建Makefile：

build: coalaCheck.cpp
    g++ -std=c++11 -o coalaCheck_cpp coalaCheck.cpp

编译并测试：

make build
export PATH=$PATH:$PWD
coala -d . -b coalaCheckBear -f testfile

3. 使用JavaScript开发Bear示例

对于脚本语言，需要指定解释器路径：

3.1 生成包装器

coala-bears-create -ext

指定：

可执行文件：node
Bear名称：coalaCheckBear

3.2 修改包装器

@external_bear_wrap(executable='node',
                   settings={})
class coalaCheckBear:
    @staticmethod
    def create_arguments():
        return ('coalaCheck.js',)

3.3 实现JavaScript核心

var input = "";
var out = {};
var origin;

// 初始化输出
init_results = (bear_name) => {
    origin = bear_name;
    out["results"] = [];
};

// 添加结果
add_result = (message, line, column, severity) => {
    var result = {
        "origin": origin,
        "message": message,
        "affected_code": [{
            "file": input["filename"],
            "start": {
                "column": column,
                "file": input["filename"],
                "line": line
            },
            "end": {
                "column": column+6,
                "file": input["filename"],
                "line": line
            }
        }],
        "severity": severity
    };
    out["results"].push(result)
};

// 处理输入
process.stdin.on('end', () => {
    input = JSON.parse(input);
    init_results("coalaCheckBear");
    for (i in input["file"]) {
        var line = input["file"][i];
        var found = line.indexOf("Coala");
        while (found != -1) {
            add_result("Did you mean 'coala'?",
                       parseInt(i)+1, found+1, 2);
            found = line.indexOf("Coala", found+1)
        }
    }
    console.log(JSON.stringify(out));
});

3.4 测试Bear

coala -d . -b coalaCheckBear -f testfile

JSON数据规范

输入数据格式

| 字段 | 类型 | 描述 | |----------|--------|--------------------| | filename | string | 被分析的文件名 | | file | array | 文件内容(行数组) | | settings | object | 用户配置参数 |

输出数据格式

| 字段路径 | 类型 | 描述 | |-------------------------|--------|--------------------------| | results | array | 结果数组 | | results[].origin | string | Bear名称 | | results[].message | string | 显示给用户的消息 | | results[].affected_code | array | 受影响的代码范围数组 | | results[].severity | number | 问题严重程度(1-3) |