Add the ability to analyse nested translation folders

Author: beerinho

README.md

@@ -1,5 +1,4 @@
-ember-intl-analyzer
-==============================================================================
+# ember-intl-analyzer
 
 Find unused translations in your Ember.js projects
 
@@ -9,37 +8,31 @@ Find unused translations in your Ember.js projects
 > We offer consulting, training, and team augmentation for Ember.js – check out
 > our [website](https://mainmatter.com/ember-consulting/) to learn more!
 
-Usage
-------------------------------------------------------------------------------
+## Usage
 
 ```bash
 npx ember-intl-analyzer
 ```
 
-
-Configuration
-------------------------------------------------------------------------------
+## Configuration
 
 ember-intl-analyzer can be configured by creating a `config/ember-intl-analyzer.js`
 file in your app:
 
 ```js
 export default {
-  whitelist: [
-    /^countries\./,
-    /^currency\./,
-    /^validations\.errors\./,
-    /^[^.]+\.warnings\.[^.]+$/,
-  ],
+  whitelist: [/^countries\./, /^currency\./, /^validations\.errors\./, /^[^.]+\.warnings\.[^.]+$/],
 };
 ```
 
 ### `whitelist`
 
 If you use dynamic translations keys like this:
+
 ```js
-this.intl.t(`countries.${code}`)
+this.intl.t(`countries.${code}`);
 ```
+
 then ember-intl-analyzer can not easily understand what translation keys are
 being used here. In that case it will ignore the dynamic translation key and
 show the corresponding translations as unused.
@@ -64,15 +57,18 @@ export default {
 ### `analyzeConcatExpression`
 
 If your template contains translations like this:
+
 ```hbs
-{{t (concat "actions." (if @isEditing "save" "publish"))}}
+{{t (concat 'actions.' (if @isEditing 'save' 'publish'))}}
 ```
+
 then ember-intl-analyzer does not detect that `actions.save` and `actions.publish`
 are in fact used translations, so they can be incorrectly flagged as missing or
 unused. As the `concat` helper can make it harder to read, it's encouraged to
 rewrite it to for example:
+
 ```hbs
-{{if @isEditing (t "actions.save") (t "actions.publish")}}
+{{if @isEditing (t 'actions.save') (t 'actions.publish')}}
 ```
 
 However, if your application relies heavily on this `concat` helper, then rewriting
@@ -100,9 +96,11 @@ export default {
 This example will try to find translation files in `node_modules/my-addon/translations`.
 Patterns supported by [`globby`](https://www.npmjs.com/package/globby) are also
 possible here, e.g. this:
+
 ```js
-externalPaths: ['@*/*']
+externalPaths: ['@*/*'];
 ```
+
 will look up translations in scoped addons like `node_modules/@company/scoped-addon/translations`.
 
 ### `translationFiles`
@@ -122,13 +120,24 @@ This example will try to find all `en.yaml` files in the different `translations
 folders, but any patterns supported by [`globby`](https://www.npmjs.com/package/globby) are also
 possible here.
 
+### `wrapTranslationsWithNamespace`
+
+If you are nesting your translations with `ember-intl`s [`wrapTranslationsWithNamespace`](https://ember-intl.github.io/ember-intl/docs/advanced/configuration#wraptranslationswithnamespace) you will need to set the corresponding property within your `ember-intl-analyzer` config file.
+
+```js
+export default {
+  wrapTranslationsWithNamespace: true,
+};
+```
+
 ### `babelParserPlugins` `extensions`
 
 If your application uses doesn't parse correctly because it requires a specific babel plugin you can specifiy them in the config file under the key `babelParserPlugins` a list on plugins can be found [here](https://babeljs.io/docs/en/babel-parser#plugins).
 
 For example if you would like typescript support you can specify the `typescript` plugin, although please note if the plugin introduces a new file extension you will also need to specifiy that in the `extensions` property. See the examples below.
 
 Typescript example
+
 ```js
 export default {
   babelParserPlugins: ['typescript'],
@@ -137,6 +146,7 @@ export default {
 ```
 
 Jsx example
+
 ```js
 export default {
   babelParserPlugins: ['jsx'],
@@ -145,6 +155,7 @@ export default {
 ```
 
 Gts example
+
 ```js
 export default {
   babelParserPlugins: ['typescript'],
@@ -153,6 +164,7 @@ export default {
 ```
 
 ### `--fix`
+
 If your application has a lot of unused translations you can run the command with
 the `--fix` to remove them. Remember to double check your translations as dynamic
 translations need to be whitelisted or they will be removed!
@@ -172,23 +184,18 @@ export default {
 };
 ```
 
-Caveats
-------------------------------------------------------------------------------
+## Caveats
 
 There are a number of things that we do not support yet. Have a look at the
 [Issues](https://github.com/Mainmatter/ember-intl-analyzer/issues) before using
 this project.
 
-
-Related
-------------------------------------------------------------------------------
+## Related
 
 - [ember-intl](https://github.com/ember-intl/ember-intl) – Internationalization
   addon for Ember.js
 
-
-License
-------------------------------------------------------------------------------
+## License
 
 This projects is developed by and © [Mainmatter GmbH](http://mainmatter.com)
 and contributors. It is released under the [MIT License](LICENSE.md).

__snapshots__/test.js.snap

@@ -172,6 +172,20 @@ exports[`Test Fixtures missing-translations 1`] = `
 
 exports[`Test Fixtures missing-translations 2`] = `Map {}`;
 
+exports[`Test Fixtures nested-keys 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!
+"
+`;
+
+exports[`Test Fixtures nested-keys 2`] = `Map {}`;
+
 exports[`Test Fixtures no-issues 1`] = `
 "[1/4] 🔍  Finding JS and HBS files...
 [2/4] 🔍  Searching for translations keys in JS and HBS files...

fixtures/nested-keys/app/controllers/application.js

@@ -0,0 +1,9 @@
+import Controller from '@ember/controller';
+import { tracked } from '@glimmer/tracking';
+
+export default class ApplicationController extends Controller {
+  @tracked foo;
+  foo() {
+    return this.intl.t('foo.bar.hello');
+  }
+}

fixtures/nested-keys/app/templates/application.hbs

@@ -0,0 +1,2 @@
+{{t 'foo.bar.hello'}}
+{{t 'foo.bar.bing.pot'}}

fixtures/nested-keys/translations/foo/bar/de-at.yaml

@@ -0,0 +1,3 @@
+hello: Hallo
+bing:
+  pot: wow!

fixtures/nested-keys/translations/foo/bar/en.yaml

@@ -0,0 +1,3 @@
+hello: Hello
+bing:
+  pot: wow!

index.js

@@ -34,6 +34,7 @@ async function run(rootDir, options = {}) {
   let userPlugins = config.babelParserPlugins || [];
   let userExtensions = config.extensions || [];
   let customHelpers = config.helpers || [];
+  let wrapTranslationsWithNamespace = config.wrapTranslationsWithNamespace || false;
   let includeGtsExtension = userExtensions.includes('.gts');
 
   userExtensions = userExtensions.map(extension =>
@@ -59,10 +60,15 @@ async function run(rootDir, options = {}) {
 
   let ownTranslationFiles = await findOwnTranslationFiles(rootDir, config);
   let externalTranslationFiles = await findExternalTranslationFiles(rootDir, config);
-  let existingOwnTranslationKeys = await analyzeTranslationFiles(rootDir, ownTranslationFiles);
+  let existingOwnTranslationKeys = await analyzeTranslationFiles(
+    rootDir,
+    ownTranslationFiles,
+    wrapTranslationsWithNamespace
+  );
   let existingExternalTranslationKeys = await analyzeTranslationFiles(
     rootDir,
-    externalTranslationFiles
+    externalTranslationFiles,
+    wrapTranslationsWithNamespace
   );
   let existingTranslationKeys = mergeMaps(
     existingOwnTranslationKeys,
@@ -417,21 +423,38 @@ async function analyzeHbsFile(content, { analyzeConcatExpression = false, helper
   return translationKeys;
 }
 
-async function analyzeTranslationFiles(cwd, files) {
-  let existingTranslationKeys = new Map();
+function extractNestedPath(filepath) {
+  const regex = /translations\/(.+)\/(?:[a-z]{2}\.(?:ya?ml|json)|.*)/;
+  const match = filepath.match(regex);
+
+  if (match) {
+    return match[1].replace(/\//g, '.');
+  } else {
+    return null;
+  }
+}
 
+async function analyzeTranslationFiles(cwd, files, wrapTranslationsWithNamespace) {
+  let existingTranslationKeys = new Map();
   for (let file of files) {
+    let prefix = '';
+    if (wrapTranslationsWithNamespace) {
+      prefix = extractNestedPath(file) + '.';
+    }
     let content = fs.readFileSync(`${cwd}/${file}`, 'utf8');
     let translations = YAML.parse(content); // json is valid yaml
-    forEachTranslation(translations, key => {
-      if (!existingTranslationKeys.has(key)) {
-        existingTranslationKeys.set(key, new Set());
-      }
+    forEachTranslation(
+      translations,
+      key => {
+        if (!existingTranslationKeys.has(key)) {
+          existingTranslationKeys.set(key, new Set());
+        }
 
-      existingTranslationKeys.get(key).add(file);
-    });
+        existingTranslationKeys.get(key).add(file);
+      },
+      prefix
+    );
   }
-
   return existingTranslationKeys;
 }
 

test.js

@@ -43,6 +43,9 @@ describe('Test Fixtures', () => {
     'custom-t-helpers': {
       helpers: ['t-error'],
     },
+    'nested-keys': {
+      wrapTranslationsWithNamespace: true,
+    },
   };
 
   beforeEach(() => {