fix(typescript-library): Organize types and add missing slash #532

Author: dannyvassallo

guard/ts-lib/index.js

@@ -13,7 +13,7 @@ const formatOutput = ({ result, rulesNames, dataNames }) => {
     const output = JSON.parse(JSON.stringify(result).replace(dataPattern, (match, index) => {
         const fileIndex = parseInt(index, 10) - 1;
         const fileName = dataNames[fileIndex];
-        return fileName ? fileName.split(isWindows ? '\\' : '/').join('') : match;
+        return fileName ? (isWindows ? fileName.split('\\').join('/') : fileName) : match;
     }).replace(rulesPattern, (match, index) => {
         const ruleIndex = parseInt(index, 10) - 1;
         const ruleName = rulesNames[ruleIndex];

guard/ts-lib/index.ts

@@ -81,6 +81,11 @@ export type SarifShortDescription = {
   text: string;
 }
 
+type ValidateParams = {
+  dataPath: string;
+  rulesPath: string;
+}
+
 const formatOutput = ({ result, rulesNames, dataNames }: FormatOutputParams): SarifReport => {
   const dataPattern = /DATA_STDIN\[(\d+)\]/g;
   const rulesPattern = /RULES_STDIN\[(\d+)\]\/DEFAULT/g;
@@ -90,7 +95,7 @@ const formatOutput = ({ result, rulesNames, dataNames }: FormatOutputParams): Sa
     const fileIndex = parseInt(index, 10) - 1;
     const fileName = dataNames[fileIndex];
 
-    return fileName ? fileName.split(isWindows ? '\\' : '/').join('') : match;
+    return fileName ? (isWindows ? fileName.split('\\').join('/') : fileName) : match;
   }).replace(rulesPattern, (match: string, index: string) => {
     const ruleIndex = parseInt(index, 10) - 1;
     const ruleName = rulesNames[ruleIndex];
@@ -104,31 +109,26 @@ const formatOutput = ({ result, rulesNames, dataNames }: FormatOutputParams): Sa
   return JSON.parse(output);
 };
 
-  async function readFiles(dirPath: string, supportedExtensions: string[]): Promise<TraversalResult> {
-    const fileNames: string[] = [];
-    const fileContents: string[] = [];
-
-    const files = await fs.promises.readdir(dirPath, { withFileTypes: true });
-    const readPromises = files.map(async (file) => {
-      const filePath = path.join(dirPath, file.name);
-      if (!file.isDirectory() && supportedExtensions.includes(path.extname(filePath))) {
-        const content = await fs.promises.readFile(filePath, 'utf8');
-        fileNames.push(filePath);
-        fileContents.push(content);
-      }
-    });
-    await Promise.all(readPromises);
-
-    return {
-      fileContents,
-      fileNames,
-    };
-  }
-
-  type ValidateParams = {
-    dataPath: string;
-    rulesPath: string;
-  }
+async function readFiles(dirPath: string, supportedExtensions: string[]): Promise<TraversalResult> {
+  const fileNames: string[] = [];
+  const fileContents: string[] = [];
+
+  const files = await fs.promises.readdir(dirPath, { withFileTypes: true });
+  const readPromises = files.map(async (file) => {
+    const filePath = path.join(dirPath, file.name);
+    if (!file.isDirectory() && supportedExtensions.includes(path.extname(filePath))) {
+      const content = await fs.promises.readFile(filePath, 'utf8');
+      fileNames.push(filePath);
+      fileContents.push(content);
+    }
+  });
+  await Promise.all(readPromises);
+
+  return {
+    fileContents,
+    fileNames,
+  };
+}
 
 export const validate = async ({ rulesPath, dataPath }: ValidateParams): Promise<SarifReport> => {
   const rulesResult = await readFiles(rulesPath, RULE_FILE_SUPPORTED_EXTENSIONS);