chore(linting): add naming convention rule (faker-js#1170)

hankucz · Jul 20, 2022 · b0a4847 · b0a4847
1 parent b9284dc
commit b0a4847
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -51,6 +51,15 @@ module.exports = defineConfig({
       },
     ],
     '@typescript-eslint/unbound-method': 'off',
+    '@typescript-eslint/naming-convention': [
+      'error',
+      {
+        format: ['PascalCase'],
+        selector: ['class', 'interface', 'typeAlias', 'enumMember'],
+        leadingUnderscore: 'forbid',
+        trailingUnderscore: 'forbid',
+      },
+    ],
   },
   overrides: [
     {

diff --git a/src/modules/date/index.ts b/src/modules/date/index.ts
@@ -20,6 +20,8 @@ function toDate(date?: string | Date | number): Date {
 /**
  * Module to generate dates.
  */
+// disabled until modules are renamed to something with a suffix
+// eslint-disable-next-line @typescript-eslint/naming-convention
 export class _Date {
   constructor(private readonly faker: Faker) {
     // Bind `this` so namespaced is working correctly

diff --git a/src/modules/name/index.ts b/src/modules/name/index.ts
@@ -1,8 +1,11 @@
 import type { Faker } from '../..';
 import { deprecated } from '../../internal/deprecated';
 
+// disabled until renamed to Sex
 export enum Gender {
+  // eslint-disable-next-line @typescript-eslint/naming-convention
   female = 'female',
+  // eslint-disable-next-line @typescript-eslint/naming-convention
   male = 'male',
 }