Merge pull request #240 from qonto/eslint-ts-config

chore(lint): add specific set of rules for TypeScript linting and run lint with --fix option
qonto · Oct 16, 2023 · d8ac234 · d8ac234
2 parents 9249662 + 9e7f3ce
commit d8ac234
Show file tree

Hide file tree

Showing 9 changed files with 145 additions and 29 deletions.
diff --git a/ember-lottie/.eslintrc.js b/ember-lottie/.eslintrc.js
@@ -26,7 +26,61 @@ module.exports = {
         'plugin:@typescript-eslint/recommended',
       ],
       rules: {
-        // Add any custom rules here
+        // https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/recommended.ts
+        '@typescript-eslint/no-explicit-any': 'error',
+        '@typescript-eslint/no-non-null-assertion': 'error',
+        '@typescript-eslint/no-unused-vars': 'error',
+        // https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/strict.ts
+        '@typescript-eslint/array-type': [
+          'error',
+          {
+            default: 'array',
+            readonly: 'array',
+          },
+        ],
+        '@typescript-eslint/ban-tslint-comment': 'error',
+        '@typescript-eslint/class-literal-property-style': 'error',
+        '@typescript-eslint/consistent-generic-constructors': 'error',
+        '@typescript-eslint/consistent-indexed-object-style': 'error',
+        '@typescript-eslint/consistent-type-assertions': 'error',
+        '@typescript-eslint/consistent-type-definitions': 'error',
+        '@typescript-eslint/consistent-type-imports': 'error',
+        '@typescript-eslint/explicit-function-return-type': 'error',
+        '@typescript-eslint/explicit-member-accessibility': [
+          'error',
+          {
+            accessibility: 'no-public',
+          },
+        ],
+        '@typescript-eslint/explicit-module-boundary-types': 'error',
+        '@typescript-eslint/member-delimiter-style': 'error',
+        '@typescript-eslint/member-ordering': 'error',
+        '@typescript-eslint/method-signature-style': 'error',
+        '@typescript-eslint/no-confusing-non-null-assertion': 'error',
+        '@typescript-eslint/no-duplicate-enum-values': 'error',
+        '@typescript-eslint/no-dynamic-delete': 'error',
+        '@typescript-eslint/no-extraneous-class': 'error',
+        '@typescript-eslint/no-import-type-side-effects': 'error',
+        '@typescript-eslint/no-invalid-void-type': 'error',
+        '@typescript-eslint/no-non-null-asserted-nullish-coalescing': 'error',
+        '@typescript-eslint/no-require-imports': 'error',
+        '@typescript-eslint/no-type-alias': [
+          'error',
+          {
+            allowGenerics: 'always',
+          },
+        ],
+        '@typescript-eslint/no-unsafe-declaration-merging': 'error',
+        '@typescript-eslint/parameter-properties': 'error',
+        '@typescript-eslint/prefer-enum-initializers': 'error',
+        '@typescript-eslint/prefer-for-of': 'error',
+        '@typescript-eslint/prefer-function-type': 'error',
+        '@typescript-eslint/prefer-literal-enum-member': 'error',
+        '@typescript-eslint/prefer-ts-expect-error': 'error',
+        '@typescript-eslint/sort-type-constituents': 'error',
+        '@typescript-eslint/type-annotation-spacing': 'error',
+        '@typescript-eslint/typedef': 'error',
+        '@typescript-eslint/unified-signatures': 'error',
       },
     },
     // node files

diff --git a/ember-lottie/src/components/lottie.ts b/ember-lottie/src/components/lottie.ts
@@ -3,7 +3,7 @@ import { action } from '@ember/object';
 import { buildWaiter } from '@ember/test-waiters';
 import Ember from 'ember';
 
-import { AnimationItem, LottiePlayer } from 'lottie-web';
+import type { AnimationItem, LottiePlayer } from 'lottie-web';
 import window from 'ember-window-mock';
 
 const waiter = buildWaiter('ember-lottie:lottie-waiter');
