Merge pull request #1997 from angela-lee1/create-script-output-list-files-containing-linting-errors

add script to out put list of files containing linting errors

Author: trillium

package.json

@@ -16,7 +16,8 @@
     "test:backend": "cd backend && npm run test",
     "test:client": "cd client && npm run test",
     "test:all": "cross-env NODE_ENV=test npm run test:client && npm run test:backend",
-    "prepare": "husky install"
+    "prepare": "husky install",
+    "lint:files": "node scripts/list-lint-files.mjs"
   },
   "dependencies": {
     "@mui/icons-material": "^5.14.19",

scripts/list-lint-files.mjs

@@ -0,0 +1,46 @@
+//import node modules for running shell commands and handling files, define file names
+import { execSync } from "child_process";
+import fs from "fs";
+const reportFile = "lint-report.json";
+const countFile = "lint-files.count.txt";
+
+// Generate report
+const generateReports = (results, exitCode) => {
+  const countContent = `After running the lint found total number of the files has linting problems: ${results.length}`;
+  fs.writeFileSync(countFile, countContent, "utf-8");
+  console.log(
+    `Found ${results.length} files with linting errors. Total written to ${countFile}`,
+  );
+
+  const modifiedResults = results.map((result) => {
+    const vrmsIndex = result.filePath.indexOf("VRMS");
+    const relativePath = result.filePath.substring(vrmsIndex + 4);
+    return { ...result, filePath: relativePath };
+  });
+
+  const formattedJson = JSON.stringify(modifiedResults, null, 2);
+  fs.writeFileSync(reportFile, formattedJson, "utf-8");
+
+  console.log(`Lint report created: ${reportFile}`);
+  process.exit(exitCode);
+};
+
+try {
+  const stdout = execSync("npx eslint . --format json").toString();
+  const results = JSON.parse(stdout);
+  generateReports(results, 0);
+} catch (error) {
+  let results;
+  try {
+    const stdout = error.stdout.toString();
+    results = JSON.parse(stdout);
+  } catch (parseError) {
+    console.error(
+      "Failed to parse ESLint output. The output was not valid JSON.",
+    );
+    console.error("Error details:", parseError.message);
+    console.error("Raw output:", error.stdout.toString());
+    process.exit(1);
+  }
+  generateReports(results, 1);
+}