@@ -65,6 +65,26 @@ $ t4sanity <DATA_ROOT>
6565+-----------+---------+--------+--------+---------+----------+
6666` ` `
6767
68+ # ## Strict Mode
69+
70+ Basically, rules whose ** severity is WARNING** will be treated as success.
71+
72+ With ` -s; --strict` option enables us to treat warnings as failures:
73+
74+ ` ` ` shell
75+ # Run strict mode
76+ t4sanity < DATA_ROOT> -s
77+ ` ` `
78+
79+ # ## Exclude Checks
80+
81+ With ` -e; --excludes` option enables us to exclude specific checks by specifying the ** rule IDs or groups** :
82+
83+ ` ` ` shell
84+ # Exclude STR001 and all FMT-relevant rules
85+ t4sanity < DATA_ROOT> -e STR001 -e FMT
86+ ` ` `
87+
6888# ## Exit Status Logic
6989
7090` t4sanity` CLI returns the exit code based on the following conditions:
@@ -108,29 +128,9 @@ Here is the description of the JSON format:
108128- ` dataset_id` : The ID of the dataset.
109129- ` version` : The version of the dataset.
110130- ` reports` : An array of rule reports.
111- - ` id` : The ID of the rule.
112- - ` name` : The name of the rule.
113- - ` severity` : How important a rule is.
114- - ` description` : A description of the rule.
115- - ` status` : What happened when it ran.
116- - ` reasons` : An array of reasons for failure or skipped rules, null if passed.
117-
118- # ## Exclude Checks
119-
120- With ` -e; --excludes` option enables us to exclude specific checks by specifying the ** rule IDs or groups** :
121-
122- ` ` ` shell
123- # Exclude STR001 and all FMT-relevant rules
124- t4sanity < DATA_ROOT> -e STR001 -e FMT
125- ` ` `
126-
127- # ## Strict Mode
128-
129- Basically, rules whose ** severity is WARNING** will be treated as success.
130-
131- With ` -s; --strict` option enables us to treat warnings as failures:
132-
133- ` ` ` shell
134- # Run strict mode
135- t4sanity < DATA_ROOT> -s
136- ` ` `
131+ - ` id` : The ID of the rule.
132+ - ` name` : The name of the rule.
133+ - ` severity` : How important a rule is.
134+ - ` description` : A description of the rule.
135+ - ` status` : What happened when it ran.
136+ - ` reasons` : An array of reasons for failure or skipped rules, null if passed.
0 commit comments