Forbid TypeScript's private modifier in favour of hash names (#244)

* Forbid TypeScript's private modifier * Update snapshot
MetaMask · Oct 31, 2022 · 1842f05 · 1842f05
1 parent 717b531
commit 1842f05
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/packages/typescript/rules-snapshot.json b/packages/typescript/rules-snapshot.json
@@ -90,6 +90,13 @@
   "no-new-symbol": "off",
   "no-obj-calls": "off",
   "no-redeclare": "off",
+  "no-restricted-syntax": [
+    "error",
+    {
+      "selector": "PropertyDefinition[accessibility='private'], MethodDefinition[accessibility='private'], TSParameterProperty[accessibility='private']",
+      "message": "Use a hash name instead."
+    }
+  ],
   "no-setter-return": "off",
   "no-shadow": "off",
   "no-this-before-super": "off",

diff --git a/packages/typescript/src/index.js b/packages/typescript/src/index.js
@@ -95,5 +95,15 @@ module.exports = {
     'jsdoc/require-property-type': 'off',
     'jsdoc/require-returns-type': 'off',
     'jsdoc/valid-types': 'off',
+
+    // Prefer hash names over TypeScript's `private` modifier.
+    'no-restricted-syntax': [
+      'error',
+      {
+        selector:
+          "PropertyDefinition[accessibility='private'], MethodDefinition[accessibility='private'], TSParameterProperty[accessibility='private']",
+        message: 'Use a hash name instead.',
+      },
+    ],
   },
 };