scratch-l10n 5.0.231 → 5.0.232

package/scripts/tx-pull-www.mjs

@@ -1,14 +1,28 @@
 #!/usr/bin/env node
+/**
+ * @file
+ * Script to pull www translations from transifex for all resources.
+ * Expects that the project and that the person running the script
+ * has the the TX_TOKEN environment variable set to an api
+ * token that has developer access.
+ */
+import fs from 'fs/promises'
+import mkdirp from 'mkdirp'
+import path from 'path'
+import { batchMap } from '../lib/batch.js'
+import { ProgressLogger } from '../lib/progress-logger.mjs'
+import { txPull, txResources } from '../lib/transifex.js'
+import locales, { localeMap } from '../src/supported-locales.mjs'
 
 /**
- * @fileoverview
+ * @file
  * Script to pull www translations from transifex for all resources.
  * Expects that the project and that the person running the script
  * has the the TX_TOKEN environment variable set to an api
  * token that has developer access.
  */
 
-const args = process.argv.slice(2);
+const args = process.argv.slice(2)
 
 const usage = `
  Pull supported language translations from Transifex for the 'scratch-website' project.
@@ -18,97 +32,86 @@ const usage = `
      path: root for the translated resources.
            Each resource will be a subdirectory containing language json files.
      lang: optional language code - will only pull resources for that language
-   NOTE: TX_TOKEN environment variable needs to be set with a Transifex API token. 
+   NOTE: TX_TOKEN environment variable needs to be set with a Transifex API token.
    See the Localization page on the GUI wiki for information about setting up Transifex.
- `;
+ `
 // Fail immediately if the TX_TOKEN is not defined
 if (!process.env.TX_TOKEN || args.length < 1) {
-    process.stdout.write(usage);
-    process.exit(1);
+  process.stdout.write(usage)
+  process.exit(1)
 }
 
-import fs from 'fs/promises';
-import path from 'path';
-import mkdirp from 'mkdirp';
-import {txPull, txResources} from '../lib/transifex.js';
-import locales, {localeMap} from '../src/supported-locales.mjs';
-import {batchMap} from '../lib/batch.js';
-import {ProgressLogger} from '../lib/progress-logger.mjs';
-
 // Globals
-const PROJECT = 'scratch-website';
-const OUTPUT_DIR = path.resolve(args[0]);
+const PROJECT = 'scratch-website'
+const OUTPUT_DIR = path.resolve(args[0])
 // const MODE = {mode: 'reviewed'}; // default is everything for www
-const CONCURRENCY_LIMIT = 36;
+const CONCURRENCY_LIMIT = 36
 
-const lang = args.length === 2 ? args[1] : '';
+const lang = args.length === 2 ? args[1] : ''
 
 const getLocaleData = async function (item) {
-    const locale = item.locale;
-    const resource = item.resource;
-    let txLocale = localeMap[locale] || locale;
+  const locale = item.locale
+  const resource = item.resource
+  const txLocale = localeMap[locale] || locale
 
-    const translations = await txPull(PROJECT, resource, txLocale);
+  const translations = await txPull(PROJECT, resource, txLocale)
 
-    const txOutdir = `${OUTPUT_DIR}/${PROJECT}.${resource}`;
-    const fileName = `${txOutdir}/${locale}.json`;
+  const txOutdir = `${OUTPUT_DIR}/${PROJECT}.${resource}`
+  const fileName = `${txOutdir}/${locale}.json`
 
-    try {
-        mkdirp.sync(txOutdir);
-        await fs.writeFile(
-            fileName,
-            JSON.stringify(translations, null, 4)
-        );
+  try {
+    mkdirp.sync(txOutdir)
+    await fs.writeFile(fileName, JSON.stringify(translations, null, 4))
 
-        return {
-            resource,
-            locale,
-            fileName
-        };
-    } catch (e) {
-        e.cause = {
-            resource,
-            locale,
-            translations,
-            txOutdir,
-            fileName
-        };
-        throw e;
+    return {
+      resource,
+      locale,
+      fileName,
     }
-};
+  } catch (e) {
+    e.cause = {
+      resource,
+      locale,
+      translations,
+      txOutdir,
+      fileName,
+    }
+    throw e
+  }
+}
 
