Skip to content

fix: declare regular enums instead of const enums #379

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tbouffard merged 3 commits into from
Apr 7, 2024
Merged

fix: declare regular enums instead of const enums #379

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c0bdcb8
fix: use regular enum instead of const enums
tbouffard Apr 4, 2024
09a2018
fix 2 remaining const enums
tbouffard Apr 4, 2024
88b23bd
fix 3 remaining const enums
tbouffard Apr 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion .eslintrc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@
"@typescript-eslint/no-this-alias": "warn",
"@typescript-eslint/no-explicit-any": "off",
"@typescript-eslint/no-duplicate-enum-values": "off", // check the impact of changing enum values if we want to enable this
"@typescript-eslint/no-unused-vars": "off"
"@typescript-eslint/no-unused-vars": "off",
"no-restricted-syntax": [
"error",
// ban const enums
{
"selector": "TSEnumDeclaration[const=true]",
"message": "Const enums are forbidden to increase interoperability. Use regular enums instead."
}
]
}
}
146 changes: 48 additions & 98 deletions packages/core/src/util/Constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,32 +34,20 @@ export const MIN_HOTSPOT_SIZE = 8;
*/
export const MAX_HOTSPOT_SIZE = 0;

/**
* Defines the exact rendering hint.
*
* Defines the faster rendering hint.
*
* Defines the fastest rendering hint.
*/
export const enum RENDERING_HINT {
export enum RENDERING_HINT {
EXACT = 'exact',
FASTER = 'faster',
FASTEST = 'fastest',
}

/**
* - DIALECT.SVG: Defines the SVG display dialect name.
*
* - DIALECT.MIXEDHTML: Defines the mixed HTML display dialect name.
*
* - DIALECT.PREFERHTML: Defines the preferred HTML display dialect name.
*
* - DIALECT.STRICTHTML: Defines the strict HTML display dialect.
*/
export const enum DIALECT {
export enum DIALECT {
/** the SVG display dialect name. */
SVG = 'svg',
/** the mixed HTML display dialect name. */
MIXEDHTML = 'mixedHtml',
/** the preferred HTML display dialect name. */
PREFERHTML = 'preferHtml',
/** the strict HTML display dialect name. */
STRICTHTML = 'strictHtml',
}

Expand Down Expand Up @@ -100,7 +88,7 @@ export const SHADOW_OFFSET_Y = 3;
*/
export const SHADOW_OPACITY = 1;

export const enum NODETYPE {
export enum NODETYPE {
ELEMENT = 1,
ATTRIBUTE = 2,
TEXT = 3,
Expand Down Expand Up @@ -160,28 +148,20 @@ export const HIGHLIGHT_SIZE = 2;
*/
export const HIGHLIGHT_OPACITY = 100;

/**
* - CURSOR_MOVABLE_VERTEX: Defines the cursor for a movable vertex. Default is 'move'.
*
* - CURSOR_MOVABLE_EDGE: Defines the cursor for a movable edge. Default is 'move'.
*
* - CURSOR_LABEL_HANDLE: Defines the cursor for a movable label. Default is 'default'.
*
* - CURSOR_TERMINAL_HANDLE: Defines the cursor for a terminal handle. Default is 'pointer'.
*
* - CURSOR_BEND_HANDLE: Defines the cursor for a movable bend. Default is 'crosshair'.
*
* - CURSOR_VIRTUAL_BEND_HANDLE: Defines the cursor for a movable bend. Default is 'crosshair'.
*
* - CURSOR_CONNECT: Defines the cursor for a connectable state. Default is 'pointer'.
*/
export const enum CURSOR {
export enum CURSOR {
/** Defines the cursor for a movable vertex. */
MOVABLE_VERTEX = 'move',
/** Defines the cursor for a movable edge. */
MOVABLE_EDGE = 'move',
/** Defines the cursor for a movable label. */
LABEL_HANDLE = 'default',
/** Defines the cursor for a terminal handle. */
TERMINAL_HANDLE = 'pointer',
/** Defines the cursor for a movable bend. */
BEND_HANDLE = 'crosshair',
/** Defines the cursor for a movable bend. */
VIRTUAL_BEND_HANDLE = 'crosshair',
/** Defines the cursor for a connectable state. */
CONNECT = 'pointer',
}

Expand Down Expand Up @@ -461,99 +441,69 @@ export const PAGE_FORMAT_LETTER_LANDSCAPE = [0, 0, 1100, 850];
*/
export const NONE = 'none';

/**
* - FONT_BOLD: Constant for bold fonts. Default is 1.
*
* - FONT_ITALIC: Constant for italic fonts. Default is 2.
*
* - FONT_UNDERLINE: Constant for underlined fonts. Default is 4.
*
* - FONT_STRIKETHROUGH: Constant for strikethrough fonts. Default is 8.
*/
export const enum FONT {
export enum FONT {
/** for bold fonts. */
BOLD = 1,
/** for italic fonts. */
ITALIC = 2,
/** for underlined fonts. */
UNDERLINE = 4,
/** for strikethrough fonts. */
STRIKETHROUGH = 8,
}

/**
* - ARROW_CLASSIC: Constant for classic arrow markers.
*
* - ARROW_CLASSIC_THIN: Constant for thin classic arrow markers.
*
* - ARROW_BLOCK: Constant for block arrow markers.
*
* - ARROW_BLOCK_THIN: Constant for thin block arrow markers.
*
* - ARROW_OPEN: Constant for open arrow markers.
*
* - ARROW_OPEN_THIN: Constant for thin open arrow markers.
*
* - ARROW_OVAL: Constant for oval arrow markers.
*
* - ARROW_DIAMOND: Constant for diamond arrow markers.
*
* - ARROW_DIAMOND_THIN: Constant for thin diamond arrow markers.
*/
export const enum ARROW {
export enum ARROW {
/** for classic arrow markers. */
CLASSIC = 'classic',
/** for thin classic arrow markers. */
CLASSIC_THIN = 'classicThin',
/** for block arrow markers. */
BLOCK = 'block',
/** for thin block arrow markers. */
BLOCK_THIN = 'blockThin',
/** for open arrow markers. */
OPEN = 'open',
/** for thin open arrow markers. */
OPEN_THIN = 'openThin',
/** for oval arrow markers. */
OVAL = 'oval',
/** for diamond arrow markers. */
DIAMOND = 'diamond',
/** for thin diamond arrow markers. */
DIAMOND_THIN = 'diamondThin',
}

/**
* - ALIGN_LEFT: Constant for left horizontal alignment. Default is left.
*
* - ALIGN_CENTER: Constant for center horizontal alignment. Default is center.
*
* - ALIGN_RIGHT: Constant for right horizontal alignment. Default is right.
*
* - ALIGN_TOP: Constant for top vertical alignment. Default is top.
*
* - ALIGN_MIDDLE: Constant for middle vertical alignment. Default is middle.
*
* - ALIGN_BOTTOM: Constant for bottom vertical alignment. Default is bottom.
*/
export const enum ALIGN {
export enum ALIGN {
/** left horizontal alignment. */
LEFT = 'left',
/** center horizontal alignment. */
CENTER = 'center',
/** right horizontal alignment. */
RIGHT = 'right',
/** top vertical alignment. */
TOP = 'top',
/** middle vertical alignment. */
MIDDLE = 'middle',
/** bottom vertical alignment. */
BOTTOM = 'bottom',
}

export const enum DIRECTION {
export enum DIRECTION {
NORTH = 'north',
SOUTH = 'south',
EAST = 'east',
WEST = 'west',
}

/**
* Constant for text direction default. Default is an empty string. Use
* this value to use the default text direction of the operating system.
*
* Constant for text direction automatic. Default is auto. Use this value
* to find the direction for a given text with {@link Text#getAutoDirection}.
*
* Constant for text direction left to right. Default is ltr. Use this
* value for left to right text direction.
*
* Constant for text direction right to left. Default is rtl. Use this
* value for right to left text direction.
*/
export const enum TEXT_DIRECTION {
export enum TEXT_DIRECTION {
/**
* Use this value to use the default text direction of the operating system. */
DEFAULT = '',
/** Use this value to find the direction for a given text with {@link Text#getAutoDirection}. */
AUTO = 'auto',
/** Use this value for left to right text direction. */
LTR = 'ltr',
/** Use this value for right to left text direction. */
RTL = 'rtl',
}

Expand Down Expand Up @@ -582,15 +532,15 @@ export const DIRECTION_MASK = {
/**
* Default is horizontal.
*/
export const enum ELBOW {
export enum ELBOW {
VERTICAL = 'vertical',
HORIZONTAL = 'horizontal',
}

/**
* Can be used as a string value for the STYLE_EDGE style.
*/
export const enum EDGESTYLE {
export enum EDGESTYLE {
ELBOW = 'elbowEdgeStyle',
ENTITY_RELATION = 'entityRelationEdgeStyle',
LOOP = 'loopEdgeStyle',
Expand All @@ -604,15 +554,15 @@ export const enum EDGESTYLE {
/**
* Can be used as a string value for the STYLE_PERIMETER style.
*/
export const enum PERIMETER {
export enum PERIMETER {
ELLIPSE = 'ellipsePerimeter',
RECTANGLE = 'rectanglePerimeter',
RHOMBUS = 'rhombusPerimeter',
HEXAGON = 'hexagonPerimeter',
TRIANGLE = 'trianglePerimeter',
}

export const enum SHAPE {
export enum SHAPE {
/**
* Name under which {@link RectangleShape} is registered in {@link CellRenderer}.
* Default is rectangle.
Expand Down
1 change: 1 addition & 0 deletions packages/core/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"declaration": true,
"declarationMap": false,
"emitDeclarationOnly": false,
"isolatedModules": true,
"outDir": "./dist",
"strict": true,
"skipLibCheck": false,
Expand Down