json-include 0.1.4

语法

json-include支持JSON中的扩展语法，称为包含语法，格式如下

{
    "...": "<json file name>"
}

包含语法意味着JSON中的此对象（整个{"...": "<json file name>"}）是对名为<json file name>的JSON文件的引用，应包含到其位置。

包含的JSON始终应该是对象（字典）而不是数组（列表），以防止隐含的意义并确保我们可以清楚地了解结构，而无需查看包含的JSON文件。

在正常的JSON中，当我们想在属性上包含另一个JSON时，应如下编写

{
    "username": "alice",
    "profile": {
        "...": "<profile_model.json>"
    }
}

在这个JSON中，一个profile_model.json被包含以展示profile属性，如果profile_model.json的内容如下

{
    "age": 18,
    "gender": "female"
}

那么我们通过包含语法的含义是，当此JSON被用作正常JSON时，应被视为

{
    "username": "alice",
    "profile": {
        "age": 18,
        "gender": "female"
    }
}

要将包含语法的JSON转换为正常JSON，需要一个构建过程，这就是实现所做的事情。

Python实现

实现可以是任何语言，只要它可以理解包含语法并按预期输出，这个存储库包含一个Python实现以供使用。

pip install json-include

usage: json-include [-h] DIR FILE

Command line tool to build JSON file by include syntax.

positional arguments:
  DIR         The directory path of source json files
  FILE        The name of the source json file

optional arguments:
  -h, --help  show this help message and exit

json-include test/source_json/ c.json

待办事项

• [ ] 防止循环引用

• [ ] 测试循环引用

• [ ] 测试无效语法