scratch-l10n 5.0.231 → 5.0.232

package/lib/transifex.js

@@ -1,29 +1,29 @@
 #!/usr/bin/env node
 
 /**
- * @fileoverview
+ * @file
  * Utilities for interfacing with Transifex API 3.
  */
 
-const transifexApi = require('@transifex/api').transifexApi;
-const download = require('download');
+const transifexApi = require('@transifex/api').transifexApi
+const download = require('download')
 
 /**
  * @import {Collection, JsonApiResource} from '@transifex/api';
  */
 
-const ORG_NAME = 'llk';
-const SOURCE_LOCALE = 'en';
+const ORG_NAME = 'llk'
+const SOURCE_LOCALE = 'en'
 
 try {
-    transifexApi.setup({
-        auth: process.env.TX_TOKEN
-    });
+  transifexApi.setup({
+    auth: process.env.TX_TOKEN,
+  })
 } catch (err) {
-    if (!process.env.TX_TOKEN) {
-        throw new Error('TX_TOKEN is not defined.');
-    }
-    throw err;
+  if (!process.env.TX_TOKEN) {
+    throw new Error('TX_TOKEN is not defined.')
+  }
+  throw err
 }
 
 /*
@@ -46,13 +46,13 @@ try {
  * @returns {Promise<JsonApiResource[]>} An array of all resources in the collection.
  */
 const collectAll = async function (collection) {
-    await collection.fetch(); // fetch the first page if it hasn't already been fetched
-    const collected = [];
-    for await (const item of collection.all()) {
-        collected.push(item);
-    }
-    return collected;
-};
+  await collection.fetch() // fetch the first page if it hasn't already been fetched
+  const collected = []
+  for await (const item of collection.all()) {
+    collected.push(item)
+  }
+  return collected
+}
 
 /**
  * Creates a download event for a specific project, resource, and locale.
@@ -64,34 +64,34 @@ const collectAll = async function (collection) {
  * @returns {Promise<string>} - URL to download the resource
  */
 const getResourceLocation = async function (projectSlug, resourceSlug, localeCode, mode = 'default') {
-    const resource = {
-        data: {
-            id: `o:${ORG_NAME}:p:${projectSlug}:r:${resourceSlug}`,
-            type: 'resources'
-        }
-    };
-
-    // if locale is English, create a download event of the source file
-    if (localeCode === SOURCE_LOCALE) {
-        return await transifexApi.ResourceStringsAsyncDownload.download({
-            resource
-        });
-    }
-
-    const language = {
-        data: {
-            id: `l:${localeCode}`,
-            type: 'languages'
-        }
-    };
-
-    // if locale is not English, create a download event of the translation file
-    return await transifexApi.ResourceTranslationsAsyncDownload.download({
-        mode,
-        resource,
-        language
-    });
-};
+  const resource = {
+    data: {
+      id: `o:${ORG_NAME}:p:${projectSlug}:r:${resourceSlug}`,
+      type: 'resources',
+    },
+  }
+
+  // if locale is English, create a download event of the source file
+  if (localeCode === SOURCE_LOCALE) {
+    return await transifexApi.ResourceStringsAsyncDownload.download({
+      resource,
+    })
+  }
+
+  const language = {
+    data: {
+      id: `l:${localeCode}`,
+      type: 'languages',
+    },
+  }
+
+  // if locale is not English, create a download event of the translation file
+  return await transifexApi.ResourceTranslationsAsyncDownload.download({
+    mode,
+    resource,
+    language,
+  })
+}
 
 /**
  * Pulls a translation json from transifex, for a specific project, resource, and locale.
@@ -103,67 +103,68 @@ const getResourceLocation = async function (projectSlug, resourceSlug, localeCod
  * strings, if the local is the source language)
  */
 const txPull = async function (project, resource, locale, mode = 'default') {
-    let buffer;
-    try {
-        const url = await getResourceLocation(project, resource, locale, mode);
-        for (let i = 0; i < 5; i++) {
-            if (i > 0) {
-                console.log(`Retrying txPull download after ${i} failed attempt(s)`);
-            }
-            try {
-                buffer = await download(url); // might throw(?)
-                break;
-            } catch (e) {
-                console.error(e, {project, resource, locale, buffer});
-            }
-        }
-        if (!buffer) {
-            throw Error(`txPull download failed after 5 retries: ${url}`);
-        }
-        buffer = buffer.toString();
-        return JSON.parse(buffer);
-    } catch (e) {
-        e.cause = {
-            project,
-            resource,
-            locale,
-            buffer
-        };
-        throw e;
+  let buffer
+  try {
+    const url = await getResourceLocation(project, resource, locale, mode)
+    for (let i = 0; i < 5; i++) {
+      if (i > 0) {
+        console.log(`Retrying txPull download after ${i} failed attempt(s)`)
+      }
+      try {
+        buffer = await download(url) // might throw(?)
+        break
+      } catch (e) {
+        console.error(e, { project, resource, locale, buffer })
+      }
+    }
+    if (!buffer) {
+      throw Error(`txPull download failed after 5 retries: ${url}`)
     }
-};
+    buffer = buffer.toString()
+    return JSON.parse(buffer)
+  } catch (e) {
+    e.cause = {
+      project,
+      resource,
+      locale,
+      buffer,
+    }
+    throw e
+  }
+}
 
 /**
  * Given a project, returns a list of the slugs of all resources in the project
  * @param {string} project - project slug (for example,  "scratch-website")
- * @returns {Promise<array>} - array of strings, slugs identifying each resource in the project
+ * @returns {Promise<Array>} - array of strings, slugs identifying each resource in the project
  */
 const txResources = async function (project) {
-    const resources = transifexApi.Resource.filter({
-        project: `o:${ORG_NAME}:p:${project}`
-    });
-
-    const resourcesData = await collectAll(resources);
-
-    const slugs = resourcesData.map(r =>
-        // r.id is a longer id string, like "o:llk:p:scratch-website:r:about-l10njson"
-        // We just want the slug that comes after ":r:" ("about-l10njson")
-        r.id.split(':r:')[1]
-    );
-    return slugs;
-};
+  const resources = transifexApi.Resource.filter({
+    project: `o:${ORG_NAME}:p:${project}`,
+  })
+
+  const resourcesData = await collectAll(resources)
+
+  const slugs = resourcesData.map(
+    r =>
+      // r.id is a longer id string, like "o:llk:p:scratch-website:r:about-l10njson"
+      // We just want the slug that comes after ":r:" ("about-l10njson")
+      r.id.split(':r:')[1],
+  )
+  return slugs
+}
 
 /**
  * @param {string} project - project slug (for example)
  * @returns {Promise<JsonApiResource[]>} - array of resource objects
  */
 const txResourcesObjects = async function (project) {
-    const resources = transifexApi.Resource.filter({
-        project: `o:${ORG_NAME}:p:${project}`
-    });
+  const resources = transifexApi.Resource.filter({
+    project: `o:${ORG_NAME}:p:${project}`,
+  })
 
-    return collectAll(resources);
-};
+  return collectAll(resources)
+}
 
 /**
  * Gets available languages for a project
@@ -171,15 +172,15 @@ const txResourcesObjects = async function (project) {
  * @returns {Promise<string[]>} - list of language codes
  */
 const txAvailableLanguages = async function (slug) {
-    const project = await transifexApi.Project.get({
-        organization: `o:${ORG_NAME}`,
-        slug: slug
-    });
-
-    const languages = await project.fetch('languages');
-    const languagesData = await collectAll(languages);
-    return languagesData.map(l => l.attributes.code);
-};
+  const project = await transifexApi.Project.get({
+    organization: `o:${ORG_NAME}`,
+    slug: slug,
+  })
+
+  const languages = await project.fetch('languages')
+  const languagesData = await collectAll(languages)
+  return languagesData.map(l => l.attributes.code)
+}
 
 /**
  * Uploads English source strings to a resource in transifex
@@ -188,54 +189,54 @@ const txAvailableLanguages = async function (slug) {
  * @param {object} sourceStrings - json of source strings
  */
 const txPush = async function (project, resource, sourceStrings) {
-    const resourceObj = {
-        data: {
-            id: `o:${ORG_NAME}:p:${project}:r:${resource}`,
-            type: 'resources'
-        }
-    };
-
-    await transifexApi.ResourceStringsAsyncUpload.upload({
-        resource: resourceObj,
-        content: JSON.stringify(sourceStrings)
-    });
-};
+  const resourceObj = {
+    data: {
+      id: `o:${ORG_NAME}:p:${project}:r:${resource}`,
+      type: 'resources',
+    },
+  }
+
+  await transifexApi.ResourceStringsAsyncUpload.upload({
+    resource: resourceObj,
+    content: JSON.stringify(sourceStrings),
+  })
+}
 
 /**
  * Creates a new resource, and then uploads source strings to it if they are provided
  * @param {string} project - project slug (for example,  "scratch-editor")
  * @param {object} resource - object of resource information
  * @param {string} resource.slug - resource slug (for example,  "blocks")
- * @param {string} resource.name - resource name
+ * @param {string} resource.name - human-readable name for the resource
  * @param {string} resource.i18nType - i18n format id
  * @param {object} resource.sourceStrings - json object of source strings
  */
