docs(cli): clarified info and changes applied

PagoNxt-Trade · PagoNxt-Trade · commit 1b682b74c9dc · 2023-01-23T15:50:35.000+01:00
diff --git a/packages/cli/src/commands/lint.ts b/packages/cli/src/commands/lint.ts
@@ -308,7 +308,7 @@ const scoringThresholdNotEnough = (results: IRuleResult[], scoringConfig: Scorin
       getScoringLevel(
         getCountsBySeverity(groupedUniqueResults),
         scoringConfig.scoringSubtract,
-        scoringConfig.warningsSubtract,
+        scoringConfig.onlySubtractHigherSeverityLevel,
       )
     );
   }
diff --git a/packages/cli/src/services/__tests__/__fixtures__/scoring-config.json b/packages/cli/src/services/__tests__/__fixtures__/scoring-config.json
@@ -27,6 +27,6 @@
       "E": 0
     },
   "threshold": 50,
-  "warningsSubtract": true,
+  "onlySubtractHigherSeverityLevel": true,
   "uniqueErrors": false
 }
diff --git a/packages/cli/src/services/__tests__/output.test.ts b/packages/cli/src/services/__tests__/output.test.ts
@@ -28,7 +28,7 @@ const scoringConfig = {
     E: 0,
   } as unknown as ScoringLevel[],
   threshold: 50,
-  warningsSubtract: true,
+  onlySubtractHigherSeverityLevel: true,
   uniqueErrors: false,
 };
 
diff --git a/test-harness/scenarios/formats/results-default-format-scoring-json.scenario b/test-harness/scenarios/formats/results-default-format-scoring-json.scenario
@@ -79,7 +79,7 @@ info:
       "E": 0
     },
   "threshold": 50,
-  "warningsSubtract": true,
+  "onlySubtractHigherSeverityLevel": true,
   "uniqueErrors": false
 }
 ====command====
diff --git a/test-harness/scenarios/formats/results-default-scoring.scenario b/test-harness/scenarios/formats/results-default-scoring.scenario
@@ -79,7 +79,7 @@ info:
       "E": 0
     },
   "threshold": 50,
-  "warningsSubtract": true,
+  "onlySubtractHigherSeverityLevel": true,
   "uniqueErrors": false
 }
 ====command====
diff --git a/test-harness/scenarios/formats/results-format-stylish-scoring.scenario b/test-harness/scenarios/formats/results-format-stylish-scoring.scenario
@@ -80,7 +80,7 @@ paths: {}
       "E": 0
     },
   "threshold": 50,
-  "warningsSubtract": true,
+  "onlySubtractHigherSeverityLevel": true,
   "uniqueErrors": false
 }
 ====command====
diff --git a/test-harness/scenarios/overrides/aliases-scoring.scenario b/test-harness/scenarios/overrides/aliases-scoring.scenario
@@ -93,7 +93,7 @@ module.exports = {
       "E": 0
     },
   "threshold": 50,
-  "warningsSubtract": true,
+  "onlySubtractHigherSeverityLevel": true,
   "uniqueErrors": false
 }
 ====asset:v2/document.json====
diff --git a/test-harness/scenarios/severity/fail-on-error-no-error-scoring.scenario b/test-harness/scenarios/severity/fail-on-error-no-error-scoring.scenario
@@ -47,7 +47,7 @@ Will only fail if there is an error, and there is not. Can still see all warning
       "E": 0
     },
   "threshold": 50,
-  "warningsSubtract": true,
+  "onlySubtractHigherSeverityLevel": true,
   "uniqueErrors": false
 }
 ====command====
diff --git a/test-harness/scenarios/severity/fail-on-error-scoring.scenario b/test-harness/scenarios/severity/fail-on-error-scoring.scenario
@@ -58,7 +58,7 @@ Will fail and return 1 as exit code because errors exist with scoring data
       "E": 0
     },
   "threshold": 50,
