Add support for listing redundant whitelist entries

README.md

@@ -48,6 +48,19 @@ To prevent that from happening you can configure a `whitelist`, which accepts an
 array of regular expressions that will be checked when looking for unused
 translations.
 
+### `errorOnUnusedWhitelistEntries`
+
+When using a whitelist to ignore dynamic translation keys, it can be easy to forget
+to clean up the whitelist when an entry is not used anymore. You can opt-in to make
+this analyzer error when this occurs, by setting the `errorOnUnusedWhitelistEntries`
+flag in the configuration file:
+
+```js
+export default {
+  errorOnUnusedWhitelistEntries: true,
+};
+```
+
 ### `analyzeConcatExpression`
 
 If your template contains translations like this:

__snapshots__/test.js.snap

@@ -259,6 +259,24 @@ exports[`Test Fixtures unused-translations 1`] = `
 
 exports[`Test Fixtures unused-translations 2`] = `Map {}`;
 
+exports[`Test Fixtures unused-whitelist 1`] = `
+"[1/4] 🔍  Finding JS and HBS files...
+[2/4] 🔍  Searching for translations keys in JS and HBS files...
+[3/4] ⚙️   Checking for unused translations...
+[4/4] ⚙️   Checking for missing translations...
+
+ 👏  No unused translations were found!
+
+ 👏  No missing translations were found!
+
+ ⚠️   Found 1 unused whitelist entry! Please remove it from the whitelist:
+
+   - /some\\\\.unused\\\\.whitelisted\\\\.translation-(a|b)/
+"
+`;
+
+exports[`Test Fixtures unused-whitelist 2`] = `Map {}`;
+
 exports[`Test Fixtures yaml-translations 1`] = `
 "[1/4] 🔍  Finding JS and HBS files...
 [2/4] 🔍  Searching for translations keys in JS and HBS files...

fixtures/unused-whitelist/app/templates/application.hbs

@@ -0,0 +1,3 @@
+{{t "some.present.translation"}}
+{{t "some.whitelisted.translation-a"}}
+{{t "some.whitelisted.translation-b"}}

fixtures/unused-whitelist/translations/en.yaml

@@ -0,0 +1,3 @@
+some:
+  present:
+    translation: This translation exists

index.js

@@ -67,21 +67,30 @@ async function run(rootDir, options = {}) {
     existingExternalTranslationKeys
   );
   let whitelist = config.whitelist || [];
+  let usedWhitelistEntries = new Set();
+  let errorOnUnusedWhitelistEntries = config.errorOnUnusedWhitelistEntries || false;
 
   let unusedTranslations = findDifferenceInTranslations(
     existingOwnTranslationKeys,
     usedTranslationKeys,
-    whitelist
+    whitelist,
+    usedWhitelistEntries
   );
 
   log(`${step(4)} ⚙️   Checking for missing translations...`);
   log();
   let missingTranslations = findDifferenceInTranslations(
     usedTranslationKeys,
     existingTranslationKeys,
-    whitelist
+    whitelist,
+    usedWhitelistEntries
   );
 
+  let unusedWhitelistEntries = new Set(whitelist);
+  for (let entry of usedWhitelistEntries) {
+    unusedWhitelistEntries.delete(entry);
+  }
+
   if (unusedTranslations.size === 0) {
     log(' 👏  No unused translations were found!');
   } else {
@@ -106,7 +115,23 @@ async function run(rootDir, options = {}) {
     }
   }
 
-  let totalErrors = missingTranslations.size + unusedTranslations.size;
+  if (unusedWhitelistEntries.size > 0) {
+    log();
+    log(
+      ` ⚠️   Found ${chalk.bold.yellow(unusedWhitelistEntries.size)} unused whitelist ${
+        unusedWhitelistEntries.size === 1 ? 'entry' : 'entries'
+      }! Please remove ${unusedWhitelistEntries.size === 1 ? 'it' : 'them'} from the whitelist:`
+    );
+    log();
+    for (let entry of unusedWhitelistEntries) {
+      log(`   - ${entry}`);
+    }
+  }
+
+  let totalErrors =
+    missingTranslations.size +
+    unusedTranslations.size +
+    (errorOnUnusedWhitelistEntries ? unusedWhitelistEntries.size : 0);
 
   if (shouldFix) {
     removeUnusedTranslations(writeToFile, rootDir, ownTranslationFiles, unusedTranslations);
@@ -421,15 +446,21 @@ function forEachTranslation(json, callback, prefix = '') {
 
 // Find all translation keys that appear in translation map A, but not
 // in translation map B
-function findDifferenceInTranslations(mapA, mapB, whitelist) {
+function findDifferenceInTranslations(mapA, mapB, whitelist, usedWhitelistEntries) {
   let missingTranslations = new Map();
 
   for (let [key, files] of mapA) {
     const keyTrimmed = key.trim();
     const isKeyMissing = !mapB.has(keyTrimmed);
-    const isKeyAllowed = !whitelist.some(regex => regex.test(keyTrimmed));
 
-    if (isKeyMissing && isKeyAllowed) {
+    if (!isKeyMissing) continue;
+
+    const whitelistKey = whitelist.find(regex => regex.test(keyTrimmed));
+    const isKeyWhitelisted = whitelistKey != null;
+
+    if (isKeyWhitelisted) {
+      usedWhitelistEntries.add(whitelistKey);
+    } else {
       missingTranslations.set(keyTrimmed, files);
     }
   }

test.js

@@ -14,6 +14,7 @@ describe('Test Fixtures', () => {
     'external-addon-translations',
     'concat-expression',
     'chosen-translations',
+    'unused-whitelist',
   ];
   let fixturesWithFix = ['remove-unused-translations', 'remove-unused-translations-nested'];
   let fixturesWithConcat = ['concat-expression'];
@@ -32,6 +33,13 @@ describe('Test Fixtures', () => {
       babelParserPlugins: ['typescript'],
       extensions: ['.gts'],
     },
+    'unused-whitelist': {
+      errorOnUnusedWhitelistEntries: true,
+      whitelist: [
+        /some\.whitelisted\.translation-(a|b)/,
+        /some\.unused\.whitelisted\.translation-(a|b)/,
+      ],
+    },
   };
 
   beforeEach(() => {