没有项目描述
jmatch的Python项目详细描述
jMatch
jmatch是一个testsuite用于JSON/YAML
文件。它允许你检查这些
基于定义模式的规范的文件。如果你
需要检查很多json文件,或者如果您想在
持续集成管道。
目录
安装
通过PIP安装
确保安装了python3
和pip
。使用pip
安装jMatch
在您的壳中如下:
pip install jmatch
用法
一旦安装了jmatch,它就用来检查JSON/YAML
文档
根据预先定义的规范。jmatch使用JSON/YAML
来定义
作为搜索模式的规范选项。
规范模式示例
example用例:想象一下,一堆json格式的配置文件,所有这些 配置文件应该指定相同的文本编码(utf-8),以确保 所有系统都能正确地互操作。
解决方案:要实现给定用例的解决方案,另一个 需要指定json文档,其中至少包含以下数据 关于给定的问题。
- 类型:
info
或error
- 消息:如果模式匹配,则打印消息
- 模式:在文档中搜索以检查的信息或错误案例模式。
[{"_type":"error","_message":"The encoding should be UTF-8, but it is not.","_pattern":{"encoding":{"_not":"UTF-8"}}}]
我们要将问题标记为关键问题,我们使用错误类型。如果用于
ci管道,类型error
强制管道失败,如果模式
比赛。对于我们要搜索的编码模式,使用一个值
不同于utf-8。
如果我们想检查一个configfile.json
文件是否与我们的
check-encoding-utf8.json
。我们可以执行以下操作,假设
两个文件都在我们当前的工作目录中:
jmatch --target configfile.json check-encoding-utf8.json
如果配置文件包含在check-encoding-utf8.json
中指定的模式,则
^显示指定的{
一次检查多个图案
jmatch允许一次检查许多模式,因此所有模式文件必须 运行jmatch时提供。
jmatch --target configfile.json pattern1.json pattern2.json [...]
要为jmatch提供多个模式文件,可以使用通配符表达式, 要方便地指定许多模式文件:
jmatch --target hello.json pattern*.json
标志
有许多不同的标志可以更改jmatch的默认行为。你可以
使用--help
标志显示所有可用选项。
支架
请open an issue支持。