Merge pull request #5254 from mermaid-js/chore/InterfaceNaming

chore: Add interface naming Convention
mermaid-js · Jan 31, 2024 · 33d45f6 · 33d45f6
2 parents 7503694 + e9680e0
commit 33d45f6
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 4 deletions.
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -63,6 +63,17 @@ module.exports = {
         minimumDescriptionLength: 10,
       },
     ],
+    '@typescript-eslint/naming-convention': [
+      'error',
+      {
+        selector: 'typeLike',
+        format: ['PascalCase'],
+        custom: {
+          regex: '^I[A-Z]',
+          match: false,
+        },
+      },
+    ],
     'json/*': ['error', 'allowComments'],
     '@cspell/spellchecker': [
       'error',

diff --git a/packages/mermaid/src/diagrams/quadrant-chart/quadrantBuilder.ts b/packages/mermaid/src/diagrams/quadrant-chart/quadrantBuilder.ts
@@ -53,7 +53,7 @@ export interface QuadrantBuildType {
   borderLines?: QuadrantLineType[];
 }
 
-export interface quadrantBuilderData {
+export interface QuadrantBuilderData {
   titleText: string;
   quadrant1Text: string;
   quadrant2Text: string;
@@ -116,15 +116,15 @@ interface CalculateSpaceData {
 export class QuadrantBuilder {
   private config: QuadrantBuilderConfig;
   private themeConfig: QuadrantBuilderThemeConfig;
-  private data: quadrantBuilderData;
+  private data: QuadrantBuilderData;
 
   constructor() {
     this.config = this.getDefaultConfig();
     this.themeConfig = this.getDefaultThemeConfig();
     this.data = this.getDefaultData();
   }
 
-  getDefaultData(): quadrantBuilderData {
+  getDefaultData(): QuadrantBuilderData {
     return {
       titleText: '',
       quadrant1Text: '',
@@ -194,7 +194,7 @@ export class QuadrantBuilder {
     log.info('clear called');
   }
 
-  setData(data: Partial<quadrantBuilderData>) {
+  setData(data: Partial<QuadrantBuilderData>) {
     this.data = { ...this.data, ...data };
   }