Merge pull request #2004 from IFRCGo/chore/stricter-i18n-lint

chore(lint): mark unused string linting as error

Author: frozenhelium

app/eslint.config.ts

@@ -1,4 +1,3 @@
-// eslint.config.js
 // @ts-expect-error: @eslint/eslintrc has no types
 import { FlatCompat } from '@eslint/eslintrc';
 import js from '@eslint/js';
@@ -7,6 +6,7 @@ import tseslint from "typescript-eslint";
 import process from 'process';
 
 import i18nUsage from './scripts/eslint/i18n-usage';
+import { Linter } from 'eslint';
 
 const dirname = process.cwd();
 
@@ -106,8 +106,6 @@ const appConfigs = compat.config({
         'simple-import-sort/imports': 'warn',
         'simple-import-sort/exports': 'warn',
         'import-newlines/enforce': ['warn', 1],
-
-        // 'i18n-usage/ensure-i18n-keys-used': ['warn']
     },
     overrides: [
         {
@@ -145,17 +143,12 @@ const appConfigs = compat.config({
     ],
 }));
 
-const tseslintRecommendedRules = tseslint.configs.recommended.map((conf) => ({
-    ...(conf.rules)
-}));
-
-const otherConfig = {
+const otherConfig: Linter.Config = {
     files: ['*.js', '*.ts', '*.cjs'],
     ...js.configs.recommended,
-    ...tseslintRecommendedRules,
 };
 
-const jsonConfig = {
+const jsonConfig: Linter.Config = {
     files: ['**/*.json'],
     language: 'json/json',
     rules: {
@@ -173,7 +166,7 @@ const jsonConfig = {
 //     },
 // };
 
-export default [
+const config: Linter.Config[] = [
     {
         plugins: {
             json,
@@ -184,4 +177,7 @@ export default [
     otherConfig,
     jsonConfig,
     // i18nJsonConfig,
+    ...tseslint.configs.recommended
 ];
+
+export default config;

app/scripts/eslint/i18n-usage.ts

@@ -88,6 +88,10 @@ function getViewComponent(body: TSESTree.ProgramStatement[]) {
         return undefined;
     }
 
+    if (defaultExportDeclaration.declaration.type === AST_NODE_TYPES.FunctionDeclaration) {
+        return defaultExportDeclaration.declaration;
+    }
+
     const defaultComponentName = defaultExportDeclaration.declaration.type === AST_NODE_TYPES.Identifier
         ? defaultExportDeclaration.declaration.name
         : undefined;
@@ -106,21 +110,19 @@ function getViewComponent(body: TSESTree.ProgramStatement[]) {
 
 function traverseForStringsKeyUsage(node: TSESTree.Node, stringsVarName: string): string[] {
     if (node?.type === AST_NODE_TYPES.MemberExpression) {
-        if (node.object?.type !== AST_NODE_TYPES.Identifier) {
-            return [];
-        }
+        if (node.object?.type === AST_NODE_TYPES.Identifier) {
+            if (stringsVarName !== node.object.name) {
+                return [];
+            }
 
-        if (stringsVarName !== node.object.name) {
-            return [];
-        }
+            const stringKey = getMemberKey(node);
 
-        const stringKey = getMemberKey(node);
+            if (isNotDefined(stringKey)) {
+                return [];
+            }
 
-        if (isNotDefined(stringKey)) {
-            return [];
+            return [stringKey];
         }
-
-        return [stringKey];
     }
 
     const keysToVisit = visitorKeys[node?.type];
@@ -196,7 +198,7 @@ function getUsedKeys(code: string) {
         return [];
     }
 
-    const usedStringKeys = viewComponent.body.body.flatMap((node) => (
+    const usedStringKeys = ast.body.flatMap((node) => (
         traverseForStringsKeyUsage(
             node,
             stringsVarName,
@@ -207,7 +209,7 @@ function getUsedKeys(code: string) {
 }
 
 
-const plugin: ESLint.Plugin = {
+const i18nUsage: ESLint.Plugin = {
     meta: {
         name: 'eslint-plugin-i18n-usage',
         version: '0.0.1',
@@ -228,8 +230,8 @@ const plugin: ESLint.Plugin = {
             meta: {
                 type: "problem",
                 docs: {
-                    description: "Ensure all kesy in i18n.json are used in the component",
-                    recommended: false
+                    description: "Ensure all keys in i18n.json are used in the component",
+                    recommended: true
                 },
                 fixable: "code",
                 schema: [],
@@ -358,4 +360,4 @@ const plugin: ESLint.Plugin = {
     },
 }
 
-export default plugin;
+export default i18nUsage;

app/src/components/GlobalFooter/i18n.json

@@ -3,8 +3,6 @@
     "strings": {
         "footerAboutGo":"About GO",
         "footerAboutGoDesc":"IFRC GO is a Red Cross Red Crescent platform to connect information on emergency needs with the right response.",
-        "footerFindOutMore":"Find out more",
-        "footerHelpfulLinks":"Helpful links",
         "footerOpenSourceCode":"Open Source Code",
         "footerApiDocumentation":"API Documentation",
         "footerOtherResources":"Other Resources",

app/src/components/Navbar/i18n.json

@@ -1,25 +1,15 @@
 {
     "namespace": "common",
     "strings": {
-        "headerAppName":"IFRC GO",
-        "headerMenuResources":"Resources",
         "headerCreateAReportLabel":"Create a Report",
         "headerDropdownNewFieldReport":"New Field Report",
         "headerDropdownNewDrefApplication":"New DREF Application",
         "headerDropdownNew3WActivity":"New 3W Activity",
         "headerDropdownNewFlashUpdate":"New Flash Update",
-        "headerDropdownCovid19IndicatorTracking":"COVID-19 Indicator Tracking",
-        "headerDropdownCovid19NSFinancialOverview":"COVID-19 NS Financial Overview",
-        "headerDropdownDrefApplication":"DREF Application",
         "headerMenuHome":"Home",
-        "headerMenuSurge":"Surge",
         "headerMenuThreeW":"Programmatic Partnerships",
         "headerMenuRiskWatch":"Risk Watch",
-        "headerSearchLabel":"Search",
         "headerLogoAltText":"IFRC GO logo",
-        "headerSearchPlaceholder":"Search",
-        "userMenuAccess":"Access user menu",
-        "userMenuViewAccount":"View user account",
         "userMenuLogin":"Login",
         "userMenuRegister":"Register",
         "userMenuPrepare":"Prepare",
@@ -35,7 +25,6 @@
         "userMenuCatalogueResources":"Catalogue of Resources",
         "userMenuStartPER":"Start PER Process",
         "userMenuGlobal3WProjectDescription":"The Programmatic Partnership is an innovative and ambitious three-year partnership between the IFRC, many of our member National Societies, and the European Union.",
-        "userMenuSubmit3WProject":"Submit 3W Project",
         "userMenuRespondLabel":"Respond",
         "userMenuEmergencies":"Emergencies",
         "userMenuEmergenciesDescription": "Follow currently ongoing emergencies, as well as access the list of previous emergencies or IFRC-led operations.",
@@ -47,8 +36,6 @@
         "userMenuSubmit3WActivity":"Submit 3W Activity",
         "userMenuEarlyWarningDescription":"Early Warning focuses on preparatory action ahead of possible disasters and events. Use one of the following links to submit information on early warning.",
         "userMenuCreateEarlyActionFieldReport":"Create Early Action Field Report",
-        "userMenuSubmitEAPActivation":"Submit EAP Activation",
-        "userMenuSubmitEAPFinalReport":"Submit EAP Final Report",
         "userMenuCreateFlashUpdate":"Create Flash Update",
         "userMenuDrefProcessDescription":"Disaster Response Emergency Fund (DREF) is the quickest way of getting funding directly to local humanitarian actors. Use one of the links below to submit a DREF Application or an update.",
         "userMenuCreateDrefApplication":"Create DREF Application",

app/src/components/domain/ActiveOperationMap/i18n.json

@@ -9,9 +9,6 @@
         "operationPopoverPeopleAffected": "People Targeted",
         "operationPopoverAmountRequested": "Amount Requested (CHF)",
         "operationPopoverAmountFunded": "Amount Funded (CHF)",
-        "operationPopoverActivity": "Activity: {activity}",
-        "operationPopoverStart": "Start: {start}",
-        "operationPopoverEnd": "End: {end}",
         "operationPopoverEmpty": "No Current Operations",
         "operationType": "Type of Appeal",
         "operationFilterTypePlaceholder": "All Appeal Types",
@@ -22,12 +19,9 @@
         "explanationBubbleScalePoints": "Scale points by",
         "explanationBubblePopulationLabel": "# of people targeted",
         "explanationBubbleAmountLabel": "IFRC financial requirements",
-        "explanationBubbleType": "Type",
         "explanationBubbleEmergencyAppeal": "Emergency appeal",
         "explanationBubbleDref": "DREF",
-        "explanationBubbleEAP": "Early Action Protocol Activation",
         "explanationBubbleMultiple": "Multiple types",
-        "explanationBubbleDeployments": "Deployments",
         "downloadMapTitle": "Ongoing operations",
         "operationMapProvinces": "Provinces",
         "operationMapClearFilters": "Clear Filters",

app/src/components/domain/DrefExportModal/i18n.json

@@ -11,8 +11,6 @@
         "includePgaLabel": "Include PGA",
         "startExportLabel": "Start Export",
         "configureExportLabel": "Configure export",
-        "drefDownloadPDFWithPGA": "Download PDF with PGA",
-        "drefDownloadPDFwithoutPGA": "Download PDF without PGA",
         "drefFailureToExportMessage":"Failed to export PDF."
     }
 }

app/src/components/domain/HighlightedOperations/OperationCard/i18n.json

@@ -3,11 +3,7 @@
     "strings": {
         "operationCardLastUpdated": "Last updated",
         "operationCardTargetedPopulation": "Targeted Population",
-        "operationCardDeployedUnits": "Deployed Emergency Response Units",
         "operationCardFunding": "Funding Requirements",
-        "operationCardIFRCSurgePersonnel": "IFRC Surge Personnel",
-        "operationCardNSReportingActivities": "NS Reporting Activities",
-        "operationCardDeployed": "Deployed Surge Personnel",
         "operationCardFundingCoverage": "{coverage}% received",
         "operationCardFollow": "Follow",
         "operationCardUnfollow": "Unfollow",

app/src/components/domain/OperationListItem/i18n.json

@@ -2,7 +2,6 @@
     "namespace": "operationListItem",
     "strings": {
         "operationLastUpdatedLabel": "Last updated",
-        "operationFollowButtonLabel": "Follow",
         "operationUnfollowButtonLabel": "Unfollow"
     }
 }

app/src/components/domain/RiskImminentEvents/MeteoSwiss/EventDetails/i18n.json

@@ -9,7 +9,6 @@
         "meteoSwissAuthoritativeMessage": "Please also consider {link} and classification of {classificationLink}.",
         "meteoSwissAuthoritativeLinkLabel": "authoritative information about the hazard",
         "meteoSwissTropicalStorm": "tropical storm",
-        "meteoSwissHazardName": "{hazardType} - {hazardName}",
         "meteoSwissImpactValue": "{value} ({fivePercent} - {ninetyFivePercent}) {unit}",
         "beta": "beta",
         "impactLabel": "{label} {beta}",

app/src/components/domain/RiskSeasonalMap/i18n.json

@@ -17,7 +17,6 @@
         "riskCategoryVeryHigh": "Very High",
         "riskSeasonalMapHeading": "Risk Map",
         "riskSeasonalCountriesByRiskHeading": "Countries by Risk",
-        "riskPopupLabel": "Risk",
         "riskDataNotAvailable": "Data not available for selected filters"
     }
 }