-const expandResourceFiles = (resources) => {
-    let items = [];
-    for (let resource of resources) {
-        if (lang) {
-            items.push({resource: resource, locale: lang});
-        } else {
-            for (let locale of Object.keys(locales)) {
-                items.push({resource: resource, locale: locale});
-            }
-        }
+const expandResourceFiles = resources => {
+  const items = []
+  for (const resource of resources) {
+    if (lang) {
+      items.push({ resource: resource, locale: lang })
+    } else {
+      for (const locale of Object.keys(locales)) {
+        items.push({ resource: resource, locale: locale })
+      }
     }
-    return items;
-};
+  }
+  return items
+}
 
 const pullTranslations = async function () {
-    const resources = await txResources(PROJECT);
-    const allFiles = expandResourceFiles(resources);
-
-    const progress = new ProgressLogger(allFiles.length);
-
-    try {
-        await batchMap(allFiles, CONCURRENCY_LIMIT, async item => {
-            try {
-                await getLocaleData(item);
-            } finally {
-                progress.increment();
-            }
-        });
-    } catch (err) {
-        console.error(err);
-        process.exit(1);
-    }
-};
+  const resources = await txResources(PROJECT)
+  const allFiles = expandResourceFiles(resources)
+
+  const progress = new ProgressLogger(allFiles.length)
+
+  try {
+    await batchMap(allFiles, CONCURRENCY_LIMIT, async item => {
+      try {
+        await getLocaleData(item)
+      } finally {
+        progress.increment()
+      }
+    })
+  } catch (err) {
+    console.error(err)
+    process.exit(1)
+  }
+}
 
-pullTranslations();
+pullTranslations()

package/scripts/tx-push-help.mjs

@@ -1,13 +1,12 @@
 #!/usr/bin/env node
-
 /**
- * @fileoverview
+ * @file
  * Script get Knowledge base articles from Freshdesk and push them to transifex.
  */
+import { txPush, txCreateResource } from '../lib/transifex.js'
+import FreshdeskApi from './freshdesk-api.js'
 
-import {txPush, txCreateResource} from '../lib/transifex.js';
-
-const args = process.argv.slice(2);
+const args = process.argv.slice(2)
 
 const usage = `
  Pull knowledge base articles from Freshdesk and push to scratch-help project on transifex. Usage:
@@ -17,129 +16,121 @@ const usage = `
    access to the Knowledge Base.
    TX_TOKEN environment variable needs to be set with a Transifex API token. See
    the Localization page on the GUI wiki for information about setting up Transifex.
- `;
+ `
 // Fail immediately if the API tokens are not defined, or there any argument
 if (!process.env.TX_TOKEN || !process.env.FRESHDESK_TOKEN || args.length > 0) {
-    process.stdout.write(usage);
-    process.exit(1);
+  process.stdout.write(usage)
+  process.exit(1)
 }
 
-import FreshdeskApi from './freshdesk-api.js';
+const FD = new FreshdeskApi('https://mitscratch.freshdesk.com', process.env.FRESHDESK_TOKEN)
+const TX_PROJECT = 'scratch-help'
 
-const FD = new FreshdeskApi('https://mitscratch.freshdesk.com', process.env.FRESHDESK_TOKEN);
-const TX_PROJECT = 'scratch-help';
-
-const categoryNames = {};
-const folderNames = {};
+const categoryNames = {}
+const folderNames = {}
 
 /**
  * Generate a transifex id from the name and id field of an objects. Remove spaces and '/'
  * from the name and append '.<id>' Transifex ids (slugs) have a max length of 50. Use at most
  * 30 characters of the name to allow for Freshdesk id, and a suffix like '_json'
  * @param  {object} item data from Freshdesk that includes the name and id of a category or folder
- * @return {string}      generated transifex id
+ * @returns {string}      generated transifex id
  */
