Merge pull request #415 from secvisogram/412-prettier-in-pipeline

chore: add prettier to test pipeline

Author: domachine

.prettierignore

@@ -0,0 +1,10 @@
+/.github
+/.gitlab-ci.yml
+
+/build
+/.nyc_output
+/coverage
+/.venv
+/csaf
+**/*.json
+/lib/shared/first

csaf_2_1/recommendedTests/recommendedTest_6_2_27.js

@@ -138,8 +138,8 @@ export function recommendedTest_6_2_27(doc) {
     const productToCategoriesMap = new Map()
 
     const productStatus = new Map(
-        Object.entries(vulnerability.product_status || {})
-    );
+      Object.entries(vulnerability.product_status || {})
+    )
     vulnerability.remediations?.forEach((remediation, remediationIndex) => {
       const category = remediation.category
       if (!category) return
@@ -173,9 +173,9 @@ export function recommendedTest_6_2_27(doc) {
       for (const [productId, categories] of productToCategoriesMap) {
         for (const category of categories) {
           const status = discouragedRuleMap.get(category)
-          if (!status) continue// There are no discouraged rules for this category.
+          if (!status) continue // There are no discouraged rules for this category.
           status.forEach((s) => {
-            const statusList = productStatus.get(s);
+            const statusList = productStatus.get(s)
             if (Array.isArray(statusList) && statusList.includes(productId)) {
               ctx.warnings.push({
                 instancePath: `/vulnerabilities/${vulnerabilityIndex}/remediations/${remediationIndex}`,

csaf_2_1/recommendedTests/recommendedTest_6_2_29.js

@@ -1,5 +1,5 @@
 import Ajv from 'ajv/dist/jtd.js'
-import {NIL_UUID} from "../sharingGroup.js";
+import { NIL_UUID } from '../sharingGroup.js'
 
 const ajv = new Ajv()
 
@@ -29,13 +29,13 @@ const validateInput = ajv.compile(inputSchema)
 /**
  * Test for the optional test 6.2.28
  * The Nil UUID should not be used as sharing group id.
- * 
+ *
  * @param {any} doc
  */
 export function recommendedTest_6_2_29(doc) {
   const ctx = {
     warnings:
-    /** @type {Array<{ instancePath: string; message: string }>} */ ([]),
+      /** @type {Array<{ instancePath: string; message: string }>} */ ([]),
   }
 
   if (!validateInput(doc)) {
@@ -50,4 +50,4 @@ export function recommendedTest_6_2_29(doc) {
   }
 
   return ctx
-}
+}

lib/informativeTests/shared/testURL.js

@@ -15,13 +15,15 @@ const packageInfo = createRequire(import.meta.url)('../../../package.json')
  */
 export default async function testURL(url, onError) {
   // set user-agent to csaf-validator-lib/VERSION
-  const userAgent = `${packageInfo.name.split('/').at(-1)}/${packageInfo.version}`
+  const userAgent = `${packageInfo.name.split('/').at(-1)}/${
+    packageInfo.version
+  }`
   try {
     const res = await request(url, {
       method: 'HEAD',
       headers: {
-        'User-Agent': userAgent
-      }
+        'User-Agent': userAgent,
+      },
     })
     if (res.statusCode < 200 || 400 <= res.statusCode) {
       onError()

lib/mandatoryTests/mandatoryTest_6_1_13.js

@@ -16,13 +16,16 @@ export default function mandatoryTest_6_1_13(doc) {
         /** @type {any} */ fullProductName,
         /** @type {number} */ fullProductNameIndex
       ) => {
-        checkProductIdentificationHelperPURL(fullProductName, (errorMessage) => {
-          isValid = false
-          errors.push({
-            instancePath: `/product_tree/full_product_names/${fullProductNameIndex}/product_identification_helper/purl`,
-            message: `invalid purl: ${errorMessage}`,
-          })
-        })
+        checkProductIdentificationHelperPURL(
+          fullProductName,
+          (errorMessage) => {
+            isValid = false
+            errors.push({
+              instancePath: `/product_tree/full_product_names/${fullProductNameIndex}/product_identification_helper/purl`,
+              message: `invalid purl: ${errorMessage}`,
+            })
+          }
+        )
       }
     )
   }