-  "warningsSubtract": true,
+  "onlySubtractHigherSeverityLevel": true,
   "uniqueErrors": false
 }
 ====command-nix====
diff --git a/test-harness/scenarios/valid-no-errors.oas2-scoring.scenario b/test-harness/scenarios/valid-no-errors.oas2-scoring.scenario
@@ -47,7 +47,7 @@ module.exports = oas;
       "E": 0
     },
   "threshold": 50,
-  "warningsSubtract": true,
+  "onlySubtractHigherSeverityLevel": true,
   "uniqueErrors": false
 }
 ====command====

Original file line number	Diff line number	Diff line change
`@@ -308,7 +308,7 @@ const scoringThresholdNotEnough = (results: IRuleResult[], scoringConfig: Scorin`
`308`	`308`	`getScoringLevel(`
`309`	`309`	`getCountsBySeverity(groupedUniqueResults),`
`310`	`310`	`scoringConfig.scoringSubtract,`
`311`		`- scoringConfig.warningsSubtract,`
	`311`	`+ scoringConfig.onlySubtractHigherSeverityLevel,`
`312`	`312`	`)`
`313`	`313`	`);`
`314`	`314`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,6 @@`
`27`	`27`	`"E": 0`
`28`	`28`	`},`
`29`	`29`	`"threshold": 50,`
`30`		`- "warningsSubtract": true,`
	`30`	`+ "onlySubtractHigherSeverityLevel": true,`
`31`	`31`	`"uniqueErrors": false`
`32`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ info:`
`79`	`79`	`"E": 0`
`80`	`80`	`},`
`81`	`81`	`"threshold": 50,`
`82`		`- "warningsSubtract": true,`
	`82`	`+ "onlySubtractHigherSeverityLevel": true,`
`83`	`83`	`"uniqueErrors": false`
`84`	`84`	`}`
`85`	`85`	`====command====`
Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ paths: {}`
`80`	`80`	`"E": 0`
`81`	`81`	`},`
`82`	`82`	`"threshold": 50,`
`83`		`- "warningsSubtract": true,`
	`83`	`+ "onlySubtractHigherSeverityLevel": true,`
`84`	`84`	`"uniqueErrors": false`
`85`	`85`	`}`
`86`	`86`	`====command====`
Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,7 @@ module.exports = {`
`93`	`93`	`"E": 0`
`94`	`94`	`},`
`95`	`95`	`"threshold": 50,`
`96`		`- "warningsSubtract": true,`
	`96`	`+ "onlySubtractHigherSeverityLevel": true,`
`97`	`97`	`"uniqueErrors": false`
`98`	`98`	`}`
`99`	`99`	`====asset:v2/document.json====`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ Will only fail if there is an error, and there is not. Can still see all warning`
`47`	`47`	`"E": 0`
`48`	`48`	`},`
`49`	`49`	`"threshold": 50,`
`50`		`- "warningsSubtract": true,`
	`50`	`+ "onlySubtractHigherSeverityLevel": true,`
`51`	`51`	`"uniqueErrors": false`
`52`	`52`	`}`
`53`	`53`	`====command====`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ Will fail and return 1 as exit code because errors exist with scoring data`
`58`	`58`	`"E": 0`
`59`	`59`	`},`
`60`	`60`	`"threshold": 50,`
`61`		`- "warningsSubtract": true,`
	`61`	`+ "onlySubtractHigherSeverityLevel": true,`
`62`	`62`	`"uniqueErrors": false`
`63`	`63`	`}`
`64`	`64`	`====command-nix====`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ module.exports = oas;`
`47`	`47`	`"E": 0`
`48`	`48`	`},`
`49`	`49`	`"threshold": 50,`
`50`		`- "warningsSubtract": true,`
	`50`	`+ "onlySubtractHigherSeverityLevel": true,`
`51`	`51`	`"uniqueErrors": false`
`52`	`52`	`}`
`53`	`53`	`====command====`