-const makeTxId = item => {
-    return `${item.name.replace(/[ /]/g, '').slice(0, 30)}_${item.id}`;
-};
+const makeTxId = item => `${item.name.replace(/[ /]/g, '').slice(0, 30)}_${item.id}`
 
 const txPushResource = async (name, articles, type) => {
-    const resourceData = {
-        slug: name,
-        name: name,
-        i18n_type: type,
-        priority: 0, // default to normal priority
-        content: articles
-    };
-
-    try {
-        await txPush(TX_PROJECT, name, articles);
-    } catch (err) {
-        if (err.statusCode !== 404) {
-            process.stdout.write(`Transifex Error: ${err.message}\n`);
-            process.stdout.write(
-                `Transifex Error ${err.response.statusCode.toString()}: ${err.response.body}\n`);
-            process.exitCode = 1;
-            return;
-        }
+  const resourceData = {
+    slug: name,
+    name: name,
+    i18n_type: type,
+    priority: 0, // default to normal priority
+    content: articles,
+  }
+
+  try {
+    await txPush(TX_PROJECT, name, articles)
+  } catch (err) {
+    if (err.statusCode !== 404) {
+      process.stdout.write(`Transifex Error: ${err.message}\n`)
+      process.stdout.write(`Transifex Error ${err.response.statusCode.toString()}: ${err.response.body}\n`)
+      process.exitCode = 1
+      return
+    }
 
-        // file not found - create it, but also give message
-        process.stdout.write(`Transifex Resource not found, creating: ${name}\n`);
-        if (err.statusCode === 404) {
-            await txCreateResource(TX_PROJECT, resourceData);
-        }
+    // file not found - create it, but also give message
+    process.stdout.write(`Transifex Resource not found, creating: ${name}\n`)
+    if (err.statusCode === 404) {
+      await txCreateResource(TX_PROJECT, resourceData)
     }
-};
+  }
+}
 
 /**
  * get a flattened list of folders associated with the specified categories
  * @param  {object[]} categories array of categories the folders belong to
- * @return {Promise<object[]>} flattened list of folders from all requested categories
+ * @returns {Promise<object[]>} flattened list of folders from all requested categories
  */
-const getFolders = async (categories) => {
-    const categoryFolders = await Promise.all(
-        categories.map(category => FD.listFolders(category))
-    );
-    return [].concat(...categoryFolders);
-};
+const getFolders = async categories => {
+  const categoryFolders = await Promise.all(categories.map(category => FD.listFolders(category)))
+  return [].concat(...categoryFolders)
+}
 
-const PUBLISHED = 2; // in Freshdesk, draft status = 1, and published = 2
+const PUBLISHED = 2 // in Freshdesk, draft status = 1, and published = 2
 
 /**
  * Save articles in a particular folder
  * @param {object} folder The folder object
  */
 const saveArticles = async folder => {
-    await FD.listArticles(folder)
-        .then(json => {
-            const txArticles = json.reduce((strings, current) => {
-                if (current.status === PUBLISHED) {
-                    strings[`${current.id}`] = {
-                        title: {
-                            string: current.title
-                        },
-                        description: {
-                            string: current.description
-                        }
-                    };
-                    if (current.tags.length > 0) {
-                        strings[`${current.id}`].tags = {string: current.tags.toString()};
-                    }
-                }
-                return strings;
-            }, {});
-            process.stdout.write(`Push ${folder.name} articles to Transifex\n`);
-            txPushResource(`${makeTxId(folder)}_json`, txArticles, 'STRUCTURED_JSON');
-        });
-};
+  await FD.listArticles(folder).then(json => {
+    const txArticles = json.reduce((strings, current) => {
+      if (current.status === PUBLISHED) {
+        strings[`${current.id}`] = {
+          title: {
+            string: current.title,
+          },
+          description: {
+            string: current.description,
+          },
+        }
+        if (current.tags.length > 0) {
+          strings[`${current.id}`].tags = { string: current.tags.toString() }
+        }
+      }
+      return strings
+    }, {})
+    process.stdout.write(`Push ${folder.name} articles to Transifex\n`)
+    txPushResource(`${makeTxId(folder)}_json`, txArticles, 'STRUCTURED_JSON')
+  })
+}
 
 /**
  * @param {object[]} folders Array of folders containing articles to be saved
  */
