# errorcode-generator

**Repository Path**: riag/errorcode-generator

## Basic Information

- **Project Name**: errorcode-generator
- **Description**: 根据 json 里定义的错误码生成其他格式的文本，如 Markdown 格式文本
定义一份错误码，生成多种格式的文件
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-04-30
- **Last Updated**: 2025-08-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# errorcode-generator

  在 json 文件里定义好错误码相关信息, 根据 jinja2 模板文件来生成相应的错误代码文件或者文档

## 安装

```
pip3 install errorcode-generator
```

## 使用

  `example` 目录里有 2 个简单的例子，可以参考, 下面演示怎么使用

  ```
  errorcode-generator example/simple/errorcodes.json
  ```

  上面例子是根据错误码 json 文件来生成 markdown 表格格式错误码

  ```
  errorcode-generator example/simple/errorcodes.json --tpl example/simple/tpl.kt
  ```

  上面例子是根据 jinja2 模板文件和错误码 json 文件来生成具体的内容


### 参数

  ```
  -t, --type            使用内置的模板生成具体内容，支持 markdown, asciidoc, rst
  --tpl                 使用 jinja2 模板文件
  --out                 生成的内容要写到的文件, 不指定就输出到控制台
  ```

## json 错误码格式

  每个 json 文件里是一个列表，每一项里支持的字段如下:
  
  ```
    code:       错误码代码
    name:       错误码变量名
    comment:    错误码描述或者注释
    include:    包含其他 json 文件
  ```

   例子如下:
  ```
    [
      {
        "comment": "正确",
        "name": "SUCC_CODE",
        "code": "0"
      },
      {
        "comment": ""
      },
      {
        "comment": "服务器异常",
        "name": "SERVER_ERROR",
        "code": "100"
      },
      {
        "comment": "缺少参数",
        "name": "MISSING_ARG_ERROR",
        "code": "101"
      },
      {
        "comment": "校验参数失败",
        "name": "VALIDATE_ARG_ERROR",
        "code": "102"
      },
      {
        "comment": ""
      }
    ]
  ```

  具体的使用可以参考 `example/multifile/errorcodes.json`