@freckle/i18n-scripts 1.1.23 → 3.0.0

package/dist/check-i18n-variables.js

@@ -1,16 +1,128 @@
 #!/usr/bin/env node
+//
+// Checks all locize keys (in the codebase) with known variables against key
+// values in locize ensuring that variables in locize refer to known vars.
+//
+import HttpBackend from 'i18next-http-backend'
+import ICU from 'i18next-icu'
+import i18next from 'i18next'
+import {IntlMessageFormat} from 'intl-messageformat'
 
-const {spawn} = require('node:child_process')
-const path = require('path')
+import {getFiles, filterJsFiles, supportedLngs} from './helpers.js'
+import {extractTranslationKeysAndVariables, KNOWN_VARIABLES_TAG} from './translation-extraction.js'
 
-const [_nodeBin, scriptPath, ...args] = process.argv
+const [_nodeBin, _scriptPath, ...projects] = process.argv
 
-const proc = spawn(`${path.dirname(scriptPath)}/check-i18n-variables`, args)
+if (projects.length < 1) {
+  console.error('Usage: check-i18n-variables <path>')
+  process.exit(64)
+}
 
-proc.stdout.on('data', data => {
-  process.stdout.write(data)
-})
+// TODO: Pass in via ENV?
+const ns = ['school', 'student', 'console', 'classroom', 'common']
 
-proc.stderr.on('data', data => {
-  process.stderr.write(data)
-})
+const translationKeysWithKnownVariablesInProject = async project => {
+  const files = await getFiles(project)
+  const jsFiles = files.filter(filterJsFiles)
+  const results = []
+
+  jsFiles.forEach(({path}) => {
+    extractTranslationKeysAndVariables(path)
+      .filter(({tag}) => tag === KNOWN_VARIABLES_TAG)
+      .forEach(keyWithVars => results.push(keyWithVars))
+  })
+
+  return results
+}
+
+// The AST is undocumented, however, its type definitions are here
+//    https://github.com/formatjs/formatjs/blob/82a2e5d07f9a999624ffb6387a58464f9a5f7399/packages/icu-messageformat-parser/types.ts#L122-L131
+const extractVariablesFromICUAst = ast => {
+  // Some AST field values are `null`
+  if (!ast) {
+    return []
+  }
+
+  if (ast.constructor === Array) {
+    return ast.flatMap(extractVariablesFromICUAst)
+  }
+  if (ast.constructor === Object) {
+    const subVariables = Object.values(ast).flatMap(extractVariablesFromICUAst)
+    // `type`s that aren't 0 (string literals) are variables when `.value` exists
+    const hasVariable = ast.type && typeof ast.type === 'number' && ast.type !== 0 && ast.value
+
+    return (hasVariable ? [ast.value] : []).concat(subVariables)
+  }
+
+  return []
+}
+
+const main = async () => {
+  await i18next
+    .use(ICU)
+    .use(HttpBackend)
+    .init({
+      supportedLngs,
+      allowMultiLoading: true,
+      keySeparator: false,
+      ns,
+      backend: {
+        loadPath: 'https://translations.freckle.com/latest/{{lng}}/{{ns}}'
+      }
+    })
+
+  let anyErrors = false
+
+  // Project key extraction is not cheap so cache per project
+  const keysPerProject = {}
+
+  await Promise.all(
+    projects.map(
+      async project =>
+        (keysPerProject[project] = await translationKeysWithKnownVariablesInProject(project))
+    )
+  )
+
+  for (const lang of supportedLngs) {
+    await i18next.changeLanguage(lang)
+    const translations = i18next.getDataByLanguage(lang)
+
+    for (const [project, keys] of Object.entries(keysPerProject)) {
+      for (const {i18nKey, variables: codeVariables} of keys) {
+        const keyValue =
+          (translations[project] && translations[project][i18nKey]) || translations.common[i18nKey]
+
+        try {
+          if (keyValue) {
+            const locizeVariables = extractVariablesFromICUAst(
+              new IntlMessageFormat(keyValue, lang, {}, {ignoreTag: true}).getAst()
+            )
+
+            for (const locizeVariable of locizeVariables) {
+              if (!codeVariables.includes(locizeVariable)) {
+                anyErrors = true
+                console.error(
+                  `${project}:${lang}:${i18nKey} does not pass the variable ${locizeVariable}`
+                )
+              }
+            }
+          }
+        } catch {
+          // We have another script that checks that `IntlMessageFormat` can
+          // successfully parse the ICU text so let's not fail for that reason.
+        }
+      }
+    }
+  }
+
+  if (anyErrors) {
+    console.error(
+      'The above keys have variables not passed by the code and need to be fixed in Locize.'
+    )
+    process.exit(1)
+  } else {
+    process.exit(0)
+  }
+}
+
+main()

package/dist/check-i18next-icu-parser.js

@@ -1,16 +1,63 @@
 #!/usr/bin/env node
+//
+// Checks all keys in Locize to make sure that they can be parsed by the `i18next` `t` function
+//
+import HttpBackend from 'i18next-http-backend'
+import ICU from 'i18next-icu'
+import i18next from 'i18next'
 
-const {spawn} = require('node:child_process')
-const path = require('path')
+import {supportedLngs} from './helpers.js'
 
-const [_nodeBin, scriptPath, ...args] = process.argv
+const VALID_NAMESPACES = ['school', 'student', 'console', 'classroom', 'common']
 
-const proc = spawn(`${path.dirname(scriptPath)}/check-i18next-icu-parser`, args)
+const ns = process.argv.slice(2)
 
-proc.stdout.on('data', data => {
-  process.stdout.write(data)
-})
+for (const arg of ns) {
+  if (!VALID_NAMESPACES.some(ns => ns === arg)) {
+    throw new Error(`Invalid arguments: ${arg} is not a namespace`)
+  }
+}
 
-proc.stderr.on('data', data => {
-  process.stderr.write(data)
-})
+const main = async () => {
+  const t = await i18next
+    .use(ICU)
+    .use(HttpBackend)
+    .init({
+      supportedLngs,
+      allowMultiLoading: true,
+      keySeparator: false,
+      ns,
+      backend: {
+        loadPath: 'https://translations.freckle.com/latest/{{lng}}/{{ns}}'
+      }
+    })
+
+  let anyErrors = false
+
+  for (const l of supportedLngs) {
+    await i18next.changeLanguage(l)
+    for (const n of ns) {
+      for (const key of Object.keys(i18next.getDataByLanguage(l)[n])) {
+        try {
+          t(`${n}:${key}`)
+        } catch (error) {
+          if (!isInterpolationError(error)) {
+            anyErrors = true
+            console.error(`${n}:${l}:${key}`)
+          }
+        }
+      }
+    }
+  }
+
+  if (anyErrors) {
+    console.error('The above keys cannot be parsed as ICU and need to be fixed in Locize.')
+    process.exit(1)
+  } else {
+    process.exit(0)
+  }
+}
+
+const isInterpolationError = error => /^The intl string context variable/.test(error.message)
+
+main()

package/dist/check-missing-translations

@@ -9,7 +9,7 @@ translation_keys_in_code() {
   git ls-files "$project_path" |
     grep -E '\.(js|ts|tsx)$' |
     grep -v '\.min\.js$' |
-    "$script_dir/translation-keys"
+    "$script_dir/translation-keys.js"
 }
 
 translation_keys_in_locize() {

package/dist/helpers.js

@@ -1,9 +1,8 @@
-#!/usr/bin/env node
-const {promises: fs} = require('fs')
-const p = require('path')
+import {promises as fs} from 'node:fs'
+import p from 'node:path'
 
 // Modified from https://dev.to/leonard/get-files-recursive-with-the-node-js-file-system-fs-2n7o
-async function getFiles(path) {
+export async function getFiles(path) {
   const allEntries = await fs.readdir(path, {withFileTypes: true})
 
   const entries = allEntries.filter(file => file.name !== 'node_modules' && file.name !== '.cache')
@@ -21,14 +20,8 @@ async function getFiles(path) {
   return files
 }
 
-module.exports.getFiles = getFiles
-
-const filterJsFiles = f =>
+export const filterJsFiles = f =>
   (f.name.endsWith('.js') || f.name.endsWith('.ts') || f.name.endsWith('.tsx')) &&
   !f.name.endsWith('min.js')
 
-module.exports.filterJsFiles = filterJsFiles
-
-const supportedLngs = ['es', 'en', 'en-GB']
-
-module.exports.supportedLngs = supportedLngs
+export const supportedLngs = ['es', 'en', 'en-GB']

package/dist/translation-extraction.js

@@ -1,6 +1,6 @@
-const fs = require('fs')
-const parser = require('flow-parser')
-const walk = require('esprima-walk')
+import fs from 'node:fs'
+import parser from 'flow-parser'
+import walk from 'esprima-walk'
 
 const isIdentifierT = node => node && node.type === 'Identifier' && node.name === 't'
 
@@ -24,8 +24,8 @@ const isObjectWithSimpleProperties = node =>
   node.type === 'ObjectExpression' &&
   node.properties.every(p => p.type === 'Property' && p.key.type === 'Identifier')
 
-const KNOWN_VARIABLES_TAG = 'i18n-key-with-known-variables'
-const UNKNOWN_VARIABLES_TAG = 'i18n-key-with-unknown-variables'
+export const KNOWN_VARIABLES_TAG = 'i18n-key-with-known-variables'
+export const UNKNOWN_VARIABLES_TAG = 'i18n-key-with-unknown-variables'
 
 const knownVariables = (source, i18nKey, objectWithSimpleProperties) => ({
   tag: KNOWN_VARIABLES_TAG,
@@ -47,9 +47,6 @@ const unknownVariables = (source, i18nKey) => ({
   i18nKey
 })
 
-module.exports.KNOWN_VARIABLES_TAG = KNOWN_VARIABLES_TAG
-module.exports.UNKNOWN_VARIABLES_TAG = UNKNOWN_VARIABLES_TAG
-
 // Attempt to find all translations keys and their provided variables in use in JS files.
 //
 // Methodology:
@@ -67,7 +64,7 @@ module.exports.UNKNOWN_VARIABLES_TAG = UNKNOWN_VARIABLES_TAG
 //       are not known
 //
 // Yields keys with variables as encountered without sorting or de-duplication.
-module.exports.extractTranslationKeysAndVariables = path => {
+export const extractTranslationKeysAndVariables = path => {
   const content = fs.readFileSync(path, {encoding: 'utf8'})
   const ast = parser.parse(content)
 

package/{src/translation-keys → dist/translation-keys.js}

@@ -7,21 +7,20 @@
 //   git ls-files |
 //      grep '\.js$' |
 //      grep -v '\.min\.js$' |
-//     ./scripts/translation-keys
+//     ./scripts/translation-keys.js
 //
 // We stream out the keys as seen. We do no sorting or de-duplication.
 //
-const {extractTranslationKeysAndVariables} = require('./translation-extraction.js')
-const readline = require('readline')
+import readline from 'node:readline'
 
-const interface = readline.createInterface({
+import {extractTranslationKeysAndVariables} from './translation-extraction.js'
+
+const lines = readline.createInterface({
   input: process.stdin,
   output: process.stdout,
   terminal: false
 })
 
-interface.on('line', path => {
-  extractTranslationKeysAndVariables(path).forEach(({i18nKey}) =>
-    console.log(i18nKey)
-  )
+lines.on('line', path => {
+  extractTranslationKeysAndVariables(path).forEach(({i18nKey}) => console.log(i18nKey))
 })

package/package.json

@@ -1,15 +1,18 @@
 {
   "name": "@freckle/i18n-scripts",
-  "version": "1.1.23",
+  "version": "3.0.0",
   "description": "Scripts for i18n",
   "author": "Renaissance Learning Inc",
   "license": "MIT",
+  "type": "module",
   "bin": {
     "check-i18n-variables": "./dist/check-i18n-variables.js",
     "check-i18next-icu-parser": "./dist/check-i18next-icu-parser.js",
-    "check-missing-translations": "./dist/check-missing-translations.js"
+    "check-missing-translations": "./dist/check-missing-translations"
   },
-  "main": "./dist/index.js",
+  "files": [
+    "dist"
+  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/freckle/i18n-scripts-js.git"
@@ -22,7 +25,7 @@
   },
   "dependencies": {
     "esprima-walk": "0.1.0",
-    "flow-parser": "0.332.0",
+    "flow-parser": "0.333.0",
     "i18next": "26.4.2",
     "i18next-http-backend": "^4.0.2",
     "i18next-icu": "^2.4.4",
@@ -32,7 +35,7 @@
     "@freckle/eslint-config": "^1.1.0",
     "eslint": "^10.11.0",
     "globals": "^17.12.0",
-    "prettier": "^3.9.8"
+    "prettier": "^3.9.9"
   },
   "packageManager": "pnpm@12.6.0+sha512.3ef68f951cb111ac204b4a5a16f0b2ddf0da56a96e0413e81d855d9f0b55ef926714709028e1cd00c405c2c5fb7b9e8ec4dc46777c805d0373c2f2ff00fd20ec"
 }

package/.github/CODEOWNERS

@@ -1 +0,0 @@
-* @freckle/team-student-activities

package/.github/workflows/ci.yml

@@ -1,27 +0,0 @@
-name: CI
-
-on:
-  pull_request:
-  push:
-    branches: main
-
-permissions:
-  contents: read
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v7
-      - uses: pnpm/action-setup@v6
-      - uses: actions/setup-node@v7
-        with:
-          node-version-file: .nvmrc
-          cache: pnpm
-      - run: pnpm install --frozen-lockfile
-      - run: pnpm format-check
-      - run: pnpm lint
-      - run: pnpm build
-      - uses: freckle/check-git-clean-action@v1
-        with:
-          hint: "Run pnpm build to update your dist/"

package/.github/workflows/mergeabot.yml

@@ -1,19 +0,0 @@
-name: Mergeabot
-
-on:
-  schedule:
-    - cron: "0 0 * * *"
-
-  pull_request:
-
-permissions:
-  contents: write
-  pull-requests: write
-
-jobs:
-  mergeabot:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: freckle/mergeabot-action@v3
-        with:
-          quarantine-days: -1

package/.github/workflows/release.yml

@@ -1,26 +0,0 @@
-name: Release
-
-on:
-  push:
-    branches:
-      - main
-      - rc/*
-
-permissions:
-  contents: write
-
-jobs:
-  release:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v7
-      - uses: cycjimmy/semantic-release-action@v6.0.0
-        # conventional-changelog-conventionalcommits is held at 9.x: v10 needs
-        # conventional-changelog-writer@9, which semantic-release@25 does not ship.
-        with:
-          extra_plugins: |
-            conventional-changelog-conventionalcommits@9
-        env:
-          FORCE_COLOR: 1
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-          GITHUB_TOKEN: ${{ github.token }}

package/.nvmrc

@@ -1 +0,0 @@
-24.21.0

package/.prettierrc

@@ -1,18 +0,0 @@
-{
-  "printWidth": 100,
-  "tabWidth": 2,
-  "useTabs": false,
-  "semi": false,
-  "singleQuote": true,
-  "quoteProps": "as-needed",
-  "jsxSingleQuote": false,
-  "trailingComma": "none",
-  "bracketSpacing": false,
-  "bracketSameLine": false,
-  "arrowParens": "avoid",
-  "requirePragma": false,
-  "insertPragma": false,
-  "proseWrap": "preserve",
-  "htmlWhitespaceSensitivity": "css",
-  "endOfLine": "auto"
-}

package/.releaserc.yaml

@@ -1,15 +0,0 @@
-# .releaserc.yaml
-plugins:
-  - - '@semantic-release/commit-analyzer'
-    - preset: 'conventionalcommits'
-  - - '@semantic-release/release-notes-generator'
-    - preset: 'conventionalcommits'
-  - - '@semantic-release/github'
-    - successCommentCondition: false
-
-  - '@semantic-release/npm'
-
-branches:
-  - main
-  - name: rc/*
-    prerelease: '${name.replace(/^rc\//, "rc-")}'

package/.restyled.yaml

@@ -1,12 +0,0 @@
-restylers:
-  - clang-format:
-      enabled: false
-  - jq:
-      enabled: false # prefer prettier-json
-  - prettier:
-      include:
-        - 'src/**/*.js'
-  - whitespace:
-      include:
-        - '**/*'
-        - '!dist/*'

package/RELEASE.md

@@ -1,14 +0,0 @@
-# Release
-
-This project uses [semantic-release](https://github.com/semantic-release/semantic-release)
-with [conventional commits](https://www.conventionalcommits.org/) to trigger releases.
-
-To trigger a release in this project, merge a commit to `main` prefixed with:
-
-1. `fix:` to trigger a patch release,
-1. `feat:` to trigger minor, or
-1. Use `<type>!:` or the `BREAKING CHANGES: <change>` footer to trigger major
-
-Pre-releases can be made by pushing to an `rc/*` branch.
-
-For more details, see the [Semantic Release](https://illuminate.atlassian.net/wiki/spaces/PENG/pages/17952735277/Semantic+Release) documentation.

package/dist/check-i18n-variables

@@ -1,133 +0,0 @@
-#!/usr/bin/env node
-//
-// Checks all locize keys (in the codebase) with known variables against key
-// values in locize ensuring that variables in locize refer to known vars.
-//
-const {promises: fs} = require('fs')
-const p = require('path')
-const i18next = require('i18next')
-const ICU = require('i18next-icu')
-const HttpBackend = require('i18next-http-backend')
-const {IntlMessageFormat} = require('intl-messageformat')
-
-const {
-  extractTranslationKeysAndVariables,
-  KNOWN_VARIABLES_TAG
-} = require('./translation-extraction.js')
-const {getFiles, filterJsFiles, supportedLngs} = require('./helpers.js')
-
-const [_nodeBin, _scriptPath, ...projects] = process.argv
-
-if (projects.length < 1) {
-  console.log('Usage: check-i18n-variables <path>')
-  return
-}
-
-// TODO: Pass in via ENV?
-const ns = ['school', 'student', 'console', 'classroom', 'common']
-
-const translationKeysWithKnownVariablesInProject = async project => {
-  const files = await getFiles(project)
-  const jsFiles = files.filter(filterJsFiles)
-  const results = []
-
-  jsFiles.forEach(({path}) => {
-    extractTranslationKeysAndVariables(path)
-      .filter(({tag}) => tag === KNOWN_VARIABLES_TAG)
-      .forEach(keyWithVars => results.push(keyWithVars))
-  })
-
-  return results
-}
-
-// The AST is undocumented, however, its type definitions are here
-//    https://github.com/formatjs/formatjs/blob/82a2e5d07f9a999624ffb6387a58464f9a5f7399/packages/icu-messageformat-parser/types.ts#L122-L131
-const extractVariablesFromICUAst = ast => {
-  // Some AST field values are `null`
-  if (!ast) {
-    return []
-  }
-
-  if (ast.constructor === Array) {
-    return ast.flatMap(extractVariablesFromICUAst)
-  }
-  if (ast.constructor === Object) {
-    const subVariables = Object.values(ast).flatMap(extractVariablesFromICUAst)
-    // `type`s that aren't 0 (string literals) are variables when `.value` exists
-    const hasVariable = ast.type && typeof ast.type === 'number' && ast.type !== 0 && ast.value
-
-    return (hasVariable ? [ast.value] : []).concat(subVariables)
-  }
-
-  return []
-}
-
-const main = async () => {
-  const t = await i18next
-    .use(ICU)
-    .use(HttpBackend)
-    .init({
-      supportedLngs,
-      allowMultiLoading: true,
-      keySeparator: false,
-      ns,
-      backend: {
-        loadPath: 'https://translations.freckle.com/latest/{{lng}}/{{ns}}'
-      }
-    })
-
-  let anyErrors = false
-
-  // Project key extraction is not cheap so cache per project
-  const keysPerProject = {}
-
-  await Promise.all(
-    projects.map(
-      async project =>
-        (keysPerProject[project] = await translationKeysWithKnownVariablesInProject(project))
-    )
-  )
-
-  for (const lang of supportedLngs) {
-    await i18next.changeLanguage(lang)
-    const translations = i18next.getDataByLanguage(lang)
-
-    for (const [project, keys] of Object.entries(keysPerProject)) {
-      for (const {i18nKey, variables: codeVariables} of keys) {
-        const keyValue =
-          (translations[project] && translations[project][i18nKey]) || translations.common[i18nKey]
-
-        try {
-          if (keyValue) {
-            const locizeVariables = extractVariablesFromICUAst(
-              new IntlMessageFormat(keyValue, lang, {}, {ignoreTag: true}).getAst()
-            )
-
-            for (const locizeVariable of locizeVariables) {
-              if (!codeVariables.includes(locizeVariable)) {
-                anyErrors = true
-                console.error(
-                  `${project}:${lang}:${i18nKey} does not pass the variable ${locizeVariable}`
-                )
-              }
-            }
-          }
-        } catch (e) {
-          // We have another script that checks that `IntlMessageFormat` can
-          // successfully parse the ICU text so let's not fail for that reason.
-        }
-      }
-    }
-  }
-
-  if (anyErrors) {
-    console.error(
-      'The above keys have variables not passed by the code and need to be fixed in Locize.'
-    )
-    process.exit(1)
-  } else {
-    process.exit(0)
-  }
-}
-
-main()

package/dist/check-i18next-icu-parser

@@ -1,64 +0,0 @@
-#!/usr/bin/env node
-// @flow
-//
-// Checks all keys in Locize to make sure that they can be parsed by the `i18next` `t` function
-//
-const i18next = require('i18next')
-const ICU = require('i18next-icu')
-const HttpBackend = require('i18next-http-backend')
-const {supportedLngs} = require('./helpers.js')
-
-const VALID_NAMESPACES = ['school', 'student', 'console', 'classroom', 'common']
-
-const ns = process.argv.slice(2)
-
-for (const arg of ns) {
-  if (!VALID_NAMESPACES.some(ns => ns === arg)) {
-    throw new Error(`Invalid arguments: ${arg} is not a namespace`)
-  }
-}
-
-
-const main = async () => {
-  const t = await i18next
-    .use(ICU)
-    .use(HttpBackend)
-    .init({
-      supportedLngs,
-      allowMultiLoading: true,
-      keySeparator: false,
-      ns,
-      backend: {
-        loadPath: 'https://translations.freckle.com/latest/{{lng}}/{{ns}}'
-      }
-    })
-
-  let anyErrors = false
-
-  for (const l of supportedLngs) {
-    await i18next.changeLanguage(l)
-    for (const n of ns) {
-      for (const key of Object.keys(i18next.getDataByLanguage(l)[n])) {
-        try {
-          t(`${n}:${key}`)
-        } catch (error) {
-          if (!isInterpolationError(error)) {
-            anyErrors = true
-            console.error(`${n}:${l}:${key}`)
-          }
-        }
-      }
-    }
-  }
-
-  if (anyErrors) {
-    console.error('The above keys cannot be parsed as ICU and need to be fixed in Locize.')
-    process.exit(1)
-  } else {
-    process.exit(0)
-  }
-}
-
-const isInterpolationError = error => /^The intl string context variable/.test(error.message)
-
-main()

package/dist/check-missing-translations.js

@@ -1,16 +0,0 @@
-#!/usr/bin/env node
-
-const {spawn} = require('node:child_process')
-const path = require('path')
-
-const [_nodeBin, scriptPath, ...args] = process.argv
-
-const proc = spawn(`${path.dirname(scriptPath)}/check-missing-translations`, args)
-
-proc.stdout.on('data', data => {
-  process.stdout.write(data)
-})
-
-proc.stderr.on('data', data => {
-  process.stderr.write(data)
-})

package/dist/translation-keys

@@ -1,27 +0,0 @@
-#!/usr/bin/env node
-//
-// Attempt to find all translations keys in use in JS files passed on stdin.
-//
-// Usage:
-//
-//   git ls-files |
-//      grep '\.js$' |
-//      grep -v '\.min\.js$' |
-//     ./scripts/translation-keys
-//
-// We stream out the keys as seen. We do no sorting or de-duplication.
-//
-const {extractTranslationKeysAndVariables} = require('./translation-extraction.js')
-const readline = require('readline')
-
-const interface = readline.createInterface({
-  input: process.stdin,
-  output: process.stdout,
-  terminal: false
-})
-
-interface.on('line', path => {
-  extractTranslationKeysAndVariables(path).forEach(({i18nKey}) =>
-    console.log(i18nKey)
-  )
-})

package/eslint.config.mjs

@@ -1,22 +0,0 @@
-import freckle from '@freckle/eslint-config'
-import globals from 'globals'
-
-export default [
-  // The shared config scopes its rules to `**/*.ts`; this package is plain
-  // JavaScript, so without retargeting it would lint nothing.
-  ...freckle.map(config => (config.files ? {...config, files: ['**/*.js']} : config)),
-  {
-    files: ['**/*.js'],
-    languageOptions: {
-      globals: globals.node
-    },
-    rules: {
-      // typescript-eslint turns this off because tsc reports undefined names;
-      // nothing type-checks this package, so it has to come back on.
-      'no-undef': 'error',
-      // The sources are CommonJS until the ESM conversion in #97, which drops
-      // this waiver.
-      '@typescript-eslint/no-require-imports': 'off'
-    }
-  }
-]

package/renovate.json

@@ -1,6 +0,0 @@
-{
-  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
-  "extends": [
-    "local>freckle/renovate-config"
-  ]
-}

package/src/check-i18n-variables

@@ -1,133 +0,0 @@
-#!/usr/bin/env node
-//
-// Checks all locize keys (in the codebase) with known variables against key
-// values in locize ensuring that variables in locize refer to known vars.
-//
-const {promises: fs} = require('fs')
-const p = require('path')
-const i18next = require('i18next')
-const ICU = require('i18next-icu')
-const HttpBackend = require('i18next-http-backend')
-const {IntlMessageFormat} = require('intl-messageformat')
-
-const {
-  extractTranslationKeysAndVariables,
-  KNOWN_VARIABLES_TAG
-} = require('./translation-extraction.js')
-const {getFiles, filterJsFiles, supportedLngs} = require('./helpers.js')
-
-const [_nodeBin, _scriptPath, ...projects] = process.argv
-
-if (projects.length < 1) {
-  console.log('Usage: check-i18n-variables <path>')
-  return
-}
-
-// TODO: Pass in via ENV?
-const ns = ['school', 'student', 'console', 'classroom', 'common']
-
-const translationKeysWithKnownVariablesInProject = async project => {
-  const files = await getFiles(project)
-  const jsFiles = files.filter(filterJsFiles)
-  const results = []
-
-  jsFiles.forEach(({path}) => {
-    extractTranslationKeysAndVariables(path)
-      .filter(({tag}) => tag === KNOWN_VARIABLES_TAG)
-      .forEach(keyWithVars => results.push(keyWithVars))
-  })
-
-  return results
-}
-
-// The AST is undocumented, however, its type definitions are here
-//    https://github.com/formatjs/formatjs/blob/82a2e5d07f9a999624ffb6387a58464f9a5f7399/packages/icu-messageformat-parser/types.ts#L122-L131
-const extractVariablesFromICUAst = ast => {
-  // Some AST field values are `null`
-  if (!ast) {
-    return []
-  }
-
-  if (ast.constructor === Array) {
-    return ast.flatMap(extractVariablesFromICUAst)
-  }
-  if (ast.constructor === Object) {
-    const subVariables = Object.values(ast).flatMap(extractVariablesFromICUAst)
-    // `type`s that aren't 0 (string literals) are variables when `.value` exists
-    const hasVariable = ast.type && typeof ast.type === 'number' && ast.type !== 0 && ast.value
-
-    return (hasVariable ? [ast.value] : []).concat(subVariables)
-  }
-
-  return []
-}
-
-const main = async () => {
-  const t = await i18next
-    .use(ICU)
-    .use(HttpBackend)
-    .init({
-      supportedLngs,
-      allowMultiLoading: true,
-      keySeparator: false,
-      ns,
-      backend: {
-        loadPath: 'https://translations.freckle.com/latest/{{lng}}/{{ns}}'
-      }
-    })
-
-  let anyErrors = false
-
-  // Project key extraction is not cheap so cache per project
-  const keysPerProject = {}
-
-  await Promise.all(
-    projects.map(
-      async project =>
-        (keysPerProject[project] = await translationKeysWithKnownVariablesInProject(project))
-    )
-  )
-
-  for (const lang of supportedLngs) {
-    await i18next.changeLanguage(lang)
-    const translations = i18next.getDataByLanguage(lang)
-
-    for (const [project, keys] of Object.entries(keysPerProject)) {
-      for (const {i18nKey, variables: codeVariables} of keys) {
-        const keyValue =
-          (translations[project] && translations[project][i18nKey]) || translations.common[i18nKey]
-
-        try {
-          if (keyValue) {
-            const locizeVariables = extractVariablesFromICUAst(
-              new IntlMessageFormat(keyValue, lang, {}, {ignoreTag: true}).getAst()
-            )
-
-            for (const locizeVariable of locizeVariables) {
-              if (!codeVariables.includes(locizeVariable)) {
-                anyErrors = true
-                console.error(
-                  `${project}:${lang}:${i18nKey} does not pass the variable ${locizeVariable}`
-                )
-              }
-            }
-          }
-        } catch (e) {
-          // We have another script that checks that `IntlMessageFormat` can
-          // successfully parse the ICU text so let's not fail for that reason.
-        }
-      }
-    }
-  }
-
-  if (anyErrors) {
-    console.error(
-      'The above keys have variables not passed by the code and need to be fixed in Locize.'
-    )
-    process.exit(1)
-  } else {
-    process.exit(0)
-  }
-}
-
-main()

package/src/check-i18n-variables.js

@@ -1,16 +0,0 @@
-#!/usr/bin/env node
-
-const {spawn} = require('node:child_process')
-const path = require('path')
-
-const [_nodeBin, scriptPath, ...args] = process.argv
-
-const proc = spawn(`${path.dirname(scriptPath)}/check-i18n-variables`, args)
-
-proc.stdout.on('data', data => {
-  process.stdout.write(data)
-})
-
-proc.stderr.on('data', data => {
-  process.stderr.write(data)
-})

package/src/check-i18next-icu-parser

@@ -1,64 +0,0 @@
-#!/usr/bin/env node
-// @flow
-//
-// Checks all keys in Locize to make sure that they can be parsed by the `i18next` `t` function
-//
-const i18next = require('i18next')
-const ICU = require('i18next-icu')
-const HttpBackend = require('i18next-http-backend')
-const {supportedLngs} = require('./helpers.js')
-
-const VALID_NAMESPACES = ['school', 'student', 'console', 'classroom', 'common']
-
-const ns = process.argv.slice(2)
-
-for (const arg of ns) {
-  if (!VALID_NAMESPACES.some(ns => ns === arg)) {
-    throw new Error(`Invalid arguments: ${arg} is not a namespace`)
-  }
-}
-
-
-const main = async () => {
-  const t = await i18next
-    .use(ICU)
-    .use(HttpBackend)
-    .init({
-      supportedLngs,
-      allowMultiLoading: true,
-      keySeparator: false,
-      ns,
-      backend: {
-        loadPath: 'https://translations.freckle.com/latest/{{lng}}/{{ns}}'
-      }
-    })
-
-  let anyErrors = false
-
-  for (const l of supportedLngs) {
-    await i18next.changeLanguage(l)
-    for (const n of ns) {
-      for (const key of Object.keys(i18next.getDataByLanguage(l)[n])) {
-        try {
-          t(`${n}:${key}`)
-        } catch (error) {
-          if (!isInterpolationError(error)) {
-            anyErrors = true
-            console.error(`${n}:${l}:${key}`)
-          }
-        }
-      }
-    }
-  }
-
-  if (anyErrors) {
-    console.error('The above keys cannot be parsed as ICU and need to be fixed in Locize.')
-    process.exit(1)
-  } else {
-    process.exit(0)
-  }
-}
-
-const isInterpolationError = error => /^The intl string context variable/.test(error.message)
-
-main()

package/src/check-i18next-icu-parser.js

@@ -1,16 +0,0 @@
-#!/usr/bin/env node
-
-const {spawn} = require('node:child_process')
-const path = require('path')
-
-const [_nodeBin, scriptPath, ...args] = process.argv
-
-const proc = spawn(`${path.dirname(scriptPath)}/check-i18next-icu-parser`, args)
-
-proc.stdout.on('data', data => {
-  process.stdout.write(data)
-})
-
-proc.stderr.on('data', data => {
-  process.stderr.write(data)
-})

package/src/check-missing-translations

@@ -1,69 +0,0 @@
-#!/usr/bin/env bash
-set -eu
-
-script_dir="$(cd "$(dirname "$0")" && pwd)"
-
-translation_keys_in_code() {
-  local project_path=$1
-
-  git ls-files "$project_path" |
-    grep -E '\.(js|ts|tsx)$' |
-    grep -v '\.min\.js$' |
-    "$script_dir/translation-keys"
-}
-
-translation_keys_in_locize() {
-  local namespace=$1
-
-  curl --silent --fail --show-error \
-    "https://translations.freckle.com/latest/en/$namespace" |
-    jq --raw-output 'keys[]'
-}
-
-empty_translation_keys_in_locize() {
-  local namespace=$1
-
-  curl --silent --fail --show-error \
-    "https://translations.freckle.com/latest/en/$namespace" |
-    jq --raw-output '[to_entries | .[] | select(.key | test("^[A-Z_]+$")) | select(.key == .value)] | .[] | .key' |
-    grep -xv 'OK' | grep -xv 'ELA' # Whitelist some common translation keys
-}
-
-translation_keys_only_in_code() {
-  local project_path=$1 namespace=$2
-
-  comm -23 \
-    <(translation_keys_in_code "$project_path" | sort -u) \
-    <(translation_keys_in_locize "$namespace" | sort -u)
-}
-
-empty_translation_keys_used_in_locize() {
-  local project_path=$1 namespace=$2
-
-  comm -12 \
-    <(translation_keys_in_code "$project_path" | sort -u) \
-    <(empty_translation_keys_in_locize "$namespace" | sort -u)
-}
-
-if (($# < 1)); then
-  echo "Usage: check-missing-translations namespace [project/path]" >&2
-  exit 64
-fi
-
-namespace=${1}
-project_path=${2-.}
-
-tmp=$(mktemp)
-trap 'rm -f -- "$tmp"' EXIT
-
-# Check which keys are present in the frontend but not Locize
-translation_keys_only_in_code "$project_path" "$namespace" | sed 's/$/ not present/' | tee "$tmp"
-
-# Check which keys are present in both the frontend and Locize but are untranslated
-empty_translation_keys_used_in_locize "$project_path" "$namespace" | sed 's/$/ not translated/' | tee -a "$tmp"
-
-if [ -s "$tmp" ]; then
-  echo
-  echo "The above keys either need to be added to Locize or translated" >&2
-  exit 1
-fi

package/src/check-missing-translations.js

@@ -1,16 +0,0 @@
-#!/usr/bin/env node
-
-const {spawn} = require('node:child_process')
-const path = require('path')
-
-const [_nodeBin, scriptPath, ...args] = process.argv
-
-const proc = spawn(`${path.dirname(scriptPath)}/check-missing-translations`, args)
-
-proc.stdout.on('data', data => {
-  process.stdout.write(data)
-})
-
-proc.stderr.on('data', data => {
-  process.stderr.write(data)
-})

package/src/helpers.js

@@ -1,34 +0,0 @@
-#!/usr/bin/env node
-const {promises: fs} = require('fs')
-const p = require('path')
-
-// Modified from https://dev.to/leonard/get-files-recursive-with-the-node-js-file-system-fs-2n7o
-async function getFiles(path) {
-  const allEntries = await fs.readdir(path, {withFileTypes: true})
-
-  const entries = allEntries.filter(file => file.name !== 'node_modules' && file.name !== '.cache')
-
-  const files = entries
-    .filter(file => !file.isDirectory())
-    .map(file => ({...file, path: p.join(path, file.name)}))
-
-  const folders = entries.filter(folder => folder.isDirectory())
-
-  for (const folder of folders) {
-    files.push(...(await getFiles(p.join(path, folder.name))))
-  }
-
-  return files
-}
-
-module.exports.getFiles = getFiles
-
-const filterJsFiles = f =>
-  (f.name.endsWith('.js') || f.name.endsWith('.ts') || f.name.endsWith('.tsx')) &&
-  !f.name.endsWith('min.js')
-
-module.exports.filterJsFiles = filterJsFiles
-
-const supportedLngs = ['es', 'en', 'en-GB']
-
-module.exports.supportedLngs = supportedLngs

package/src/translation-extraction.js

@@ -1,141 +0,0 @@
-const fs = require('fs')
-const parser = require('flow-parser')
-const walk = require('esprima-walk')
-
-const isIdentifierT = node => node && node.type === 'Identifier' && node.name === 't'
-
-const isTransTag = node =>
-  node.type === 'JSXElement' &&
-  node.openingElement.type === 'JSXOpeningElement' &&
-  node.openingElement.name.name === 'Trans'
-
-const isJsxAttribute = attr => node =>
-  node && node.type === 'JSXAttribute' && node.name.name === attr
-
-const naiveLooksLikeApplication = (content, node, previousNode) =>
-  content.slice(previousNode.range[1], node.range[0]).trim() === '('
-
-const looksLikeTApplication = (content, node, previousNode) =>
-  node.type === 'Literal' &&
-  isIdentifierT(previousNode) &&
-  naiveLooksLikeApplication(content, node, previousNode)
-
-const isObjectWithSimpleProperties = node =>
-  node.type === 'ObjectExpression' &&
-  node.properties.every(p => p.type === 'Property' && p.key.type === 'Identifier')
-
-const KNOWN_VARIABLES_TAG = 'i18n-key-with-known-variables'
-const UNKNOWN_VARIABLES_TAG = 'i18n-key-with-unknown-variables'
-
-const knownVariables = (source, i18nKey, objectWithSimpleProperties) => ({
-  tag: KNOWN_VARIABLES_TAG,
-  source,
-  i18nKey,
-  variables: objectWithSimpleProperties.properties.map(p => p.key.name)
-})
-
-const knownNoVariables = (source, i18nKey) => ({
-  tag: KNOWN_VARIABLES_TAG,
-  source,
-  i18nKey,
-  variables: []
-})
-
-const unknownVariables = (source, i18nKey) => ({
-  tag: UNKNOWN_VARIABLES_TAG,
-  source,
-  i18nKey
-})
-
-module.exports.KNOWN_VARIABLES_TAG = KNOWN_VARIABLES_TAG
-module.exports.UNKNOWN_VARIABLES_TAG = UNKNOWN_VARIABLES_TAG
-
-// Attempt to find all translations keys and their provided variables in use in JS files.
-//
-// Methodology:
-//
-//   Locate any
-//     - Literal nodes that immediately follow an Identifier node named t, and
-//       output their value, or
-//     - Trans component instances and output their i18nKey values
-//
-//   If possible, output any variables (if possible) used by the keys. This is
-//   done with no further analysis than looking for a variable object and
-//     - if one's not found, report no variables
-//     - if one's found and is a simple object, report its properties
-//     - if one's found and is a more complex object, report that the variables
-//       are not known
-//
-// Yields keys with variables as encountered without sorting or de-duplication.
-module.exports.extractTranslationKeysAndVariables = path => {
-  const content = fs.readFileSync(path, {encoding: 'utf8'})
-  const ast = parser.parse(content)
-
-  const results = []
-  let previousNode = null
-
-  // Possible `tag` values are
-  //  - 'finding-i18n-key' which means we're trying to find an i18n key
-  //  - 'found-t-application' which means we found a key like `t('KEY'` and we
-  //    ought to check the next token to see if it's a simple object literal
-  let state = {tag: 'finding-i18n-key'}
-
-  walk(ast, node => {
-    switch (state.tag) {
-      case 'finding-i18n-key': {
-        if (looksLikeTApplication(content, node, previousNode)) {
-          state = {tag: 'found-t-application', key: node.value}
-        } else if (isTransTag(node)) {
-          const i18nKey = node.openingElement.attributes.find(isJsxAttribute('i18nKey'))
-          const values = node.openingElement.attributes.find(isJsxAttribute('values'))
-          const hasCount = node.openingElement.attributes.some(isJsxAttribute('count'))
-
-          // `Trans` keys can have a `count` property which ends up being a
-          // variable. If we have known variables we've gotta account for it...
-          const accountForCount = i18nKeyVithVariables => ({
-            ...i18nKeyVithVariables,
-            variables: i18nKeyVithVariables.variables.concat(hasCount ? ['count'] : [])
-          })
-
-          if (
-            i18nKey.value.value &&
-            values &&
-            values.value.type === 'JSXExpressionContainer' &&
-            isObjectWithSimpleProperties(values.value.expression)
-          ) {
-            results.push(
-              accountForCount(
-                knownVariables('trans-component', i18nKey.value.value, values.value.expression)
-              )
-            )
-          } else if (i18nKey.value.value && !values) {
-            results.push(accountForCount(knownNoVariables('trans-component', i18nKey.value.value)))
-          } else if (i18nKey.value.value) {
-            results.push(unknownVariables('trans-component', i18nKey.value.value))
-          }
-        }
-        break
-      }
-      case 'found-t-application': {
-        if (isObjectWithSimpleProperties(node)) {
-          results.push(knownVariables('t-application', state.key, node))
-        } else if (typeof node === 'number') {
-          // No object after the key means no variables. For some reason this is an integer
-          results.push(knownNoVariables('t-application', state.key))
-        } else {
-          results.push(unknownVariables('t-application', state.key))
-        }
-        state = {tag: 'finding-i18n-key'}
-        break
-      }
-      case 'found-trans-component': {
-        state = {tag: 'finding-i18n-key'}
-        break
-      }
-    }
-
-    previousNode = node
-  })
-
-  return results
-}