-const txCreateResource = async function (project, {slug, name, i18nType, sourceStrings}) {
-    const i18nFormat = {
-        data: {
-            id: i18nType || 'KEYVALUEJSON',
-            type: 'i18n_formats'
-        }
-    };
-
-    const projectObj = {
-        data: {
-            id: `o:${ORG_NAME}:p:${project}`,
-            type: 'projects'
-        }
-    };
-
-    await transifexApi.Resource.create({
-        attributes: {slug: slug, name: name},
-        relationships: {
-            i18n_format: i18nFormat,
-            project: projectObj
-        }
-    });
-
-    if (sourceStrings) {
-        await txPush(project, slug, sourceStrings);
-    }
-};
+const txCreateResource = async function (project, { slug, name, i18nType, sourceStrings }) {
+  const i18nFormat = {
+    data: {
+      id: i18nType || 'KEYVALUEJSON',
+      type: 'i18n_formats',
+    },
+  }
+
+  const projectObj = {
+    data: {
+      id: `o:${ORG_NAME}:p:${project}`,
+      type: 'projects',
+    },
+  }
+
+  await transifexApi.Resource.create({
+    attributes: { slug: slug, name: name },
+    relationships: {
+      i18n_format: i18nFormat,
+      project: projectObj,
+    },
+  })
+
+  if (sourceStrings) {
+    await txPush(project, slug, sourceStrings)
+  }
+}
 
