remove I interface prefix and update eslint rule

Author: Thomas Dashney

.eslintrc.json

@@ -39,7 +39,7 @@
   "rules": {
     "prettier/prettier": 1,
     "@typescript-eslint/explicit-function-return-type": 0,
-    "@typescript-eslint/interface-name-prefix": [1, {"prefixWithI": "always"}],
+    "@typescript-eslint/interface-name-prefix": [1, {"prefixWithI": "never"}],
     "@typescript-eslint/no-empty-interface": 0,
     "@typescript-eslint/no-explicit-any": 0,
     "@typescript-eslint/no-unused-vars": 0,

src/api/index.tsx

@@ -7,8 +7,8 @@ import {createSubscription, genCacheUpdateEvent, getParamsId} from './lib'
 import {ApiRequestManager} from './request-manager'
 import {
   ApiRequestMethod,
+  ApiRequestOptions,
   IApiParseResponseJson,
-  IApiRequestOptions,
   IApiRequestParams,
   IApiSerializeRequestJson,
   ResponseBody
@@ -55,7 +55,7 @@ export class Api {
    */
   request = <TResponseBody extends ResponseBody>(
     params: IApiRequestParams<ApiRequestMethod, TResponseBody>,
-    options: IApiRequestOptions = {}
+    options: ApiRequestOptions = {}
   ): Promise<TResponseBody> => {
     const {fetchPolicy = DEFAULT_FETCH_POLICY} = options
 

src/api/request-fetcher/index.tsx

@@ -1,8 +1,8 @@
 import {ApiError} from '../errors'
 import {
   ApiResponseType,
-  IRequestFetcher,
-  IRequestFetcherParams,
+  RequestFetcher,
+  RequestFetcherParams,
   ResponseBody
 } from '../typings'
 
@@ -13,9 +13,9 @@ import {
  * - Throwing ApiErrors for non-200 level errors
  * - Parsing response bodies
  */
-export class ApiRequestFetcher implements IRequestFetcher {
+export class ApiRequestFetcher implements RequestFetcher {
   getResponse = async (
-    params: IRequestFetcherParams
+    params: RequestFetcherParams
   ): Promise<{
     responseBody: ResponseBody | null
     responseType: ApiResponseType | null
@@ -37,7 +37,7 @@ export class ApiRequestFetcher implements IRequestFetcher {
   /**
    * Generates a `Request` instance to be passed directly to `fetch`
    */
-  private createRequest(params: IRequestFetcherParams): Request {
+  private createRequest(params: RequestFetcherParams): Request {
     return new Request(params.url, {
       method: params.method,
       body: params.body,
@@ -50,7 +50,7 @@ export class ApiRequestFetcher implements IRequestFetcher {
    */
   private async parseResponseBody(
     response: Response,
-    params: IRequestFetcherParams
+    params: RequestFetcherParams
   ): Promise<{
     responseBody: ResponseBody | null
     responseType: ApiResponseType | null

src/api/request-manager/index.tsx

@@ -7,12 +7,12 @@ import {applyHeaders, createSubscription, getParamsId} from '../lib'
 import {ApiRequestFetcher} from '../request-fetcher'
 import {
   ApiRequestMethod,
+  ApiRequestOptions,
   IApiParseResponseJson,
-  IApiRequestOptions,
   IApiRequestParams,
   IApiSerializeRequestJson,
-  IRequestFetcher,
   RequestBody,
+  RequestFetcher,
   ResponseBody
 } from '../typings'
 
@@ -38,7 +38,7 @@ export class ApiRequestManager {
 
   private emitter = new EventEmitter()
 
-  private requestFetcher: IRequestFetcher
+  private requestFetcher: RequestFetcher
 
   private serializeRequestJson: IApiSerializeRequestJson
 
@@ -66,7 +66,7 @@ export class ApiRequestManager {
      * through this transformation function before returning the response
      */
     parseResponseJson?: IApiParseResponseJson
-    requestFetcher?: IRequestFetcher
+    requestFetcher?: RequestFetcher
   }) {
     this.baseUrl = params.baseUrl || ''
     this.requestFetcher = params.requestFetcher || new ApiRequestFetcher()
@@ -84,7 +84,7 @@ export class ApiRequestManager {
    */
   getResponseBody = <TResponseBody extends ResponseBody>(
     params: IApiRequestParams<ApiRequestMethod, TResponseBody>,
-    options: IApiRequestOptions
+    options: ApiRequestOptions
   ): Promise<TResponseBody | null> => {
     if (params.method !== 'GET') {
       // only cache in-progress requests for GET requests
@@ -111,7 +111,7 @@ export class ApiRequestManager {
 
   private async createGetPromise(
     params: IApiRequestParams,
-    options: IApiRequestOptions,
+    options: ApiRequestOptions,
     id: symbol
   ): Promise<ResponseBody | null> {
     const paramsId = getParamsId(params)
@@ -167,7 +167,7 @@ export class ApiRequestManager {
 
   private fetchResponseBody = async (
     params: IApiRequestParams,
-    options: IApiRequestOptions
+    options: ApiRequestOptions
   ): Promise<ResponseBody | null> => {
     const {fetchPolicy = DEFAULT_FETCH_POLICY} = options
     try {

src/api/typings.tsx

@@ -9,32 +9,32 @@ export type RequestBody = BodyInit | object
 export type ResponseBody = Blob | object | string
 export type ApiResponseType = 'json' | 'text' | 'blob'
 
-interface IApiCommonRequestParams<TMethod extends ApiRequestMethod> {
+interface ApiCommonRequestParams<TMethod extends ApiRequestMethod> {
   url: string
   method: TMethod
   headers?: ApiHeaders
   responseType?: ApiResponseType
 }
 
-export interface IApiGetDeleteRequestParams<
+export interface ApiGetDeleteRequestParams<
   TMethod extends GetDeleteRequestMethod,
   TResponseBody extends ResponseBody = never
-> extends IApiCommonRequestParams<TMethod> {}
+> extends ApiCommonRequestParams<TMethod> {}
 
-export interface IApiMutationRequestParams<
+export interface ApiMutationRequestParams<
   TMethod extends PostPutPatchRequestMethod,
   TResponseBody extends ResponseBody = never
-> extends IApiCommonRequestParams<TMethod> {
+> extends ApiCommonRequestParams<TMethod> {
   body?: RequestBody
 }
 
 export type IApiRequestParams<
   TMethod extends ApiRequestMethod = ApiRequestMethod,
   TResponseBody extends ResponseBody = ResponseBody
 > = TMethod extends GetDeleteRequestMethod
-  ? IApiGetDeleteRequestParams<TMethod, TResponseBody>
+  ? ApiGetDeleteRequestParams<TMethod, TResponseBody>
   : TMethod extends PostPutPatchRequestMethod
-  ? IApiMutationRequestParams<TMethod, TResponseBody>
+  ? ApiMutationRequestParams<TMethod, TResponseBody>
   : never
 
 export type IApiSerializeRequestJson = (body: object) => object
@@ -69,7 +69,7 @@ export type ApiRequestFetchPolicy =
    */
   | 'cache-and-fetch'
 
-export interface IApiRequestOptions {
+export interface ApiRequestOptions {
   /**
    * Specifies how the request interacts with the cache
    */
@@ -85,17 +85,17 @@ export interface IApiRequestOptions {
   forceNewFetch?: boolean
 }
 
-export interface IRequestFetcherParams {
+export interface RequestFetcherParams {
   url: string
   method: ApiRequestMethod
   body?: BodyInit
   headers?: Headers
   responseType?: ApiResponseType
 }
 
-export interface IRequestFetcher {
+export interface RequestFetcher {
   getResponse(
-    params: IRequestFetcherParams
+    params: RequestFetcherParams
   ): Promise<{
     responseBody: ResponseBody | null
     responseType: ApiResponseType | null

src/endpoints/index.spec.tsx

@@ -1,31 +1,31 @@
 import {
   ApiParam,
+  EndpointCreateRequestInit,
   HttpEndpoints,
-  IEndpointCreateRequestInit,
   RestEndpoints
 } from './'
 
 describe('HttpEndpoints', () => {
   class Endpoints extends HttpEndpoints {
     static basePath = '/base'
 
-    static GET(init: Omit<IEndpointCreateRequestInit, 'body'>) {
+    static GET(init: Omit<EndpointCreateRequestInit, 'body'>) {
       return super._get('/endpoint', init)
     }
 
-    static POST(init: IEndpointCreateRequestInit = {}) {
+    static POST(init: EndpointCreateRequestInit = {}) {
       return super._post('/endpoint', init)
     }
 
-    static PUT(init: IEndpointCreateRequestInit = {}) {
+    static PUT(init: EndpointCreateRequestInit = {}) {
       return super._put('/endpoint', init)
     }
 
-    static PATCH(init: IEndpointCreateRequestInit = {}) {
+    static PATCH(init: EndpointCreateRequestInit = {}) {
       return super._patch('/endpoint', init)
     }
 
-    static DELETE(init: IEndpointCreateRequestInit = {}) {
+    static DELETE(init: EndpointCreateRequestInit = {}) {
       return super._delete('/endpoint', init)
     }
   }
@@ -98,7 +98,7 @@ describe('HttpEndpoints', () => {
 })
 
 describe('RestEndpoints', () => {
-  interface IModel {
+  interface Model {
     name: string
   }
 
@@ -109,19 +109,19 @@ describe('RestEndpoints', () => {
       return super._list(query)
     }
 
-    static create(body: IModel) {
+    static create(body: Model) {
       return super._create(body)
     }
 
     static findById(id: ApiParam) {
       return super._findById(id)
     }
 
-    static update(id: ApiParam, body: Partial<IModel>) {
+    static update(id: ApiParam, body: Partial<Model>) {
       return super._update(id, body)
     }
 
-    static partialUpdate(id: ApiParam, body: Partial<IModel>) {
+    static partialUpdate(id: ApiParam, body: Partial<Model>) {
       return super._partialUpdate(id, body)
     }
 

src/endpoints/index.tsx

@@ -10,7 +10,7 @@ import {
 
 export type ApiQueryParams = Record<string, string | number | boolean>
 
-export interface IEndpointCreateRequestInit {
+export interface EndpointCreateRequestInit {
   query?: ApiQueryParams
   headers?: ApiHeaders
   body?: RequestBody
@@ -55,7 +55,7 @@ export class HttpEndpoints {
    */
   protected static _get<TResponseBody extends ResponseBody = ResponseBody>(
     path: string,
-    requestInit?: Omit<IEndpointCreateRequestInit, 'body'>
+    requestInit?: Omit<EndpointCreateRequestInit, 'body'>
   ) {
     return this._createRequest<'GET', TResponseBody>('GET', path, requestInit)
   }
@@ -68,7 +68,7 @@ export class HttpEndpoints {
    */
   protected static _post<TResponseBody extends ResponseBody = ResponseBody>(
     path: string,
-    requestInit?: IEndpointCreateRequestInit
+    requestInit?: EndpointCreateRequestInit
   ) {
     return this._createRequest<'POST', TResponseBody>('POST', path, requestInit)
   }
@@ -81,7 +81,7 @@ export class HttpEndpoints {
    */
   protected static _put<TResponseBody extends ResponseBody = ResponseBody>(
     path: string,
-    requestInit?: IEndpointCreateRequestInit
+    requestInit?: EndpointCreateRequestInit
   ) {
     return this._createRequest<'PUT', TResponseBody>('PUT', path, requestInit)
   }
@@ -94,7 +94,7 @@ export class HttpEndpoints {
    */
   protected static _patch<TResponseBody extends ResponseBody = ResponseBody>(
     path: string,
-    requestInit?: IEndpointCreateRequestInit
+    requestInit?: EndpointCreateRequestInit
   ) {
     return this._createRequest<'PATCH', TResponseBody>(
       'PATCH',
@@ -111,7 +111,7 @@ export class HttpEndpoints {
    */
   protected static _delete<TResponseBody extends ResponseBody = ResponseBody>(
     path: string,
-    requestInit?: IEndpointCreateRequestInit
+    requestInit?: EndpointCreateRequestInit
   ) {
     return this._createRequest<'DELETE', TResponseBody>(
       'DELETE',
@@ -152,7 +152,7 @@ export class HttpEndpoints {
   >(
     method: TMethod,
     path: string,
-    requestInit: IEndpointCreateRequestInit = {}
+    requestInit: EndpointCreateRequestInit = {}
   ): IApiRequestParams<TMethod, TResponseBody> {
     let url = this.buildPath(path)
 

src/index.tsx

@@ -6,7 +6,7 @@ export * from './react/context'
 export {
   ApiParam,
   ApiQueryParams,
-  IEndpointCreateRequestInit,
+  EndpointCreateRequestInit as IEndpointCreateRequestInit,
   HttpEndpoints,
   RestEndpoints,
   dynamicPath

src/react/context.tsx

@@ -4,11 +4,11 @@ import {Api} from '../api'
 
 export const ApiContext = createContext<Api>(new Api())
 
-export interface IApiProviderProps {
+export interface ApiProviderProps {
   api: Api
 }
 
-export const ApiProvider: React.FC<IApiProviderProps> = function ApiProvider(
+export const ApiProvider: React.FC<ApiProviderProps> = function ApiProvider(
   props
 ) {
   return (

src/react/index.tsx

@@ -1,3 +1,3 @@
 export * from './use-api'
 export * from './use-api-query/index'
-export {withApi, IWithApiProps} from './with-api'
+export {withApi, WithApiProps as IWithApiProps} from './with-api'

src/react/use-api-query/index.tsx

@@ -12,13 +12,13 @@ import {useApi} from '../use-api'
 import {useApiQueryActions} from './actions'
 import {useApiQueryReducer} from './reducer'
 
-interface IUseApiQueryData<TResponseBody extends ResponseBody> {
+interface UseApiQueryData<TResponseBody extends ResponseBody> {
   data: TResponseBody | undefined | null
   loading: boolean
   error: Error | null
 }
 
-export interface IUseApiQueryActions<TResponseBody extends ResponseBody> {
+export interface UseApiQueryActions<TResponseBody extends ResponseBody> {
   /**
    * Sets the response data of the Api request manually.
    *
@@ -76,7 +76,7 @@ export function useApiQuery<TResponseBody extends ResponseBody>(
      */
     dontReinitialize?: boolean
   } = {}
-): [IUseApiQueryData<TResponseBody>, IUseApiQueryActions<TResponseBody>] {
+): [UseApiQueryData<TResponseBody>, UseApiQueryActions<TResponseBody>] {
   const api = useApi()
   const fetchPolicy = opts.fetchPolicy || api.defaultFetchPolicy
   const paramsId = params && getParamsId(params)