feat: allow _destroy as a property

The `_destroy: true` property is used as a special key in monolith/ruby-on-rails APIs to indicate that the sub-record should be destroyed so we should allow this specific exception.
tablecheck · Apr 1, 2024 · 0c200d7 · 0c200d7
1 parent 1abc1a6
commit 0c200d7
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 0 deletions.
diff --git a/.prettierignore b/.prettierignore
@@ -11,3 +11,4 @@ dist
 .prettierignore
 styleguide
 CHANGELOG.md
+.all-contributorsrc
diff --git a/packages/eslint-config/src/rules/namingConvention.ts b/packages/eslint-config/src/rules/namingConvention.ts
@@ -111,6 +111,15 @@ export const namingRules: Linter.RulesRecord = {
         match: false,
       },
     },
+    {
+      selector: ['property', 'parameterProperty'],
+      format: null,
+      types: ['boolean'],
+      filter: {
+        regex: '^_destroy$', // _destroy is used in monolith APIs as a convention
+        match: true,
+      },
+    },
     {
       selector: ['property', 'parameterProperty'],
       format: ['camelCase', 'PascalCase', 'snake_case', 'UPPER_CASE'],

diff --git a/packages/eslint-config/tests/namingConvention.ts/variables.tsx b/packages/eslint-config/tests/namingConvention.ts/variables.tsx
@@ -11,3 +11,6 @@ function SomeComponent({ icon: Icon, command }) {
   const { other: Other } = command;
   const iconComponentRef = null;
 }
+
+/** _destroy: true special property */
+saveValue({ id: 'id', _destroy: true });