-module.exports = {txPull, txPush, txResources, txResourcesObjects, txCreateResource, txAvailableLanguages};
+module.exports = { txPull, txPush, txResources, txResourcesObjects, txCreateResource, txAvailableLanguages }

package/lib/validate.mjs

@@ -1,5 +1,5 @@
-import assert from 'assert';
-import parse from 'format-message-parse';
+import assert from 'assert'
+import parse from 'format-message-parse'
 
 // filter placeholders out of a message
 // parse('a message with a {value} and {count, plural, one {one} other {more}}.')
@@ -11,37 +11,38 @@ import parse from 'format-message-parse';
 //   '.'
 // ]
 // placeholders are always an array, so filter for array elements to find the placeholders
-const placeholders = message => (
-    // this will throw an error if the message is not valid ICU
-    // single quote (as in French l'année) messes up the parse and is not
-    // relevant for this check, so strip them out
-    parse(message.replace(/'/g, '')).filter(item => Array.isArray(item))
-);
+const placeholders = message =>
+  // this will throw an error if the message is not valid ICU
+  // single quote (as in French l'année) messes up the parse and is not
+  // relevant for this check, so strip them out
+  parse(message.replace(/'/g, '')).filter(item => Array.isArray(item))
 
 const validMessage = (message, source) => {
-    const transPlaceholders = placeholders(message.toString());
-    const srcPlaceholders = placeholders(source.toString());
-    // different number of placeholders
-    if (transPlaceholders.length !== srcPlaceholders.length) {
-        return false;
-    }
-    // TODO: Add checking to make sure placeholders in source have not been translated
-    // TODO: Add validation of scratch-blocks placeholders
-    return true;
-};
+  const transPlaceholders = placeholders(message.toString())
+  const srcPlaceholders = placeholders(source.toString())
+  // different number of placeholders
+  if (transPlaceholders.length !== srcPlaceholders.length) {
+    return false
+  }
+  // TODO: Add checking to make sure placeholders in source have not been translated
+  // TODO: Add validation of scratch-blocks placeholders
+  return true
+}
 
 const validateTranslations = (translation, source) => {
-    const locale = translation.locale;
-    const translations = translation.translations;
-    const transKeys = Object.keys(translations);
-    const sourceKeys = Object.keys(source);
-    assert.strictEqual(transKeys.length, sourceKeys.length, `locale ${locale} has a different number of message keys`);
-    transKeys.map(item => assert(sourceKeys.includes(item), `locale ${locale} has key ${item} not in the source`));
-    sourceKeys.map(item => assert(transKeys.includes(item), `locale ${locale} is missing key ${item}`));
-    sourceKeys.map(item => assert(
-        validMessage(translations[item], source[item]),
-        `locale ${locale}: "${translations[item]}" is not a valid translation for "${source[item]}"`)
-    );
-};
+  const locale = translation.locale
+  const translations = translation.translations
+  const transKeys = Object.keys(translations)
+  const sourceKeys = Object.keys(source)
+  assert.strictEqual(transKeys.length, sourceKeys.length, `locale ${locale} has a different number of message keys`)
+  transKeys.map(item => assert(sourceKeys.includes(item), `locale ${locale} has key ${item} not in the source`))
+  sourceKeys.map(item => assert(transKeys.includes(item), `locale ${locale} is missing key ${item}`))
+  sourceKeys.map(item =>
+    assert(
+      validMessage(translations[item], source[item]),
+      `locale ${locale}: "${translations[item]}" is not a valid translation for "${source[item]}"`,
+    ),
+  )
+}
 
-export {validateTranslations, validMessage};
+export { validateTranslations, validMessage }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scratch-l10n",
-  "version": "5.0.231",
+  "version": "5.0.232",
   "description": "Localization for the Scratch 3.0 components",
   "main": "./dist/l10n.js",
   "browser": "./src/index.mjs",
@@ -12,8 +12,9 @@
     "build": "npm run clean && npm run build:data && webpack --progress --colors --bail",
     "build:data": "node scripts/build-data.mjs",
     "clean": "rimraf ./dist ./locales && mkdirp dist locales",
+    "format": "prettier --write . && eslint --fix",
     "lint": "npm run lint:js && npm run lint:json",
-    "lint:js": "eslint . --ext .js,.mjs,.cjs",
+    "lint:js": "eslint && prettier --check .",
     "lint:json": "jshint -e .json www editor/blocks editor/extensions editor/interface editor/paint-editor",
     "prepare": "husky install",
     "pull:blocks": "node scripts/tx-pull-editor.mjs scratch-editor blocks ./editor/blocks/",
@@ -54,7 +55,6 @@
   "devDependencies": {
     "@babel/cli": "7.27.1",
     "@babel/core": "7.27.1",
-    "@babel/eslint-parser": "7.27.1",
     "@babel/node": "7.27.1",
     "@babel/plugin-proposal-object-rest-spread": "7.20.7",
     "@babel/plugin-syntax-dynamic-import": "7.8.3",
@@ -64,16 +64,14 @@
     "@commitlint/cli": "18.6.1",
     "@commitlint/config-conventional": "18.6.3",
     "async": "3.2.6",
-    "babel-eslint": "10.1.0",
     "babel-loader": "8.4.1",
     "babel-plugin-react-intl": "3.5.1",
-    "eslint": "8.57.1",
-    "eslint-config-scratch": "9.0.9",
-    "eslint-plugin-import": "2.31.0",
-    "eslint-plugin-react": "7.37.5",
+    "eslint": "9.26.0",
+    "eslint-config-scratch": "11.0.1",
     "format-message-cli": "6.2.4",
     "format-message-parse": "6.2.4",
     "glob": "7.2.3",
+    "globals": "16.0.0",
     "husky": "8.0.3",
     "jshint": "2.13.6",
     "json": "^9.0.6",
@@ -83,6 +81,7 @@
     "node-fetch": "2.7.0",
     "p-limit": "2.3.0",
     "p-queue": "3.2.0",
+    "prettier": "3.5.3",
     "rimraf": "2.7.1",
     "scratch-semantic-release-config": "3.0.0",
     "semantic-release": "19.0.5",

package/prettier.config.mjs

@@ -0,0 +1,3 @@
+import { prettierConfigScratch } from 'eslint-config-scratch'
+
+export default prettierConfigScratch.recommended

package/release.config.js

@@ -1,14 +1,14 @@
 module.exports = {
-    extends: 'scratch-semantic-release-config',
-    branches: [
-        {
-            name: 'master'
-            // default channel
-        },
-        {
-            name: 'hotfix/*',
-            channel: 'hotfix',
-            prerelease: 'hotfix'
-        }
-    ]
-};
+  extends: 'scratch-semantic-release-config',
+  branches: [
+    {
+      name: 'master',
+      // default channel
+    },
+    {
+      name: 'hotfix/*',
+      channel: 'hotfix',
+      prerelease: 'hotfix',
+    },
+  ],
+}

package/renovate.json5

@@ -1,7 +1,5 @@
 {
-    "$schema": "https://docs.renovatebot.com/renovate-schema.json",
-    "extends": [
-        "github>scratchfoundation/scratch-renovate-config:js-lib-bundled"
-    ],
-    "baseBranches": ["master"]
+  $schema: 'https://docs.renovatebot.com/renovate-schema.json',
+  extends: ['github>scratchfoundation/scratch-renovate-config:js-lib-bundled'],
+  baseBranches: ['master'],
 }

package/scripts/build-data.mjs

@@ -1,5 +1,4 @@
 #!/usr/bin/env node
-
 /*
 Generates locales/<component>-msgs.js for each component (gui, etc) from  the
 current translation files for each language for that component
@@ -38,63 +37,48 @@ NOTE: blocks messages are plain key-value JSON files
 
 Missing locales are ignored, react-intl will use the default messages for them.
  */
-import * as fs from 'fs';
-import * as path from 'path';
-import mkdirp from 'mkdirp';
-import defaultsDeep from 'lodash.defaultsdeep';
-import locales from '../src/supported-locales.mjs';
+import * as fs from 'fs'
+import defaultsDeep from 'lodash.defaultsdeep'
+import mkdirp from 'mkdirp'
+import * as path from 'path'
+import locales from '../src/supported-locales.mjs'
 
-const MSGS_DIR = './locales/';
-mkdirp.sync(MSGS_DIR);
-let missingLocales = [];
+const MSGS_DIR = './locales/'
+mkdirp.sync(MSGS_DIR)
+const missingLocales = []
 
-const combineJson = (component) => {
-    return Object.keys(locales).reduce((collection, lang) => {
-        try {
-            let langData = JSON.parse(
-                fs.readFileSync(path.resolve('editor', component, lang + '.json'), 'utf8')
-            );
-            collection[lang] = langData;
-        } catch (e) {
-            missingLocales.push(component + ':' + lang + '\n');
-        }
-        return collection;
-    }, {});
-};
+const combineJson = component =>
+  Object.keys(locales).reduce((collection, lang) => {
+    try {
+      const langData = JSON.parse(fs.readFileSync(path.resolve('editor', component, lang + '.json'), 'utf8'))
+      collection[lang] = langData
+    } catch {
+      missingLocales.push(component + ':' + lang + '\n')
+    }
+    return collection
+  }, {})
 
 // generate the blocks messages: files are plain key-value JSON
-let blocksMessages = combineJson('blocks');
-let blockData =
-    '// GENERATED FILE:\n' +
-    'export default ' +
-    JSON.stringify(blocksMessages, null, 2) +
-    ';\n';
+const blocksMessages = combineJson('blocks')
+const blockData = '// GENERATED FILE:\n' + 'export default ' + JSON.stringify(blocksMessages, null, 2) + ';\n'
 
-fs.writeFileSync(MSGS_DIR + 'blocks-msgs.js', blockData);
+fs.writeFileSync(MSGS_DIR + 'blocks-msgs.js', blockData)
 
 // generate messages for gui components - all files are plain key-value JSON
-let components = ['interface', 'extensions', 'paint-editor'];
-let editorMsgs = {};
-components.forEach((component) => {
-    let messages = combineJson(component);
-    let data =
-        '// GENERATED FILE:\n' +
-        'export default ' +
-        JSON.stringify(messages, null, 2) +
-        ';\n';
-    fs.writeFileSync(MSGS_DIR + component + '-msgs.js', data);
-    defaultsDeep(editorMsgs, messages);
-});
+const components = ['interface', 'extensions', 'paint-editor']
+const editorMsgs = {}
+components.forEach(component => {
+  const messages = combineJson(component)
+  const data = '// GENERATED FILE:\n' + 'export default ' + JSON.stringify(messages, null, 2) + ';\n'
+  fs.writeFileSync(MSGS_DIR + component + '-msgs.js', data)
+  defaultsDeep(editorMsgs, messages)
+})
 
 // generate combined editor-msgs file
-let editorData =
-    '// GENERATED FILE:\n' +
-    'export default ' +
-    JSON.stringify(editorMsgs, null, 2) +
-    ';\n';
-fs.writeFileSync(MSGS_DIR + 'editor-msgs.js', editorData);
+const editorData = '// GENERATED FILE:\n' + 'export default ' + JSON.stringify(editorMsgs, null, 2) + ';\n'
+fs.writeFileSync(MSGS_DIR + 'editor-msgs.js', editorData)
 
 if (missingLocales.length > 0) {
-    process.stdout.write('missing locales:\n' + missingLocales.toString());
-    process.exit(1);
+  process.stdout.write('missing locales:\n' + missingLocales.toString())
+  process.exit(1)
 }