-const saveArticleFolders = async (folders) => {
-    await Promise.all(folders.map(folder => saveArticles(folder)));
-};
+const saveArticleFolders = async folders => {
+  await Promise.all(folders.map(folder => saveArticles(folder)))
+}
 
 const syncSources = async () => {
-    await FD.listCategories()
-        .then(json => {
-            // save category names for translation
-            for (let cat of json.values()) {
-                categoryNames[`${makeTxId(cat)}`] = cat.name;
-            }
-            return json;
-        })
-        .then(getFolders)
-        .then(data => {
-            data.forEach(item => {
-                folderNames[`${makeTxId(item)}`] = item.name;
-            });
-            process.stdout.write('Push category and folder names to Transifex\n');
-            txPushResource('categoryNames_json', categoryNames, 'KEYVALUEJSON');
-            txPushResource('folderNames_json', folderNames, 'KEYVALUEJSON');
-            return data;
-        })
-        .then(saveArticleFolders);
-};
+  await FD.listCategories()
+    .then(json => {
+      // save category names for translation
+      for (const cat of json.values()) {
+        categoryNames[`${makeTxId(cat)}`] = cat.name
+      }
+      return json
+    })
+    .then(getFolders)
+    .then(data => {
+      data.forEach(item => {
+        folderNames[`${makeTxId(item)}`] = item.name
+      })
+      process.stdout.write('Push category and folder names to Transifex\n')
+      txPushResource('categoryNames_json', categoryNames, 'KEYVALUEJSON')
+      txPushResource('folderNames_json', folderNames, 'KEYVALUEJSON')
+      return data
+    })
+    .then(saveArticleFolders)
+}
 
-syncSources();
+syncSources()

package/scripts/tx-push-src.js

@@ -1,18 +1,18 @@
 #!/usr/bin/env node
 
 /**
- * @fileoverview
+ * @file
  * Script to upload a source en.json file to a particular transifex project resource.
  * Expects that the project and resource have already been defined in Transifex, and that
  * the person running the script has the the TX_TOKEN environment variable set to an api
  * token that has developer access.
  */
 
-const fs = require('fs');
-const path = require('path');
-const {txPush, txCreateResource} = require('../lib/transifex.js');
+const fs = require('fs')
+const path = require('path')
+const { txPush, txCreateResource } = require('../lib/transifex.js')
 