@@ -53,11 +53,11 @@ export default class LottieComponent extends Component<LottieSignature> {
   private animation?: AnimationItem;
   private mediaQuery = window.matchMedia?.('(prefers-reduced-motion: reduce)');
 
-  get autoplay() {
+  get autoplay(): boolean {
     return this.canAutoplay ?? true;
   }
 
-  get canAutoplay() {
+  get canAutoplay(): boolean | undefined {
     const prefersReducedMotion = this.mediaQuery?.matches;
     return !prefersReducedMotion && this.args.autoplay;
   }
@@ -119,7 +119,15 @@ export default class LottieComponent extends Component<LottieSignature> {
     );
   }
 
-  willDestroy() {
+  @action
+  private handleReducedMotionPreferenceChange(): void {
+    const prefersReducedMotion = this.mediaQuery?.matches;
+    if (prefersReducedMotion) {
+      this.animation?.stop();
+    }
+  }
+
+  willDestroy(): void {
     super.willDestroy();
 
     this.mediaQuery?.removeEventListener(
@@ -132,14 +140,6 @@ export default class LottieComponent extends Component<LottieSignature> {
     }
   }
 
-  @action
-  private handleReducedMotionPreferenceChange() {
-    const prefersReducedMotion = this.mediaQuery?.matches;
-    if (prefersReducedMotion) {
-      this.animation?.stop();
-    }
-  }
-
   private async loadLottie(): Promise<LottiePlayer> {
     const lottieModule = await import('lottie-web');
     return lottieModule.default;

diff --git a/ember-lottie/src/template-registry.ts b/ember-lottie/src/template-registry.ts
@@ -1,4 +1,4 @@
-import LottieComponent from './components/lottie';
+import type LottieComponent from './components/lottie';
 
 export default interface Registry {
   Lottie: typeof LottieComponent;

diff --git a/ember-lottie/src/unpublished-development-types/index.d.ts b/ember-lottie/src/unpublished-development-types/index.d.ts
@@ -9,7 +9,7 @@ import 'ember-source/types';
 import 'ember-source/types/preview';
 
 declare class RenderModifier<
-  Args extends Array<unknown> = Array<unknown>,
+  Args extends unknown[] = unknown[],
 > extends Modifier<{
   Element: HTMLElement;
   Args: { Positional: [(element: HTMLElement, args: Args) => void, ...Args] };

diff --git a/test-app/.eslintrc.js b/test-app/.eslintrc.js
@@ -25,7 +25,63 @@ module.exports = {
         'plugin:@typescript-eslint/eslint-recommended',
         'plugin:@typescript-eslint/recommended',
       ],
-      rules: {},
+      rules: {
+        // https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/recommended.ts
+        '@typescript-eslint/no-explicit-any': 'error',
+        '@typescript-eslint/no-non-null-assertion': 'error',
+        '@typescript-eslint/no-unused-vars': 'error',
+        // https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/strict.ts
+        '@typescript-eslint/array-type': [
+          'error',
+          {
+            default: 'array',
+            readonly: 'array',
+          },
+        ],
+        '@typescript-eslint/ban-tslint-comment': 'error',
+        '@typescript-eslint/class-literal-property-style': 'error',
+        '@typescript-eslint/consistent-generic-constructors': 'error',
+        '@typescript-eslint/consistent-indexed-object-style': 'error',
+        '@typescript-eslint/consistent-type-assertions': 'error',
+        '@typescript-eslint/consistent-type-definitions': 'error',
+        '@typescript-eslint/consistent-type-imports': 'error',
+        '@typescript-eslint/explicit-function-return-type': 'error',
+        '@typescript-eslint/explicit-member-accessibility': [
+          'error',
+          {
+            accessibility: 'no-public',
+          },
+        ],
+        '@typescript-eslint/explicit-module-boundary-types': 'error',
+        '@typescript-eslint/member-delimiter-style': 'error',
+        '@typescript-eslint/member-ordering': 'error',
+        '@typescript-eslint/method-signature-style': 'error',
+        '@typescript-eslint/no-confusing-non-null-assertion': 'error',
+        '@typescript-eslint/no-duplicate-enum-values': 'error',
+        '@typescript-eslint/no-dynamic-delete': 'error',
+        '@typescript-eslint/no-extraneous-class': 'error',
+        '@typescript-eslint/no-import-type-side-effects': 'error',
+        '@typescript-eslint/no-invalid-void-type': 'error',
+        '@typescript-eslint/no-non-null-asserted-nullish-coalescing': 'error',
+        '@typescript-eslint/no-require-imports': 'error',
+        '@typescript-eslint/no-type-alias': [
+          'error',
+          {
+            allowGenerics: 'always',
+          },
+        ],
+        '@typescript-eslint/no-unsafe-declaration-merging': 'error',
+        '@typescript-eslint/parameter-properties': 'error',
+        '@typescript-eslint/prefer-enum-initializers': 'error',
+        '@typescript-eslint/prefer-for-of': 'error',
+        '@typescript-eslint/prefer-function-type': 'error',
+        '@typescript-eslint/prefer-literal-enum-member': 'error',
+        '@typescript-eslint/prefer-ts-expect-error': 'error',
+        '@typescript-eslint/sort-type-constituents': 'error',
+        '@typescript-eslint/type-annotation-spacing': 'error',
+        '@typescript-eslint/typedef': 'error',
+        '@typescript-eslint/unified-signatures': 'error',
+      },
     },
     // node files
     {

diff --git a/test-app/app/config/environment.d.ts b/test-app/app/config/environment.d.ts
@@ -6,7 +6,7 @@ declare const config: {
   environment: string;
   modulePrefix: string;
   podModulePrefix: string;
-  locationType: 'history' | 'hash' | 'none' | 'auto';
+  locationType: 'auto' | 'hash' | 'history' | 'none';
   rootURL: string;
   APP: Record<string, unknown>;
 };

diff --git a/test-app/tests/helpers/index.ts b/test-app/tests/helpers/index.ts
@@ -1,15 +1,18 @@
+import type { SetupTestOptions } from 'ember-qunit';
 import {
   setupApplicationTest as upstreamSetupApplicationTest,
   setupRenderingTest as upstreamSetupRenderingTest,
   setupTest as upstreamSetupTest,
-  SetupTestOptions,
 } from 'ember-qunit';
 
 // This file exists to provide wrappers around ember-qunit's / ember-mocha's
 // test setup functions. This way, you can easily extend the setup that is
 // needed per test type.
 
-function setupApplicationTest(hooks: NestedHooks, options?: SetupTestOptions) {
+function setupApplicationTest(
+  hooks: NestedHooks,
+  options: SetupTestOptions,
+): void {
   upstreamSetupApplicationTest(hooks, options);
 
   // Additional setup for application tests can be done here.
@@ -28,13 +31,16 @@ function setupApplicationTest(hooks: NestedHooks, options?: SetupTestOptions) {
   // setupMirage(hooks); // ember-cli-mirage
 }
 
-function setupRenderingTest(hooks: NestedHooks, options?: SetupTestOptions) {
+function setupRenderingTest(
+  hooks: NestedHooks,
+  options: SetupTestOptions,
+): void {
   upstreamSetupRenderingTest(hooks, options);
 
   // Additional setup for rendering tests can be done here.
 }
 
-function setupTest(hooks: NestedHooks, options?: SetupTestOptions) {
+function setupTest(hooks: NestedHooks, options: SetupTestOptions): void {
   upstreamSetupTest(hooks, options);
 
   // Additional setup for unit tests can be done here.

diff --git a/test-app/tests/integration/components/lottie-test.ts b/test-app/tests/integration/components/lottie-test.ts
@@ -34,7 +34,7 @@ module('Integration | Component | lottie', function (hooks) {
   });
 
   test('it renders', async function (this: TestContext, assert) {
-    this.args.onDataReady = () => assert.step('data ready called');
+    this.args.onDataReady = (): void => assert.step('data ready called');
 
     await render(hbs`
       <Lottie
@@ -48,7 +48,7 @@ module('Integration | Component | lottie', function (hooks) {
   });
 
   test('it calls window.matchMedia to check for prefers-reduced-motion', async function (this: TestContext, assert) {
-    window.matchMedia = (mediaQuery) => {
+    window.matchMedia = (mediaQuery): MediaQueryList => {
       assert.step(`matchMedia(${mediaQuery})`);
       return {
         addEventListener: sinon.spy(),
@@ -70,7 +70,7 @@ module('Integration | Component | lottie', function (hooks) {
   test('it should listen for changes to prefers-reduced-motion and cleanup the listener when destroyed', async function (this: TestContext, assert) {
     const addEventListener = sinon.spy();
     const removeEventListener = sinon.spy();
-    window.matchMedia = () => {
+    window.matchMedia = (): MediaQueryList => {
       return {
         addEventListener,
         removeEventListener,
@@ -92,7 +92,7 @@ module('Integration | Component | lottie', function (hooks) {
   });
 
   test('it should not autoplay the animation when prefers-reduced-motion is enabled', async function (this: TestContext, assert) {
-    window.matchMedia = () => {
+    window.matchMedia = (): MediaQueryList => {
       return {
         addEventListener: () => {
           /** noop */
@@ -116,7 +116,7 @@ module('Integration | Component | lottie', function (hooks) {
   });
 
   test('it should not autoplay the animation when autoplay is false', async function (this: TestContext, assert) {
-    window.matchMedia = () => {
+    window.matchMedia = (): MediaQueryList => {
       return {
         addEventListener: () => {
           /** noop */
@@ -140,7 +140,7 @@ module('Integration | Component | lottie', function (hooks) {
   });
 
   test('it should autoplay the animation when prefers-reduced-motion is disabled', async function (this: TestContext, assert) {
-    window.matchMedia = () => {
+    window.matchMedia = (): MediaQueryList => {
       return {
         addEventListener: () => {
           /** noop */
@@ -164,7 +164,7 @@ module('Integration | Component | lottie', function (hooks) {
   });
 
   test('it should autoplay the animation by default when prefers-reduced-motion is disabled', async function (this: TestContext, assert) {
-    window.matchMedia = () => {
+    window.matchMedia = (): MediaQueryList => {
       return {
         addEventListener: () => {
           /** noop */

diff --git a/test-app/types/global.d.ts b/test-app/types/global.d.ts
@@ -1,6 +1,6 @@
 // Types for compiled templates
 declare module 'test-app/templates/*' {
-  import { TemplateFactory } from 'ember-cli-htmlbars';
+  import type { TemplateFactory } from 'ember-cli-htmlbars';
 
   const tmpl: TemplateFactory;
   export default tmpl;