adapt-authoring-lang 1.0.2 → 1.0.4

package/.github/workflows/releases.yml

@@ -3,10 +3,16 @@ on:
   push:
     branches:
       - master
+
 jobs:
   release:
     name: Release
     runs-on: ubuntu-latest
+    permissions:
+      contents: write # to be able to publish a GitHub release
+      issues: write # to be able to comment on released issues
+      pull-requests: write # to be able to comment on released pull requests
+      id-token: write # to enable use of OIDC for trusted publishing and npm provenance
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -16,10 +22,11 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: 'lts/*'
+      - name: Update npm
+        run: npm install -g npm@latest
       - name: Install dependencies
         run: npm ci
       - name: Release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.AAT_NPM_TOKEN }}
-        run: npx semantic-release
+        run: npx semantic-release

package/bin/check.js

@@ -8,14 +8,33 @@ import path from 'path'
 
 const root = `${process.cwd().replaceAll(path.sep, '/')}/node_modules`
 
+const underline  = (s='', topLine=true) => {
+  const line = () => ''.padEnd(80, '-')
+  console.log(`${topLine ? line() + '\n' : ''}  ${s}\n${line()}`)
+}
+
 async function check () {
-  console.log('Checking for unused language strings')
+  console.log('\n\nChecking app language strings')
 
   const translatedStrings = await getTranslatedStrings()
-  const usedStrings = await getUsedStrings(translatedStrings)
 
-  logUnusedStrings(translatedStrings)
-  logMissingStrings(translatedStrings, usedStrings)
+  for (const lang of Object.keys(translatedStrings)) {
+    console.log('\n\n')
+    underline(`Language: ${lang}`.toUpperCase().padEnd(80), true)
+
+    const langStrings = translatedStrings[lang]
+    const usedStrings = await getUsedStrings(langStrings)
+    const unusedStrings = Object.entries(langStrings).filter(([k, v]) => !k.startsWith('error.') && !v).map(([k]) => k)
+    const missingStrings = Object.entries(usedStrings).filter(([key]) => !langStrings[key] && !key.startsWith('error') && key !== 'app.js')
+
+    console.log()
+    logStrings(unusedStrings, 'translated strings not referenced in the code')
+    console.log()
+    logStrings(missingStrings, 'strings without translation')
+    console.log()
+    underline(`Summary:\n  - ${unusedStrings.length} unused language strings found\n  - ${missingStrings.length} missing language strings found`.padEnd(80), true)
+  }
+  console.log()
 }
 
 async function getTranslatedStrings () {
@@ -24,11 +43,12 @@ async function getTranslatedStrings () {
   await Promise.all((langPacks).map(async l => {
     await Promise.all((await fs.readdir(l)).map(async f => {
       const keys = JSON.parse(await fs.readFile(`${l}/${f}`))
-      const id = f.split('.')[1]
+      const [lang, id] = f.split('.')
+      if (!keyMap[lang]) keyMap[lang] = {}
       Object.keys(keys)
         .map(k => `${id}.${k}`)
         .forEach(k => {
-          keyMap[k] = false
+          keyMap[lang][k] = false
         })
     }))
   }))
@@ -36,9 +56,8 @@ async function getTranslatedStrings () {
 }
 
 async function getUsedStrings (translatedStrings) {
-  const translatedKeys = Object.keys(translatedStrings)
   const usedStrings = {}
-  const errorFiles = await glob(`${root}/adapt-authoring-*/errors/*.json`, { absolute: true })
+  const errorFiles = await glob('adapt-authoring-*/errors/*.json', { cwd: root, absolute: true })
   await Promise.all(errorFiles.map(async f => {
     Object.keys(JSON.parse((await fs.readFile(f)))).forEach(e => {
       const key = `error.${e}`
@@ -46,48 +65,35 @@ async function getUsedStrings (translatedStrings) {
       usedStrings[key].add(f.replace(root, '').split('/')[1]) // only add module name for errors
     })
   }))
-  const sourceFiles = await glob(`${root}/adapt-authoring-*/**/*.@(js|hbs)`, { absolute: true })
+  const sourceFiles = await glob('adapt-authoring-*/**/*.@(js|hbs)', { cwd: root, absolute: true, ignore: '**/node_modules/**' })
+
   await Promise.all(sourceFiles.map(async f => {
     const contents = (await fs.readFile(f)).toString()
-    translatedKeys.forEach(k => {
-      translatedStrings[k] = contents.includes(k) ? true : undefined
-    })
-    const match = contents.matchAll(/['|"|`|](app\.[\w|\.]+)\W/g)
-    if (match) {
-      for (const m of match) {
-        const key = m[1]
-        if (!usedStrings[key]) usedStrings[key] = new Set()
-        usedStrings[key].add(f.replace(root, ''))
+    // Match all potential language keys in the file (app.*, error.*, etc.)
+    const allMatches = contents.matchAll(/(['"`])((?:app|error)\.[\w.]+)\1/g)
+
+    for (const m of allMatches) {
+      const key = m[2]
+      if (Object.hasOwn(translatedStrings, key)) {
+        translatedStrings[key] = true
       }
+      if (!usedStrings[key]) usedStrings[key] = new Set()
+      usedStrings[key].add(f.replace(root, ''))
     }
   }))
+  Object.entries(usedStrings).forEach(([k, set]) => {
+    usedStrings[k] = `${Array.from(set).map(s => `\n    ${s}`).join('')}`
+  })
   return usedStrings
 }
 
-function logUnusedStrings (data) {
-  const unusedKeys = Object.entries(data).filter(([k, v]) => !k.startsWith('error.') && !v).map(([k]) => k)
-  console.log('')
-  if (unusedKeys.length) {
-    unusedKeys.forEach(k => console.log(`- ${k}`))
-    console.log(`\n${unusedKeys.length} unused language strings found`)
-    process.exitCode = 1
-  } else {
-    console.log('\nNo unused strings!')
-  }
-}
-
-function logMissingStrings (translatedStrings, usedStrings) {
-  console.log('')
-  const translatedKeys = Object.keys(translatedStrings)
-  const missingStrings = Object.entries(usedStrings).filter(([key]) => !translatedKeys.includes(key) && key !== 'app.js')
-  if (missingStrings.length) {
-    const sep = '\n   => '
-    missingStrings.forEach(([key, files]) => console.log(`- ${key}${sep}${Array.from(files).join(sep)}`))
-    console.log(`\n${missingStrings.length} missing language strings found`)
-    process.exitCode = 1
-  } else {
-    console.log('\nNo missing strings!')
+function logStrings (strings, message) {
+  if (!strings.length) {
+    return
   }
+  underline(`Found ${strings.length} ${message}`)
+  console.log(`${strings.map(s => `\n- ${s}`).join('')}`)
+  process.exitCode = 1
 }
 
 check()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adapt-authoring-lang",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Localisation for the Adapt authoring tool",
   "homepage": "https://github.com/taylortom/adapt-authoring-lang",
   "license": "GPL-3.0",
@@ -14,15 +14,15 @@
     "glob": "^11.0.0"
   },
   "devDependencies": {
-    "standard": "^17.1.0",
-    "@semantic-release/commit-analyzer": "^9.0.2",
+    "@semantic-release/commit-analyzer": "^13.0.1",
     "@semantic-release/git": "^10.0.1",
-    "@semantic-release/github": "^8.0.5",
-    "@semantic-release/npm": "^9.0.1",
-    "@semantic-release/release-notes-generator": "^10.0.3",
-    "conventional-changelog-eslint": "^3.0.9",
-    "semantic-release": "^21.0.1",
-    "semantic-release-replace-plugin": "^1.2.7"
+    "@semantic-release/github": "^12.0.2",
+    "@semantic-release/npm": "^13.1.2",
+    "@semantic-release/release-notes-generator": "^14.1.0",
+    "conventional-changelog-eslint": "^6.0.0",
+    "semantic-release": "^25.0.2",
+    "semantic-release-replace-plugin": "^1.2.7",
+    "standard": "^17.1.0"
   },
   "release": {
     "plugins": [