add eslint rule consistent-type-definations

ad1992 · Apr 5, 2024 · 5d1ac22 · 5d1ac22
1 parent 0d00e88
commit 5d1ac22
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 3 deletions.
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -53,6 +53,7 @@ module.exports = {
     '@typescript-eslint/no-floating-promises': 'error',
     '@typescript-eslint/no-misused-promises': 'error',
     '@typescript-eslint/no-unused-vars': 'warn',
+    '@typescript-eslint/consistent-type-definitions': 'warn',
     '@typescript-eslint/ban-ts-comment': [
       'error',
       {

diff --git a/packages/mermaid/src/diagrams/sequence/sequenceDb.ts b/packages/mermaid/src/diagrams/sequence/sequenceDb.ts
@@ -11,16 +11,17 @@ import {
   setDiagramTitle,
 } from '../common/commonDb.js';
 import { ImperativeState } from '../../utils/imperativeState.js';
-import type { Actor, AddMessageParams, Box, Message } from './types.js';
+import type { Actor, AddMessageParams, Box, Message, Note } from './types.js';
 
+// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
 type State = {
   prevActor?: string;
   actors: Record<string, Actor>;
   createdActors: Record<string, number>;
   destroyedActors: Record<string, number>;
   boxes: Box[];
   messages: Message[];
-  notes: unknown[];
+  notes: Note[];
   sequenceNumbersEnabled: boolean;
   wrapEnabled?: boolean;
   currentBox?: Box;
@@ -343,7 +344,7 @@ export const addNote = function (
   placement: Message['placement'],
   message: { text: string; wrap?: boolean }
 ) {
-  const note = {
+  const note: Note = {
     actor: actor,
     placement: placement,
     message: message.text,

diff --git a/packages/mermaid/src/diagrams/sequence/types.ts b/packages/mermaid/src/diagrams/sequence/types.ts
@@ -83,3 +83,10 @@ export interface AddMessageParams {
 
   activate: boolean;
 }
+
+export interface Note {
+  actor: { actor: string };
+  placement: Message['placement'];
+  message: string;
+  wrap: boolean;
+}