Automated Docs Fix - Same Properties

Author: antoineaws

src/lib/docs-gen/package.json

@@ -15,8 +15,8 @@
     "gen-i18n-from-json-schema-en": "pnpx ts-node scripts/generate-translation-file.ts en ./output-schema/schema-en.json ./output-translations/translation-en.json",
     "gen-i18n-from-json-schema-fr": "pnpx ts-node scripts/generate-translation-file.ts fr ./output-schema/schema-fr.json ./output-translations/translation-fr.json",
     "gen-typedoc-all": "pnpm run gen-typedoc-en && pnpm run gen-typedoc-fr",
-    "gen-typedoc-en": "rm -r ./output-docs/en; typedoc ./output-ts/en --name 'AWS SEA Config Docs' --hideGenerator --excludePrivate --localize en --templateStrings ./output-translations/translation-en.json --theme ./src/typedoc-theme --out ./output-docs/en --readme ./src/README-en.md",
-    "gen-typedoc-fr": "rm -r ./output-docs/fr; typedoc ./output-ts/fr --name 'Documents Config AWS SEA' --hideGenerator --excludePrivate --localize fr --templateStrings ./output-translations/translation-fr.json --theme ./src/typedoc-theme --out ./output-docs/fr --readme ./src/README-fr.md",
+    "gen-typedoc-en": "rm -r ./output-docs/en; lang=en typedoc ./output-ts/en --name 'AWS SEA Config Docs' --hideGenerator --excludePrivate --localize en --templateStrings ./output-translations/translation-en.json --theme ./src/typedoc-theme --out ./output-docs/en --readme ./src/README-en.md",
+    "gen-typedoc-fr": "rm -r ./output-docs/fr; lang=fr typedoc ./output-ts/fr --name 'Documents Config AWS SEA' --hideGenerator --excludePrivate --localize fr --templateStrings ./output-translations/translation-fr.json --theme ./src/typedoc-theme --out ./output-docs/fr --readme ./src/README-fr.md",
     "gen-docs": "pnpm run gen-json-schema-all && pnpm run gen-ts-from-json-schema-all && pnpm run gen-i18n-from-json-schema-all && pnpm run gen-typedoc-all",
     "build": "pnpm run gen-docs"
   },

src/lib/docs-gen/scripts/generate-translation-file.ts

@@ -24,7 +24,7 @@ let baseTranslationParsed = JSON.parse(baseTranslationRaw);
 
 // Extract translations
 const translationHelper = new TranslationExtractHelper(languageCode);
-translationHelper.iterate(schemaParsed);
+translationHelper.iterate(schemaParsed, schemaParsed.title);
 
 // Merge base and extracted translations
 for(const prop in baseTranslationParsed[languageCode]){

src/lib/docs-gen/src/helpers/translation-extract-helper.ts

@@ -9,29 +9,30 @@ export class TranslationExtractHelper {
         this.typeDocTranslation[`${selectedLanguage}`] = {};
     }
 
-    public iterate(obj: any) {
+    public iterate(obj: any, parentProperty: string) {
         for (const property in obj.fields) {
             const propertyObject = obj.fields[property];
 
             const titleTranslated = this.translate('Title', this.selectedLanguage);
             const titleField = this.generateTitle(propertyObject.title, property);
             const descriptionTranslated = this.translate('Description', this.selectedLanguage);
-            this.typeDocTranslation[`${this.selectedLanguage}`]["i18n-" + property] =
+            const computedProperty = this.generateProperty(property, parentProperty);
+            this.typeDocTranslation[`${this.selectedLanguage}`][`${computedProperty}`] =
                 `<b>${titleTranslated}:</b> ${titleField}<br/><b>${descriptionTranslated}:</b> ${propertyObject.description}`;
         }
         if (obj.properties) {
             for (const property in obj.properties) {
-                this.iterate(obj.properties[property]);
+                this.iterate(obj.properties[property], obj.properties[property].title);
             }
         }
         if (obj.additionalProperties) {
-            this.iterate(obj.additionalProperties);
+            this.iterate(obj.additionalProperties, obj.additionalProperties.title);
         }
 
     }
     private generateTitle(title: string, propertyName: string) {
         if (title && title.trim().length > 0) return title;
-        
+
         const newTitle = `${propertyName}`
             .replace(new RegExp(/[^\w]/, 'g'), ' ') //Remove non-word characters such as '-'
             .replace(
@@ -47,4 +48,14 @@ export class TranslationExtractHelper {
         if (selectedLanguage === 'fr') return frenchDict.fr[key];
         else return englishDict.en[key];
     }
+    private generateProperty(property: string, parentProperty: string) {
+        let i18nProperty = "";
+        if (!parentProperty) i18nProperty = `i18n-${property}`;
+        else {
+            const parentPropertyLowerCased =
+                parentProperty.replace(/[\W_]+/g, "").toLowerCase(); // Replace non-alphanumeric
+            i18nProperty = `i18n-${parentPropertyLowerCased}-${property}`;
+        }
+        return i18nProperty;
+    }
 }

src/lib/docs-gen/src/typedoc-theme/helpers/helpers-translate.js

@@ -0,0 +1,29 @@
+
+
+module.exports = {
+    customLocalize: function (parent, property) {
+        const selectedLanguage = process.env.lang;
+        const languageDictionary = require(`../../../output-translations/translation-${selectedLanguage}.json`);
+        let parentCleansed = "";
+        let parentExists = false;
+        if (parent) {
+            parentExists = true;
+            parentCleansed = parent.replace(/[\W_]+/g, "").toLowerCase(); // Replace non-alphanumeric
+
+            /**
+             * The json-schema-to-typescript library generates duplicate classes such as ALBConfig and ALBConfig1
+             * These classes are the same, so when retrieving translations from translation-en.json, 
+             * when parent key is ALBConfig1/2/3/etc , replace it with ALBConfig so the translation can
+             * be retrieved. Below statements remove the last digit.
+             */
+            const isLastCharacterANumber = !isNaN(parentCleansed.charAt(parentCleansed.length - 1));
+            if (isLastCharacterANumber) parentCleansed = parentCleansed.slice(0, -1);
+        }
+
+        let translation = "";
+        if (parentExists) {
+            translation = languageDictionary[selectedLanguage][`i18n-${parentCleansed}-${property}`];
+        } else translation = englishDict.en[`i18n-${property}`];
+        return translation;
+    }
+}

src/lib/docs-gen/src/typedoc-theme/partials/member.declaration.hbs

@@ -20,10 +20,9 @@
 
 {{> member.sources}}
 
-{{!-- <p>{{name}}</p> --}}
-{{#localize}}i18n-{{name}}{{/localize}}
+{{#customLocalize parent.name name}}{{/customLocalize}}
+{{!-- {{#localize}}i18n-{{name}}{{/localize}}--}}
 {{> comment}}
-{{!-- {{parent.name}} --}}
 
 {{#if typeParameters}}
 <h4 class="tsd-type-parameters-title">{{#localize}}Type parameters{{/localize}}</h4>