Merge pull request Expensify#56666 from ZhenjaHorbach/updated-naming-…

…convention-rule-for-using-private-prefixes [No QA] Update private_ prefix lint rule for variable naming
software-mansion-labs · Feb 13, 2025 · 4f3a2ee · 4f3a2ee
2 parents 1627ebf + ccc63f7
commit 4f3a2ee
Show file tree

Hide file tree

Showing 8 changed files with 7 additions and 11 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -150,8 +150,14 @@ module.exports = {
             {
                 selector: ['variable', 'property'],
                 format: ['camelCase', 'UPPER_CASE', 'PascalCase'],
+                // This filter excludes variables and properties that start with "private_" to make them valid.
+                //
+                // Examples:
+                // - "private_a" → valid
+                // - "private_test" → valid
+                // - "private_" → not valid
                 filter: {
-                    regex: '^private_[a-z][a-zA-Z0-9]+$',
+                    regex: '^private_[a-z][a-zA-Z0-9]*$',
                     match: false,
                 },
             },

diff --git a/src/libs/OptionsListUtils.ts b/src/libs/OptionsListUtils.ts
@@ -792,7 +792,6 @@ function createOption(
     if (report) {
         result.isChatRoom = reportUtilsIsChatRoom(report);
         result.isDefaultRoom = isDefaultRoom(report);
-        // eslint-disable-next-line @typescript-eslint/naming-convention
         result.private_isArchived = getReportNameValuePairs(report.reportID)?.private_isArchived;
         result.isExpenseReport = isExpenseReport(report);
         result.isInvoiceRoom = isInvoiceRoom(report);

diff --git a/src/libs/actions/Policy/Policy.ts b/src/libs/actions/Policy/Policy.ts
@@ -425,7 +425,6 @@ function deleteWorkspace(policyID: string, policyName: string) {
             onyxMethod: Onyx.METHOD.MERGE,
             key: `${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${reportID}`,
             value: {
-                // eslint-disable-next-line @typescript-eslint/naming-convention
                 private_isArchived: null,
             },
         });

diff --git a/src/libs/migrations/NVPMigration.ts b/src/libs/migrations/NVPMigration.ts
@@ -12,9 +12,7 @@ const migrations = {
     preferredLocale: ONYXKEYS.NVP_PREFERRED_LOCALE,
     preferredEmojiSkinTone: ONYXKEYS.PREFERRED_EMOJI_SKIN_TONE,
     frequentlyUsedEmojis: ONYXKEYS.FREQUENTLY_USED_EMOJIS,
-    // eslint-disable-next-line @typescript-eslint/naming-convention
     private_blockedFromConcierge: ONYXKEYS.NVP_BLOCKED_FROM_CONCIERGE,
-    // eslint-disable-next-line @typescript-eslint/naming-convention
     private_pushNotificationID: ONYXKEYS.NVP_PRIVATE_PUSH_NOTIFICATION_ID,
     tryFocusMode: ONYXKEYS.NVP_TRY_FOCUS_MODE,
     introSelected: ONYXKEYS.NVP_INTRO_SELECTED,

diff --git a/tests/unit/DebugUtilsTest.ts b/tests/unit/DebugUtilsTest.ts
@@ -786,7 +786,6 @@ describe('DebugUtils', () => {
         });
         it('returns correct reason when report is archived', async () => {
             const reportNameValuePairs = {
-                // eslint-disable-next-line @typescript-eslint/naming-convention
                 private_isArchived: DateUtils.getDBTime(),
             };
             await Onyx.set(ONYXKEYS.NVP_PRIORITY_MODE, CONST.PRIORITY_MODE.DEFAULT);

diff --git a/tests/unit/OptionsListUtilsTest.ts b/tests/unit/OptionsListUtilsTest.ts
@@ -479,7 +479,6 @@ describe('OptionsListUtils', () => {
     };
 
     const reportNameValuePairs = {
-        // eslint-disable-next-line @typescript-eslint/naming-convention
         private_isArchived: DateUtils.getDBTime(),
     };
 

diff --git a/tests/unit/SidebarOrderTest.ts b/tests/unit/SidebarOrderTest.ts
@@ -858,7 +858,6 @@ describe('Sidebar', () => {
 
             const reportNameValuePairsCollectionDataSet: ReportNameValuePairsCollectionDataSet = {
                 [`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${report1.reportID}`]: {
-                    // eslint-disable-next-line @typescript-eslint/naming-convention
                     private_isArchived: DateUtils.getDBTime(),
                 },
             };
@@ -1012,7 +1011,6 @@ describe('Sidebar', () => {
 
             const reportNameValuePairsCollectionDataSet: ReportNameValuePairsCollectionDataSet = {
                 [`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${report1.reportID}`]: {
-                    // eslint-disable-next-line @typescript-eslint/naming-convention
                     private_isArchived: DateUtils.getDBTime(),
                 },
             };

diff --git a/tests/unit/SidebarTest.ts b/tests/unit/SidebarTest.ts
@@ -57,7 +57,6 @@ describe('Sidebar', () => {
             };
 
             const reportNameValuePairs = {
-                // eslint-disable-next-line @typescript-eslint/naming-convention
                 private_isArchived: DateUtils.getDBTime(),
             };
 
@@ -120,7 +119,6 @@ describe('Sidebar', () => {
                 },
             };
             const reportNameValuePairs = {
-                // eslint-disable-next-line @typescript-eslint/naming-convention
                 private_isArchived: DateUtils.getDBTime(),
             };
-Original file line number
+Diff line change
@@ Expand Up / @@ -479,7 +479,6 @@ describe('OptionsListUtils', () => { @@
         };
         const reportNameValuePairs = {
-            // eslint-disable-next-line @typescript-eslint/naming-convention
             private_isArchived: DateUtils.getDBTime(),
         };
@@ Expand Down @@