-const args = process.argv.slice(2);
+const args = process.argv.slice(2)
 
 const usage = `
 Push English source strings to Transifex. Usage:
@@ -22,79 +22,79 @@ Push English source strings to Transifex. Usage:
       english-json-file: path to the en.json source
   NOTE: TX_TOKEN environment variable needs to be set with a Transifex API token. See
   the Localization page on the GUI wiki for information about setting up Transifex.
-`;
+`
 
 // Exit if missing arguments or TX_TOKEN
 if (args.length < 3 || !process.env.TX_TOKEN) {
-    process.stdout.write(usage);
-    process.exit(1);
+  process.stdout.write(usage)
+  process.exit(1)
 }
 
 // Globals
-const PROJECT = args[0];
-const RESOURCE = args[1];
+const PROJECT = args[0]
+const RESOURCE = args[1]
 
-let en = fs.readFileSync(path.resolve(args[2]));
-en = JSON.parse(en);
+let en = fs.readFileSync(path.resolve(args[2]))
+en = JSON.parse(en)
 
 // get the correct resource file type based on transifex project/repo and resource
 const getResourceType = (project, resource) => {
-    if (project === 'scratch-website') {
-        // all the resources are KEYVALUEJSON
-        return 'KEYVALUEJSON';
+  if (project === 'scratch-website') {
+    // all the resources are KEYVALUEJSON
+    return 'KEYVALUEJSON'
+  }
+  if (project === 'scratch-legacy') {
+    // all the resources are po files
+    return 'PO'
+  }
+  if (project === 'scratch-editor') {
+    if (resource === 'blocks') {
+      return 'KEYVALUEJSON'
     }
-    if (project === 'scratch-legacy') {
-        // all the resources are po files
-        return 'PO';
-    }
-    if (project === 'scratch-editor') {
-        if (resource === 'blocks') {
-            return 'KEYVALUEJSON';
-        }
-        // everything else is CHROME I18N JSON
-        return 'CHROME';
-    }
-    if (project === 'scratch-videos') {
-        // all the resources are srt files
-        return 'SRT';
-    }
-    if (project === 'scratch-android') {
-        // all the resources are android xml files
-        return 'ANDROID';
-    }
-    if (project === 'scratch-resources') {
-        // all the resources are Chrome format json files
-        return 'CHROME';
-    }
-    process.stdout.write(`Error - Unknown resource type for:\n`);
-    process.stdout.write(`  Project: ${project}, resource: ${resource}\n`);
-    process.exit(1);
-};
+    // everything else is CHROME I18N JSON
+    return 'CHROME'
+  }
+  if (project === 'scratch-videos') {
+    // all the resources are srt files
+    return 'SRT'
+  }
+  if (project === 'scratch-android') {
+    // all the resources are android xml files
+    return 'ANDROID'
+  }
+  if (project === 'scratch-resources') {
+    // all the resources are Chrome format json files
+    return 'CHROME'
+  }
+  process.stdout.write(`Error - Unknown resource type for:\n`)
+  process.stdout.write(`  Project: ${project}, resource: ${resource}\n`)
+  process.exit(1)
+}
 
 // update Transifex with English source
 const pushSource = async function () {
-    try {
-        await txPush(PROJECT, RESOURCE, en);
-    } catch (err) {
-        if (err.statusCode !== 404) {
-            process.stdout.write(`Transifex Error: ${err.message}\n`);
-            process.stdout.write(
-                `Transifex Error ${err.response.statusCode.toString()}: ${err.response.body}\n`);
-            process.exitCode = 1;
-            return;
-        }
-        // file not found - create it, but also give message
-        process.stdout.write(`Transifex Resource not found, creating: ${RESOURCE}\n`);
-        const resourceData = {
-            slug: RESOURCE,
-            name: RESOURCE,
-            priority: 0, // default to normal priority
-            i18nType: getResourceType(PROJECT, RESOURCE),
-            content: en
-        };
-        await txCreateResource(PROJECT, resourceData);
-        process.exitCode = 0;
+  try {
+    await txPush(PROJECT, RESOURCE, en)
+  } catch (err) {
+    if (err.statusCode !== 404) {
+      process.stdout.write(`Transifex Error: ${err.message}\n`)
+      process.stdout.write(`Transifex Error ${err.response.statusCode.toString()}: ${err.response.body}\n`)
+      process.exitCode = 1
+      return
     }
-};
+    // file not found - create it, but also give message
+    process.stdout.write(`Transifex Resource not found, creating: ${RESOURCE}\n`)
+    const resourceData = {
+      slug: RESOURCE,
+      name: RESOURCE,
+      priority: 0, // default to normal priority
+      i18nType: getResourceType(PROJECT, RESOURCE),
+      content: en,
+    }
+    await txCreateResource(PROJECT, resourceData)
+    // eslint-disable-next-line require-atomic-updates -- I promise that `process` won't change across `await`
+    process.exitCode = 0
+  }
+}
 
-pushSource();
+pushSource()