feat: add wordsNeedingReview report script

Author: wackerow

.gitignore

@@ -52,3 +52,6 @@ robots.txt
 
 # vscode workplace configuration
 .vscode
+
+# Crowdin report output
+src/data/crowdin/report.csv

package.json

@@ -18,6 +18,7 @@
     "crowdin-clean": "rm -rf .crowdin && mkdir .crowdin",
     "crowdin-import": "ts-node src/scripts/crowdin-import.ts",
     "events-import": "ts-node -O '{ \"module\": \"commonjs\" }' src/scripts/events-import.ts",
+    "crowdin-needs-review": "ts-node -O '{ \"module\": \"commonjs\" }' src/scripts/crowdin/reports/wordsNeedingReview.ts",
     "markdown-checker": "ts-node -O '{ \"module\": \"commonjs\" }' src/scripts/markdownChecker.ts"
   },
   "dependencies": {

src/scripts/crowdin/reports/wordsNeedingReview.ts

@@ -0,0 +1,63 @@
+import fs from "fs"
+import path from "path"
+
+import i18n from "../../../../i18n.config.json"
+import dirs from "../../../data/crowdin/translation-buckets-dirs.json"
+import { CROWDIN_API_MAX_LIMIT } from "../../../lib/constants"
+import crowdinClient from "../api-client/crowdinClient"
+
+type SummaryItem = [code: string, bucket: string, needsReview: number]
+
+async function main() {
+  const projectId = Number(process.env.CROWDIN_PROJECT_ID) || 363359
+
+  const reportSummary = [] as SummaryItem[]
+
+  const directories = dirs.sort((a, b) => a.name.localeCompare(b.name))
+
+  // Loop through list of content buckets (dirs)
+  for (const dir of directories) {
+    console.log(`Processing: ${dir.name}...`)
+
+    // Get translation progress for bucket (dir.id) in all languages
+    const { data } =
+      await crowdinClient.translationStatusApi.getDirectoryProgress(
+        projectId,
+        dir.id,
+        { limit: CROWDIN_API_MAX_LIMIT }
+      )
+
+    // Loop through supported languages
+    i18n.forEach(({ crowdinCode }) => {
+      const match = data.find(
+        ({ data: { languageId } }) => languageId === crowdinCode
+      )
+      if (!match) return
+      const { words, translationProgress } = match.data
+      if (translationProgress < 100) return
+      const needsReview = words.translated - words.approved
+      if (needsReview === 0) return
+      // If match, 100% translation progress, and not full reviewed, add to summary
+      reportSummary.push([crowdinCode, dir.name, needsReview])
+    })
+  }
+
+  // Transform to çsv string
+  const csvArray = reportSummary.map((item) => item.join(","))
+  // Insert header names at beginning of csv array
+  csvArray.unshift("Language,Bucket Name,Words needing review")
+  const csv = csvArray.join("\n")
+
+  // Write csv to file to fs
+  const csvPath = path.resolve(process.cwd(), "src/data/crowdin/report.csv")
+  fs.writeFileSync(csvPath, csv)
+
+  // Log summary
+  console.log("\nReport summary:\n")
+  console.log(csv)
+  console.log(`\n✅ Report saved to ${csvPath}`)
+}
+
+main()
+
+export default main