chore: prepare for consistent return eslint rule (#1107)

chambo-e · web-flow · commit fe11f6e67a89 · 2022-12-09T12:58:52.000+01:00
* chore: prepare for consistent return eslint rule

* fix: export and type definition
diff --git a/packages/jest-helpers/src/__tests__/index.test.tsx b/packages/jest-helpers/src/__tests__/index.test.tsx
@@ -1,7 +1,7 @@
 import makeHelpers from '..'
-import { RenderWithThemeFn } from '../helpers/renderWithTheme'
-import { ShouldMatchEmotionSnapshotFn } from '../helpers/shouldMatchEmotionSnapshot'
-import { ShouldMatchEmotionSnapshotWithPortalFn } from '../helpers/shouldMatchEmotionSnapshotWithPortal'
+import type { RenderWithThemeFn } from '../helpers/renderWithTheme'
+import type { ShouldMatchEmotionSnapshotFn } from '../helpers/shouldMatchEmotionSnapshot'
+import type { ShouldMatchEmotionSnapshotWithPortalFn } from '../helpers/shouldMatchEmotionSnapshotWithPortal'
 
 describe('@jest-helpers', () => {
   let renderWithTheme: RenderWithThemeFn<unknown>
diff --git a/packages/jest-helpers/src/helpers/renderWithTheme.tsx b/packages/jest-helpers/src/helpers/renderWithTheme.tsx
@@ -1,7 +1,8 @@
 import createCache from '@emotion/cache'
 import { CacheProvider } from '@emotion/react'
-import { RenderOptions, render } from '@testing-library/react'
-import { FC, ReactNode } from 'react'
+import type { RenderOptions } from '@testing-library/react'
+import { render } from '@testing-library/react'
+import type { FC, ReactNode } from 'react'
 
 const emotionCache = createCache({
   key: 'cache',
diff --git a/packages/jest-helpers/src/helpers/shouldMatchEmotionSnapshot.ts b/packages/jest-helpers/src/helpers/shouldMatchEmotionSnapshot.ts
@@ -1,8 +1,8 @@
-import { RenderOptions, render } from '@testing-library/react'
-import { ReactNode } from 'react'
-import { RenderWithThemeFn } from './renderWithTheme'
+import type { RenderOptions, render } from '@testing-library/react'
+import type { ReactNode } from 'react'
+import type { RenderWithThemeFn } from './renderWithTheme'
 
-interface Options<Theme> {
+type Options<Theme> = {
   options?: RenderOptions
   transform?: (node: ReturnType<typeof render>) => Promise<void> | void
   theme?: Theme
diff --git a/packages/jest-helpers/src/helpers/shouldMatchEmotionSnapshotWithPortal.ts b/packages/jest-helpers/src/helpers/shouldMatchEmotionSnapshotWithPortal.ts
@@ -1,8 +1,8 @@
-import { RenderOptions, render } from '@testing-library/react'
-import { ReactNode } from 'react'
-import { RenderWithThemeFn } from './renderWithTheme'
+import type { RenderOptions, render } from '@testing-library/react'
+import type { ReactNode } from 'react'
+import type { RenderWithThemeFn } from './renderWithTheme'
 
-interface Options<Theme> {
+type Options<Theme> = {
   options?: RenderOptions
   transform?: (node: ReturnType<typeof render>) => Promise<void> | void
   theme?: Theme
diff --git a/packages/jest-helpers/src/index.ts b/packages/jest-helpers/src/index.ts
@@ -1,14 +1,12 @@
-import { CreateSerializerOptions, createSerializer } from '@emotion/jest'
-import { FC, ReactNode } from 'react'
-import makeRenderWithTheme, {
-  RenderWithThemeFn,
-} from './helpers/renderWithTheme'
-import makeShouldMatchEmotionSnapshot, {
-  ShouldMatchEmotionSnapshotFn,
-} from './helpers/shouldMatchEmotionSnapshot'
-import makeShouldMatchEmotionSnapshotWithPortal, {
-  ShouldMatchEmotionSnapshotWithPortalFn,
-} from './helpers/shouldMatchEmotionSnapshotWithPortal'
+import type { CreateSerializerOptions } from '@emotion/jest'
+import { createSerializer } from '@emotion/jest'
+import type { FC, ReactNode } from 'react'
+import type { RenderWithThemeFn } from './helpers/renderWithTheme'
+import makeRenderWithTheme from './helpers/renderWithTheme'
+import type { ShouldMatchEmotionSnapshotFn } from './helpers/shouldMatchEmotionSnapshot'
+import makeShouldMatchEmotionSnapshot from './helpers/shouldMatchEmotionSnapshot'
+import type { ShouldMatchEmotionSnapshotWithPortalFn } from './helpers/shouldMatchEmotionSnapshotWithPortal'
+import makeShouldMatchEmotionSnapshotWithPortal from './helpers/shouldMatchEmotionSnapshotWithPortal'
 
 export { default as makeRenderWithTheme } from './helpers/renderWithTheme'
 
diff --git a/packages/outdated-browser/src/index.ts b/packages/outdated-browser/src/index.ts
@@ -62,6 +62,7 @@ const STORAGE_KEY = '__outdated'
 const ignore = sessionStorage.getItem(STORAGE_KEY) || 'false'
 
 declare global {
+  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
   interface Window {
     closeOutdated: () => void
   }
diff --git a/packages/use-dataloader/src/DataLoaderProvider.tsx b/packages/use-dataloader/src/DataLoaderProvider.tsx
@@ -1,19 +1,12 @@
 import PropTypes from 'prop-types'
-import {
-  ReactElement,
-  ReactNode,
-  createContext,
-  useCallback,
-  useContext,
-  useMemo,
-  useRef,
-} from 'react'
+import type { ReactElement, ReactNode } from 'react'
+import { createContext, useCallback, useContext, useMemo, useRef } from 'react'
 import {
   DEFAULT_MAX_CONCURRENT_REQUESTS,
   KEY_IS_NOT_STRING_ERROR,
 } from './constants'
 import DataLoader from './dataloader'
-import { OnErrorFn, PromiseType } from './types'
+import type { OnErrorFn, PromiseType } from './types'
 
 type CachedData = Record<string, unknown>
 type Reloads = Record<string, () => Promise<void | unknown>>
diff --git a/packages/use-dataloader/src/__tests__/DataLoaderProvider.test.tsx b/packages/use-dataloader/src/__tests__/DataLoaderProvider.test.tsx
@@ -1,5 +1,5 @@
 import { render, renderHook, screen, waitFor } from '@testing-library/react'
-import { ReactNode } from 'react'
+import type { ReactNode } from 'react'
 import DataLoaderProvider, { useDataLoaderContext } from '../DataLoaderProvider'
 import { KEY_IS_NOT_STRING_ERROR, StatusEnum } from '../constants'
 
diff --git a/packages/use-dataloader/src/__tests__/useDataLoader.test.tsx b/packages/use-dataloader/src/__tests__/useDataLoader.test.tsx
@@ -1,8 +1,8 @@
 /* eslint-disable no-console */
 import { renderHook, waitFor } from '@testing-library/react'
-import { ReactNode } from 'react'
+import type { ReactNode } from 'react'
 import DataLoaderProvider, { useDataLoaderContext } from '../DataLoaderProvider'
-import { KeyType, UseDataLoaderConfig } from '../types'
+import type { KeyType, UseDataLoaderConfig } from '../types'
 import useDataLoader from '../useDataLoader'
 
 type UseDataLoaderHookProps = {
diff --git a/packages/use-dataloader/src/__tests__/usePaginatedDataLoader.test.tsx b/packages/use-dataloader/src/__tests__/usePaginatedDataLoader.test.tsx
@@ -1,8 +1,8 @@
 /* eslint-disable no-console */
 import { act, renderHook, waitFor } from '@testing-library/react'
-import { ReactNode } from 'react'
+import type { ReactNode } from 'react'
 import DataLoaderProvider from '../DataLoaderProvider'
-import { UsePaginatedDataLoaderMethodParams } from '../types'
+import type { UsePaginatedDataLoaderMethodParams } from '../types'
 import usePaginatedDataLoader from '../usePaginatedDataLoader'
 
 const PROMISE_TIMEOUT = 5
diff --git a/packages/use-dataloader/src/dataloader.ts b/packages/use-dataloader/src/dataloader.ts
@@ -1,5 +1,5 @@
 import { DEFAULT_MAX_CONCURRENT_REQUESTS, StatusEnum } from './constants'
-import { PromiseType } from './types'
+import type { PromiseType } from './types'
 
 export type DataLoaderConstructorArgs<ResultType> = {
   key: string
diff --git a/packages/use-dataloader/src/types.ts b/packages/use-dataloader/src/types.ts
@@ -27,7 +27,7 @@ export type NeedPollingType<ResultType> =
  * @property {number} [dataLifetime=undefined]  Time before data from previous success is considered as outdated (in millisecond)
  * @property {NeedPollingType} [needPolling=true] When pollingInterval is set you can set a set a custom callback to know if polling is enabled
  */
-export interface UseDataLoaderConfig<ResultType, ErrorType> {
+export type UseDataLoaderConfig<ResultType, ErrorType> = {
   enabled?: boolean
   initialData?: ResultType
   keepPreviousData?: boolean
@@ -50,7 +50,7 @@ export interface UseDataLoaderConfig<ResultType, ErrorType> {
  * @property {string} error the error occured during the request
  * @property {Function} reload reload the data
  */
-export interface UseDataLoaderResult<ResultType, ErrorType> {
+export type UseDataLoaderResult<ResultType, ErrorType> = {
   data?: ResultType
   error?: ErrorType
   isError: boolean
diff --git a/packages/use-dataloader/src/useDataLoader.ts b/packages/use-dataloader/src/useDataLoader.ts
@@ -2,7 +2,7 @@ import { useCallback, useEffect, useMemo, useRef, useState } from 'react'
 import { useDataLoaderContext } from './DataLoaderProvider'
 import { StatusEnum } from './constants'
 import { marshalQueryKey } from './helpers'
-import {
+import type {
   KeyType,
   PromiseType,
   UseDataLoaderConfig,
diff --git a/packages/use-dataloader/src/usePaginatedDataLoader.ts b/packages/use-dataloader/src/usePaginatedDataLoader.ts
@@ -1,5 +1,5 @@
 import { useCallback, useEffect, useMemo, useState } from 'react'
-import {
+import type {
   KeyType,
   PromiseType,
   UsePaginatedDataLoaderConfig,
diff --git a/packages/use-gtm/src/__tests__/index.tsx b/packages/use-gtm/src/__tests__/index.tsx
@@ -1,8 +1,9 @@
 import { fireEvent, renderHook } from '@testing-library/react'
 import mockdate from 'mockdate'
-import { ReactNode } from 'react'
-import GTMProvider, { SendGTM, useGTM } from '..'
-import { GTMProviderProps } from '../useGTM'
+import type { ReactNode } from 'react'
+import type { SendGTM } from '..'
+import GTMProvider, { useGTM } from '..'
+import type { GTMProviderProps } from '../useGTM'
 
 const defaultEvents = {
   sampleEvent: (sendGTM?: SendGTM) => (extraValue: string) => {
diff --git a/packages/use-gtm/src/scripts.ts b/packages/use-gtm/src/scripts.ts
@@ -1,4 +1,4 @@
-import { GTMEnvironment } from './types'
+import type { GTMEnvironment } from './types'
 
 export const DATALAYER_NAME = 'dataLayer'
 export const LOAD_ERROR_EVENT = 'gtm_loading_error'
diff --git a/packages/use-gtm/src/useGTM.tsx b/packages/use-gtm/src/useGTM.tsx
@@ -1,13 +1,15 @@
-import { ReactNode, createContext, useContext, useEffect, useMemo } from 'react'
+import type { ReactNode } from 'react'
+import { createContext, useContext, useEffect, useMemo } from 'react'
 import generateScripts, { DATALAYER_NAME, LOAD_ERROR_EVENT } from './scripts'
-import { DataLayerEvent, Events, GTMEnvironment, SendGTM } from './types'
+import type { DataLayerEvent, Events, GTMEnvironment, SendGTM } from './types'
 
-interface GTMContextInterface<T extends Events = Events> {
+type GTMContextInterface<T extends Events = Events> = {
   sendGTM: SendGTM | undefined
   events: { [K in keyof T]: ReturnType<T[K]> }
 }
 
 declare global {
+  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
   interface Window {
     dataLayer: DataLayerEvent[] | undefined
   }
diff --git a/packages/use-i18n/src/__tests__/formatDate.ts b/packages/use-i18n/src/__tests__/formatDate.ts
@@ -1,4 +1,5 @@
-import formatDate, { FormatDateOptions, supportedFormats } from '../formatDate'
+import type { FormatDateOptions } from '../formatDate'
+import formatDate, { supportedFormats } from '../formatDate'
 
 const locales = ['en', 'fr', 'de', 'ro', 'es']
 
diff --git a/packages/use-i18n/src/__tests__/formatUnit.ts b/packages/use-i18n/src/__tests__/formatUnit.ts
@@ -1,4 +1,5 @@
-import formatUnit, { FormatUnitOptions, supportedUnits } from '../formatUnit'
+import type { FormatUnitOptions } from '../formatUnit'
+import formatUnit, { supportedUnits } from '../formatUnit'
 
 const locales = ['en', 'fr', 'ro']
 
diff --git a/packages/use-i18n/src/__tests__/usei18n.tsx b/packages/use-i18n/src/__tests__/usei18n.tsx
@@ -1,6 +1,6 @@
 import { act, renderHook, waitFor } from '@testing-library/react'
 import mockdate from 'mockdate'
-import { ReactNode } from 'react'
+import type { ReactNode } from 'react'
 import I18n, { useI18n, useTranslation } from '..'
 import en from './locales/en.json'
 import es from './locales/es.json'
diff --git a/packages/use-i18n/src/formatUnit.ts b/packages/use-i18n/src/formatUnit.ts
@@ -243,7 +243,7 @@ export const supportedUnits: Partial<
   ),
 }
 
-export interface FormatUnitOptions {
+export type FormatUnitOptions = {
   unit: SupportedUnits
   short?: boolean
 }
diff --git a/packages/use-i18n/src/formatters.ts b/packages/use-i18n/src/formatters.ts
@@ -1,5 +1,6 @@
 import type { NumberFormatOptions } from '@formatjs/ecma402-abstract'
-import memoize, { Cache, strategies } from '@formatjs/fast-memoize'
+import type { Cache } from '@formatjs/fast-memoize'
+import memoize, { strategies } from '@formatjs/fast-memoize'
 import IntlTranslationFormat from 'intl-messageformat'
 
 // Deeply inspired by https://github.com/formatjs/formatjs/blob/7406e526a9c5666cee22cc2316dad1fa1d88697c/packages/intl-messageformat/src/core.ts
@@ -8,7 +9,7 @@ import IntlTranslationFormat from 'intl-messageformat'
 // Intl.ListFormat in at TC39 stage 4 and is widely adopted in browsers
 // So we expose homegrown types
 // https://github.com/tc39/proposal-intl-list-format
-export interface IntlListFormatOptions {
+export type IntlListFormatOptions = {
   localeMatcher?: 'best fit' | 'lookup'
   type?: 'conjunction' | 'disjunction' | 'unit'
   style?: 'long' | 'short' | 'narrow'
@@ -20,7 +21,7 @@ declare abstract class IntlListFormat {
   format: (items: string[]) => string
 }
 
-interface BaseFormatters {
+type BaseFormatters = {
   getNumberFormat(
     locales?: string | string[],
     opts?: NumberFormatOptions,
diff --git a/packages/use-i18n/src/usei18n.tsx b/packages/use-i18n/src/usei18n.tsx
@@ -1,14 +1,10 @@
 import type { NumberFormatOptions } from '@formatjs/ecma402-abstract'
-import {
-  Locale as DateFnsLocale,
-  formatDistanceToNow,
-  formatDistanceToNowStrict,
-} from 'date-fns'
+import type { Locale as DateFnsLocale } from 'date-fns'
+import { formatDistanceToNow, formatDistanceToNowStrict } from 'date-fns'
 import type { BaseLocale } from 'international-types'
 import PropTypes from 'prop-types'
+import type { ReactElement, ReactNode } from 'react'
 import {
-  ReactElement,
-  ReactNode,
   createContext,
   useCallback,
   useContext,
@@ -17,9 +13,12 @@ import {
   useState,
 } from 'react'
 import ReactDOM from 'react-dom'
-import dateFormat, { FormatDateOptions } from './formatDate'
-import unitFormat, { FormatUnitOptions } from './formatUnit'
-import formatters, { IntlListFormatOptions } from './formatters'
+import type { FormatDateOptions } from './formatDate'
+import dateFormat from './formatDate'
+import type { FormatUnitOptions } from './formatUnit'
+import unitFormat from './formatUnit'
+import type { IntlListFormatOptions } from './formatters'
+import formatters from './formatters'
 import type { ReactParamsObject, ScopedTranslateFn, TranslateFn } from './types'
 
 const LOCALE_ITEM_STORAGE = 'locale'
@@ -62,7 +61,7 @@ const getCurrentLocale = ({
   )
 }
 
-interface Context<Locale extends BaseLocale> {
+type Context<Locale extends BaseLocale> = {
   currentLocale: string
   dateFnsLocale?: DateFnsLocale
   datetime: (
diff --git a/packages/use-media/src/types.ts b/packages/use-media/src/types.ts
@@ -1,3 +1,3 @@
-import { DependencyList, EffectCallback } from 'react'
+import type { DependencyList, EffectCallback } from 'react'
 
 export type Effect = (effect: EffectCallback, deps?: DependencyList) => void
diff --git a/packages/use-media/src/useMedia.ts b/packages/use-media/src/useMedia.ts
@@ -1,5 +1,5 @@
 import { useEffect, useLayoutEffect, useState } from 'react'
-import { Effect } from './types'
+import type { Effect } from './types'
 
 function noop() {}
 
diff --git a/packages/use-query-params/src/__tests__/index.tsx b/packages/use-query-params/src/__tests__/index.tsx
@@ -1,6 +1,8 @@
 import { act, renderHook } from '@testing-library/react'
-import { History, createMemoryHistory } from 'history'
-import { ReactNode, useLayoutEffect, useState } from 'react'
+import type { History } from 'history'
+import { createMemoryHistory } from 'history'
+import type { ReactNode } from 'react'
+import { useLayoutEffect, useState } from 'react'
 import { MemoryRouter, Router } from 'react-router-dom'
 import useQueryParams from '..'
 
diff --git a/packages/use-query-params/src/index.ts b/packages/use-query-params/src/index.ts
@@ -2,7 +2,7 @@ import { parse, stringify } from 'query-string'
 import { useCallback, useMemo } from 'react'
 import { useLocation, useNavigate } from 'react-router-dom'
 
-interface Options {
+type Options = {
   /** Set to true to push a new entry onto the history stack */
   push: boolean
 }
diff --git a/packages/use-segment/src/__tests__/index.tsx b/packages/use-segment/src/__tests__/index.tsx
@@ -1,6 +1,7 @@
-import { AnalyticsBrowser, Context } from '@segment/analytics-next'
+import type { Context } from '@segment/analytics-next'
+import { AnalyticsBrowser } from '@segment/analytics-next'
 import { renderHook, waitFor } from '@testing-library/react'
-import { ReactNode } from 'react'
+import type { ReactNode } from 'react'
 import waitForExpect from 'wait-for-expect'
 import SegmentProvider, { useSegment } from '..'
 import type { Analytics, OnEventError, SegmentProviderProps } from '..'
diff --git a/packages/use-segment/src/useSegment.tsx b/packages/use-segment/src/useSegment.tsx
@@ -4,14 +4,8 @@ import type {
   AnalyticsBrowserSettings,
   InitOptions,
 } from '@segment/analytics-next'
-import {
-  ReactNode,
-  createContext,
-  useContext,
-  useEffect,
-  useMemo,
-  useState,
-} from 'react'
+import type { ReactNode } from 'react'
+import { createContext, useContext, useEffect, useMemo, useState } from 'react'
 
 export type OnEventError = (error: Error) => Promise<void> | void
 type EventFunction = (...args: never[]) => Promise<void>
@@ -20,7 +14,7 @@ type Events = Record<
   (analytics?: Analytics, onEventError?: OnEventError) => EventFunction
 >
 
-interface SegmentContextInterface<T extends Events = Events> {
+type SegmentContextInterface<T extends Events = Events> = {
   analytics: Analytics | undefined
   events: { [K in keyof T]: ReturnType<T[K]> }
 }
diff --git a/packages/validate-icu-locales/src/index.ts b/packages/validate-icu-locales/src/index.ts
@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 import { parse } from '@formatjs/icu-messageformat-parser'
-import { ParserError } from '@formatjs/icu-messageformat-parser/error'
+import type { ParserError } from '@formatjs/icu-messageformat-parser/error'
 import { readFile } from 'fs/promises'
 import { globby } from 'globby'
 import { importFromString } from 'module-from-string'
diff --git a/packages_deprecated/countries/index.d.ts b/packages_deprecated/countries/index.d.ts

Original file line number	Diff line number	Diff line change
`@@ -62,6 +62,7 @@ const STORAGE_KEY = '__outdated'`
`62`	`62`	`const ignore = sessionStorage.getItem(STORAGE_KEY) \|\| 'false'`
`63`	`63`
`64`	`64`	`declare global {`
	`65`	`+ // eslint-disable-next-line @typescript-eslint/consistent-type-definitions`
`65`	`66`	`interface Window {`
`66`	`67`	`closeOutdated: () => void`
`67`	`68`	`}`