feat: fine tune naming conventions (#92)

silvermine · Jul 27, 2023 · ae13be5 · ae13be5
1 parent 9fd9ad7
commit ae13be5
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 2 deletions.
diff --git a/index.js b/index.js
@@ -322,6 +322,23 @@ module.exports = {
                   format: [ 'snake_case' ],
                   leadingUnderscore: 'require',
                },
+               {
+                  selector: 'classProperty',
+                  modifiers: [ 'private', 'readonly', 'static' ],
+                  format: [ 'UPPER_CASE' ],
+                  leadingUnderscore: 'require',
+               },
+               {
+                  selector: 'classProperty',
+                  modifiers: [ 'protected', 'readonly', 'static' ],
+                  format: [ 'UPPER_CASE' ],
+                  leadingUnderscore: 'require',
+               },
+               {
+                  selector: 'classProperty',
+                  modifiers: [ 'public', 'readonly', 'static' ],
+                  format: [ 'UPPER_CASE' ],
+               },
                {
                   selector: 'classProperty',
                   modifiers: [ 'protected', 'static' ],
@@ -344,11 +361,11 @@ module.exports = {
                },
                {
                   selector: 'variable',
-                  format: [ 'camelCase' ],
+                  format: [ 'camelCase', 'PascalCase' ],
                },
                {
                   selector: 'parameter',
-                  format: [ 'camelCase' ],
+                  format: [ 'camelCase', 'PascalCase' ],
                   leadingUnderscore: 'allow',
                },
                {

diff --git a/test-cases/typescript/SmallClass.ts b/test-cases/typescript/SmallClass.ts
@@ -0,0 +1,11 @@
+export class SmallClass {
+   private readonly _helloThere: string;
+
+   public constructor(hello: string) {
+      this._helloThere = hello;
+   }
+
+   public sayHello(): string {
+      return this._helloThere;
+   }
+}
diff --git a/test-cases/typescript/TestClass.ts b/test-cases/typescript/TestClass.ts
@@ -1,13 +1,21 @@
+import { SmallClass } from './SmallClass';
+
 /**
  * Test class that adheres to our ESLint rules for TypeScript
  * @param test
  */
 export class TestClass {
 
+   public static readonly BANANA_SWEETNESS: string;
+
+   protected static readonly _BANANA_RIPENESS: string;
+
    protected static _banana_sweetness: string;
 
    private static _apple_type: string;
 
+   private static readonly _APPLE_COLOR: string;
+
    private readonly _appleColor: string;
 
    public constructor(appleColor: string, appleType: string, bananaSweetness: string) {
@@ -28,6 +36,12 @@ export class TestClass {
       return TestClass.get_apple_type();
    }
 
+   public provideSmallClass(Small: new (...args) => SmallClass): string {
+      const MySmallClass = new Small('Hello there!');
+
+      return MySmallClass.sayHello();
+   }
+
    protected _getBananaSweetness(): string {
       return TestClass._banana_sweetness;
    }