Display all files reset in a translation batch (#23152)

* Output every file reset

* Add --dry-run and --reason options to reset-translated-file.js

* Output reason when reset-translated-file.js script is called

Author: mjacobus

script/i18n/lint-translation-files.js

@@ -79,7 +79,9 @@ function lintAndResetFiles(checkType) {
   // We are not passing --prefer-main because we want to remove the file so we
   // reset it directly to the English source
   filesToReset.forEach((file) => {
-    execSync(`script/i18n/reset-translated-file.js ${file}`)
+    execSync(`script/i18n/reset-translated-file.js ${file} --reason="${checkType} error"`, {
+      stdio: 'inherit',
+    })
   })
 
   // Print a message with next steps

script/i18n/reset-known-broken-translation-files.js

@@ -50,7 +50,10 @@ async function main() {
   // This is done sequentially to ensure only one Git operation is running at any given time.
   brokenFilesArray.forEach((file) => {
     console.log(`Resetting ${file}`)
-    execSync(`node script/i18n/reset-translated-file.js ${file}`)
+    execSync(
+      `script/i18n/reset-translated-file.js ${file} --reason="Listed in localization-support#489"`,
+      { stdio: 'inherit' }
+    )
   })
 
   // Print a message with next steps.

script/i18n/reset-translated-file.js

@@ -30,8 +30,14 @@ program
     '-m, --prefer-main',
     'Reset file to the translated file, try using the file from `main` branch first, if not found (usually due to renaming), fall back to English source.'
   )
+  .option('-d, --dry-run', 'Just pretend to reset files')
+  .option('-r, --reason <reason>', 'A reason why the file is getting reset')
   .parse(process.argv)
 
+const dryRun = program.opts().dryRun
+const reason = program.opts().reason
+const reasonMessage = reason ? `Reason: ${reason}` : ''
+
 const resetToEnglishSource = (translationFilePath) => {
   assert(
     translationFilePath.startsWith('translations/'),
@@ -45,15 +51,21 @@ const resetToEnglishSource = (translationFilePath) => {
   const relativePath = translationFilePath.split(path.sep).slice(2).join(path.sep)
   const englishFile = path.join(process.cwd(), relativePath)
 
-  if (!fs.existsSync(englishFile)) {
+  if (!dryRun && !fs.existsSync(englishFile)) {
     fs.unlinkSync(translationFilePath)
     return
   }
 
-  // replace file with English source
-  const englishContent = fs.readFileSync(englishFile, 'utf8')
-  fs.writeFileSync(translationFilePath, englishContent)
-  console.log('-> reverted to English: %s', path.relative(process.cwd(), translationFilePath))
+  if (!dryRun) {
+    // replace file with English source
+    const englishContent = fs.readFileSync(englishFile, 'utf8')
+    fs.writeFileSync(translationFilePath, englishContent)
+  }
+  console.log(
+    '-> reverted to English: %s %s',
+    path.relative(process.cwd(), translationFilePath),
+    reasonMessage
+  )
 }
 
 const [pathArg] = program.args
@@ -64,8 +76,10 @@ const relativePath = fs.existsSync(pathArg) ? path.relative(process.cwd(), pathA
 
 if (program.opts().preferMain) {
   try {
-    execSync(`git checkout main -- ${relativePath}`, { stdio: 'pipe' })
-    console.log('-> reverted to file from main branch: %s', relativePath)
+    if (!dryRun) {
+      execSync(`git checkout main -- ${relativePath}`, { stdio: 'pipe' })
+    }
+    console.log('-> reverted to file from main branch: %s %s', relativePath, reasonMessage)
   } catch (e) {
     if (e.message.includes('pathspec')) {
       console.warn(

script/i18n/test-render-translation.js

@@ -94,7 +94,9 @@ async function loadAndPatchSiteData(filesWithKnownIssues = {}) {
 
         // Reset the file
         console.warn(`resetting file "${relPath}" due to loadSiteData error: ${error.toString()}`)
-        await exec(`script/i18n/reset-translated-file.js --prefer-main ${relPath}`)
+        await exec(
+          `script/i18n/reset-translated-file.js --prefer-main ${relPath} --reason="loadSiteData error"`
+        )
 
         // Try to load the site data again
         return loadAndPatchSiteData(filesWithKnownIssues)