fix(api-linter): fix typo according to copilot check

Author: HeronLi2024

api-linter/README.md

@@ -56,7 +56,7 @@ Usage: api-linter -s "path-to-spec-file" -r "path-to-rule-file" [-f "fail-severi
 
 Options:
   -s, --specPath <openapi spec>        path to openapi specification
-  -r, --rulesetpath <rule file>        path to rules file
+  -r, --rulesetPath <rule file>        path to rules file
   -f, --failSeverity <fail severity>   test fails when met result the severity equal or higher than it (choices: "error", "warn", "info", "hint", default: warn)
   -c, --consoleSeverity <console severity> console output message for linter result no matter job failed or succeeded (choices: "error", "warn", "info", "hint", default: warn)
   -o, --outputFilename <output filename> specify the output filename with or without .html extension (default: linter-result.html)
@@ -107,7 +107,7 @@ extends:
   - "@siemens/api-linter/rulesets/siemens-api-common-operation.yml"
   - "@siemens/api-linter/rulesets/siemens-api-security.yml"
 ```
-> You MAY use as below to achieve this for guidline linting `WITHOUT` `"spectral:oas"`.
+> You MAY use as below to achieve this for guideline linting `WITHOUT` `"spectral:oas"`.
 ```yaml
 extends:
   - "@siemens/api-linter/rulesets/siemens-api-express.yml"

api-linter/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@siemens/api-linter",
     "version": "0.8.4",
-    "description": "A linter tool with Rulesets follow Siemens RestApi Guidelines",
+    "description": "A linter tool with Rulesets follow Siemens REST API Guidelines",
     "homepage": "https://github.com/siemens/lint",
     "author": {
         "name": "Siemens",

api-linter/rulesets/functions/is-problem-json-schema.js

@@ -33,7 +33,7 @@ const assertProblemSchema = (schema) => {
   }
   const status = (schema.properties || {}).status || {};
   if (status.type !== 'integer' || status.format !== 'int32') {
-    throw "Problem json must have property 'status' with type 'integer' and format 'in32'";
+    throw "Problem json must have property 'status' with type 'integer' and format 'int32'";
   }
   const detail = (schema.properties || {}).detail || {};
   if (detail.type !== 'string') {

api-linter/rulesets/functions/links-has-self.js

@@ -11,7 +11,6 @@ const assertLinkSchema = (schema) => {
   const paths = jp.paths(schema, '$..*..links.properties');
 
   for (const path of paths) {
-    const pathString = path.join('.');
     if (path.some(p => p === 'relationships')) {
       continue;
     }

api-linter/rulesets/functions/query-parameters-length.js

@@ -11,7 +11,7 @@ export default (targetValue, options) => {
     }
     if (queryParameterCount > options.max && checkField && !hasFilter){
         return [{message: "The query parameter 'filter' SHOULD be used to filter or query data. " + 
-            "(Lint is unable to determine whether the parameters used for filtering or not.) " 
+            "(Linter is unable to determine whether the parameters used for filtering or not.) " 
         }];
     }
 };

api-linter/src/index.js

@@ -106,7 +106,7 @@ const formatJSON = (rules, results) => {
                 break;
             }
         }
-    })
+    });
     let jsonResult = {
         "data": data,
         "timestamp": new Date().toLocaleString(),
@@ -205,7 +205,7 @@ const linter =  async (specFilePath, rulesetPath, followRefs) => {
             fs.unlinkSync(tempFilePath); 
         }
     } catch (cleanupErr) {
-        console.error(`Remove temporary file ${tempFilePath} failed. Please delete mannually.`);
+        console.error(`Remove temporary file ${tempFilePath} failed. Please delete manually.`);
     }
 
     return binded;
@@ -269,7 +269,7 @@ const resolveRuleDependencyResult = (rules, results) => {
 
   const filteredResults = [];
 
-  for (const [locationKey, issues] of issuesByLocation.entries()) {
+  for (const [_, issues] of issuesByLocation.entries()) {
     const failedRules = new Set(issues.map(i => i.code));
 
     for (const issue of issues) {

api-linter/test/api-errors-refs.test.js

@@ -1,13 +1,13 @@
 // test/api-errors-refs.test.js
 const fs = require('fs');
-const { Spectral, Document } = require('@stoplight/spectral-core');
+const { Document } = require('@stoplight/spectral-core');
 const Parsers = require('@stoplight/spectral-parsers');
 
 // 👇   RE-ADD setupSpectral here
-const { setupSpectral, retrieveDocument } =
+const { setupSpectral } =
   require('@jamietanna/spectral-test-harness');
 
-const { resultsForSeverity, getSpecFilePath } = require('./base.js');
+const { resultsForSeverity } = require('./base.js');
 const { resolver } = require('@stoplight/spectral-ref-resolver');
 const path = require('path');
 

api-linter/test/api-pagination.test.js

@@ -1,5 +1,5 @@
 const { retrieveDocument, setupSpectral} = require('@jamietanna/spectral-test-harness')
-const {resultsForSeverity, getSpecFilePath,assertOnlyErrors, assertOnlyWarnings, assertOnlyInfos, assertOnlyHints } = require("./base.js")
+const {resultsForSeverity, getSpecFilePath, assertOnlyInfos, assertOnlyHints } = require("./base.js")
 
 const path = 'pagination/';
 const rulesetPath = "test/testdata/pagination/.spectral.yml";

api-linter/test/api-sparse-fieldsets.test.js

@@ -1,5 +1,5 @@
 const { retrieveDocument, setupSpectral} = require('@jamietanna/spectral-test-harness')
-const {resultsForSeverity, getSpecFilePath, assertOnlyWarnings, assertOnlyInfos } = require("./base.js")
+const {resultsForSeverity, getSpecFilePath, assertOnlyInfos } = require("./base.js")
 
 const path = 'fields/';
 const rulesetPath = "test/testdata/fields/.spectral.yml";