@@ -48,17 +51,20 @@ export default function mandatoryTest_6_1_13(doc) {
   }
 
   if (doc.product_tree) {
-    checkBranchesForInvalidPURLs(doc.product_tree, ({ branchIndexes, errorMessage }) => {
-      isValid = false
-      const branchPathPart = branchIndexes.reduce(
-        (str, index) => `${str}/branches/${index}`,
-        '/product_tree'
-      )
-      errors.push({
-        instancePath: `${branchPathPart}/product/product_identification_helper/purl`,
-        message: `invalid purl: ${errorMessage}`,
-      })
-    })
+    checkBranchesForInvalidPURLs(
+      doc.product_tree,
+      ({ branchIndexes, errorMessage }) => {
+        isValid = false
+        const branchPathPart = branchIndexes.reduce(
+          (str, index) => `${str}/branches/${index}`,
+          '/product_tree'
+        )
+        errors.push({
+          instancePath: `${branchPathPart}/product/product_identification_helper/purl`,
+          message: `invalid purl: ${errorMessage}`,
+        })
+      }
+    )
   }
 
   return { errors, isValid }
@@ -100,6 +106,6 @@ const checkProductIdentificationHelperPURL = (productALike, onError) => {
     PackageURL.fromString(productALike?.product_identification_helper?.purl)
   } catch (e) {
     const errorObject = /** @type {{message: string}} */ (e)
-    onError(errorObject?.message ?? "Unknown purl error")
+    onError(errorObject?.message ?? 'Unknown purl error')
   }
 }

lib/mandatoryTests/mandatoryTest_6_1_30.js

@@ -62,7 +62,10 @@ export default function mandatoryTest_6_1_30(doc) {
       }
     }
   })
-  if (versioningSchema != null && typeof doc.document.tracking.version === 'string') {
+  if (
+    versioningSchema != null &&
+    typeof doc.document.tracking.version === 'string'
+  ) {
     if (
       versioningSchema !== detectVersionSchema(doc.document.tracking.version)
     ) {

lib/mandatoryTests/mandatoryTest_6_1_31.js

@@ -64,14 +64,21 @@ export default function mandatoryTest_6_1_31(doc) {
           (['<', '<=', '>', '>='].some((str) =>
             branch.name?.toLowerCase().includes(str)
           ) ||
-            ['after', 'all', 'before', 'earlier', 'later', 'prior', 'versions'].some(
-              (str) =>
-                branch.name
-                  ?.toLowerCase()
-                  .split(/\s/)
-                  .some((word) => {
-                    return str === word
-                  })
+            [
+              'after',
+              'all',
+              'before',
+              'earlier',
+              'later',
+              'prior',
+              'versions',
+            ].some((str) =>
+              branch.name
+                ?.toLowerCase()
+                .split(/\s/)
+                .some((word) => {
+                  return str === word
+                })
             ))
         ) {
           ctx.isValid = false

lib/shared/dateHelper.js

@@ -27,7 +27,7 @@ export const compareZonedDateTimes = (a, b) => {
     } else {
       return -1
     }
-  } catch(e) {
+  } catch (e) {
     return 0
   }
 }

package.json

@@ -4,9 +4,9 @@
   "license": "MIT",
   "scripts": {
     "pretest": "tsc -b .",
-    "test": "node scripts/test.js",
+    "test": "prettier --check . && node scripts/test.js",
     "pretest-report": "tsc -b .",
-    "test-report": "node scripts/test.js --reporter json > test-results.json",
+    "test-report": "prettier --check . && node scripts/test.js --reporter json > test-results.json",
     "test-coverage": "c8 node scripts/test.js",
     "test-coverage-lcov": "c8 --reporter lcovonly node scripts/test.js"
   },

prettier.config.cjs

@@ -1,5 +1,7 @@
+/** @type {import('prettier').Config} */
 module.exports = {
   bracketSpacing: true,
   singleQuote: true,
-  semi: false
-};
+  semi: false,
+  endOfLine: process.platform === 'win32' ? 'auto' : 'lf',
+}