ci: add eslint rules for declare enums (#4825)

taiga-family · Jul 3, 2023 · 923975a · 923975a
1 parent 816759f
commit 923975a
Show file tree

Hide file tree

Showing 16 changed files with 35 additions and 6 deletions.
diff --git a/projects/addon-commerce/enums/currency-code.ts b/projects/addon-commerce/enums/currency-code.ts
@@ -6,6 +6,8 @@
  *
  * @link https://en.wikipedia.org/wiki/ISO_4217
  */
+// TODO: change type in v4.0
+// eslint-disable-next-line no-restricted-syntax
 export enum TuiCurrencyCode {
     /**
      * Russian ruble

diff --git a/projects/addon-commerce/enums/currency.ts b/projects/addon-commerce/enums/currency.ts
@@ -7,6 +7,8 @@
  *
  * @link https://en.wikipedia.org/wiki/ISO_4217
  */
+// TODO: change type in v4.0
+// eslint-disable-next-line no-restricted-syntax
 export enum TuiCurrency {
     /**
      * Russian ruble

diff --git a/...r/components/toolbar-tools/table-row-column-manager/table-row-column-manager.component.ts b/...r/components/toolbar-tools/table-row-column-manager/table-row-column-manager.component.ts
@@ -9,6 +9,8 @@ import {TuiLanguageEditor} from '@taiga-ui/i18n';
 import {Observable} from 'rxjs';
 import {map} from 'rxjs/operators';
 
+// TODO: change type in v4.0
+// eslint-disable-next-line no-restricted-syntax
 export enum TuiTableCommands {
     InsertColumnBefore,
     InsertColumnAfter,

diff --git a/projects/addon-editor/enums/editor-tool.ts b/projects/addon-editor/enums/editor-tool.ts
@@ -1,3 +1,5 @@
+// TODO: change type in v4.0
+// eslint-disable-next-line no-restricted-syntax
 export enum TuiEditorTool {
     Undo = `undo`,
     Anchor = `anchor`,

diff --git a/projects/cdk/enums/day-of-week.ts b/projects/cdk/enums/day-of-week.ts
@@ -1,3 +1,5 @@
+// TODO: change type in v4.0
+// eslint-disable-next-line no-restricted-syntax
 export enum TuiDayOfWeek {
     Sunday,
     Monday,

diff --git a/projects/cdk/enums/month-number.ts b/projects/cdk/enums/month-number.ts
@@ -1,3 +1,5 @@
+// TODO: change type in v4.0
+// eslint-disable-next-line no-restricted-syntax
 export enum TuiMonthNumber {
     January,
     February,

diff --git a/projects/cdk/observables/drag-and-drop-from.ts b/projects/cdk/observables/drag-and-drop-from.ts
@@ -6,6 +6,8 @@ import {endWith, map, repeat, take, takeWhile} from 'rxjs/operators';
 import {tuiMouseDragFinishFrom} from './mouse-drag-finish-from';
 import {tuiTypedFromEvent} from './typed-from-event';
 
+// TODO: change type in v4.0
+// eslint-disable-next-line no-restricted-syntax
 export enum TuiDragStage {
     Start,
     Continues,

diff --git a/projects/core/enums/appearance.ts b/projects/core/enums/appearance.ts
@@ -1,3 +1,5 @@
+// TODO: change type in v4.0
+// eslint-disable-next-line no-restricted-syntax
 export enum TuiAppearance {
     Icon = `icon`,
     Primary = `primary`,

diff --git a/projects/core/enums/dropdown-animation.ts b/projects/core/enums/dropdown-animation.ts
@@ -1,4 +1,5 @@
 /** @deprecated not used anymore TODO: remove in 4.0 **/
+// eslint-disable-next-line no-restricted-syntax
 export enum TuiDropdownAnimation {
     FadeInBottom = `fadeInBottom`,
     FadeInTop = `fadeInTop`,

diff --git a/projects/core/enums/interactive-state.ts b/projects/core/enums/interactive-state.ts
@@ -1,6 +1,8 @@
 /**
  * @internal used in calendar, year picker and wrapper
  */
+// TODO: change type in v4.0
+// eslint-disable-next-line no-restricted-syntax
 export enum TuiInteractiveState {
     Disabled = `disabled`,
     Readonly = `readonly`,

diff --git a/projects/core/enums/notification.ts b/projects/core/enums/notification.ts
@@ -1,3 +1,5 @@
+// TODO: change type in v4.0
+// eslint-disable-next-line no-restricted-syntax
 export enum TuiNotification {
     Info = `info`,
     Warning = `warning`,

diff --git a/projects/core/enums/range-state.ts b/projects/core/enums/range-state.ts
@@ -1,6 +1,8 @@
 /**
  * @internal used in calendar and year picker
  */
+// TODO: change type in v4.0
+// eslint-disable-next-line no-restricted-syntax
 export enum TuiRangeState {
     Start = `start`,
     End = `end`,

diff --git a/projects/demo/src/modules/components/dialog/examples/9/helpers/models.ts b/projects/demo/src/modules/components/dialog/examples/9/helpers/models.ts
@@ -1,7 +1,7 @@
-export enum PaymentMode {
-    ByNewCard = 0,
-    BySavedCard = 1,
-}
+export const PaymentMode = {
+    ByNewCard: 0,
+    BySavedCard: 1,
+} as const;
 
 export interface FetchedCards {
     cards: AccountCard[];

diff --git a/projects/demo/src/modules/components/dialog/examples/9/pay-modal/pay-modal.component.ts b/projects/demo/src/modules/components/dialog/examples/9/pay-modal/pay-modal.component.ts
@@ -12,7 +12,7 @@ import {
     tuiDefaultCardValidator,
     TuiInputCardGroupedComponent,
 } from '@taiga-ui/addon-commerce';
-import {TUI_IS_IOS, TuiDestroyService} from '@taiga-ui/cdk';
+import {TUI_IS_IOS, TuiDestroyService, TuiValuesOf} from '@taiga-ui/cdk';
 import {TuiDialogContext} from '@taiga-ui/core';
 import {POLYMORPHEUS_CONTEXT} from '@tinkoff/ng-polymorpheus';
 import {BehaviorSubject} from 'rxjs';
@@ -47,7 +47,7 @@ export class PayModalComponent implements OnInit {
     });
 
     cards: AccountCard[] = [];
-    paymentMode: PaymentMode = PaymentMode.ByNewCard;
+    paymentMode: TuiValuesOf<typeof PaymentMode> = PaymentMode.ByNewCard;
     loading$ = new BehaviorSubject(false);
     payProcessing$ = new BehaviorSubject(false);
     amount: number = this.context?.data?.amount ?? 0;

diff --git a/projects/i18n/enums/country-iso-code.ts b/projects/i18n/enums/country-iso-code.ts
@@ -1,3 +1,5 @@
+// TODO: change type in v4.0
+// eslint-disable-next-line no-restricted-syntax
 export enum TuiCountryIsoCode {
     AD = `AD`,
     AE = `AE`,

diff --git a/scripts/eslint/no-restricted-syntax.js b/scripts/eslint/no-restricted-syntax.js
@@ -7,6 +7,10 @@ module.exports = {
             rules: {
                 'no-restricted-syntax': [
                     'error',
+                    {
+                        selector: 'TSEnumDeclaration',
+                        message: `Don't declare enums, please use "const MyEnumType = { ... } as const;"`,
+                    },
                     {
                         selector: "CallExpression[callee.name='mapTo']",
                         message: