Merge pull request #17 from THEOplayer/update-eslint

Update to ESLint flat config
THEOplayer · Apr 5, 2024 · 8075e7f · 8075e7f
2 parents 34e43ab + d31b742
commit 8075e7f
Show file tree

Hide file tree

Showing 31 changed files with 1,170 additions and 1,998 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
diff --git a/cmcd/src/CMCDCollector.ts b/cmcd/src/CMCDCollector.ts
@@ -1,4 +1,4 @@
-import { ChromelessPlayer, CurrentSourceChangeEvent, MediaTrack, MediaType, Quality, Request } from 'theoplayer';
+import type { ChromelessPlayer, CurrentSourceChangeEvent, MediaTrack, MediaType, Quality, Request } from 'theoplayer';
 import { CMCDObjectType, CMCDPayload, CMCDReservedKey, CMCDStreamingFormat, CMCDStreamType } from './CMCDPayload';
 import { Configuration } from './Configuration';
 import { calculateBufferSize, getStreamingFormatFromTypedSource } from './PlayerUtils';
@@ -162,7 +162,7 @@ export class CMCDCollector {
                     [CMCDReservedKey.OBJECT_TYPE]: CMCDObjectType.KEY_LICENSE_OR_CERTIFICATE
                 };
             }
-            case 'segment':
+            case 'segment': {
                 if (request.subType === 'initialization-segment') {
                     return {
                         ...sessionKeys,
@@ -235,6 +235,7 @@ export class CMCDCollector {
                 // TODO object duration
                 // TODO next request... and next range
                 return payload;
+            }
             default:
                 return {};
         }

diff --git a/cmcd/src/CMCDConnector.ts b/cmcd/src/CMCDConnector.ts
@@ -1,4 +1,4 @@
-import { ChromelessPlayer, InterceptableRequest, Request } from 'theoplayer';
+import type { ChromelessPlayer, InterceptableRequest, Request } from 'theoplayer';
 import { CMCDCollector } from './CMCDCollector';
 import { CMCDPayload } from './CMCDPayload';
 import { Configuration, TransmissionMode } from './Configuration';

diff --git a/cmcd/src/PlayerUtils.ts b/cmcd/src/PlayerUtils.ts
@@ -1,4 +1,4 @@
-import { TypedSource } from 'theoplayer';
+import type { TypedSource } from 'theoplayer';
 import { CMCDStreamingFormat } from './CMCDPayload';
 
 function isM3U8SourceString(source: string): boolean {

diff --git a/cmcd/src/TransmissionModeStrategies/HTTPHeaderTransmissionModeStrategy.ts b/cmcd/src/TransmissionModeStrategies/HTTPHeaderTransmissionModeStrategy.ts
@@ -1,4 +1,4 @@
-import { InterceptableRequest } from 'theoplayer';
+import type { InterceptableRequest } from 'theoplayer';
 import { CMCDHeaderName, CMCDPayload } from '../CMCDPayload';
 import { extractKeysFor, transformToQueryParameters } from '../CMCDPayloadUtils';
 import { TransmissionModeStrategy } from './TransmissionModeStrategy';

diff --git a/cmcd/src/TransmissionModeStrategies/JSONObjectTransmissionModeStrategy.ts b/cmcd/src/TransmissionModeStrategies/JSONObjectTransmissionModeStrategy.ts
@@ -1,4 +1,4 @@
-import { InterceptableRequest } from 'theoplayer';
+import type { InterceptableRequest } from 'theoplayer';
 import { CMCDPayload } from '../CMCDPayload';
 import { TransmissionModeStrategy } from './TransmissionModeStrategy';
 

diff --git a/cmcd/src/TransmissionModeStrategies/QueryArgumentTransmissionModeStrategy.ts b/cmcd/src/TransmissionModeStrategies/QueryArgumentTransmissionModeStrategy.ts
@@ -1,4 +1,4 @@
-import { InterceptableRequest } from 'theoplayer';
+import type { InterceptableRequest } from 'theoplayer';
 import { CMCDPayload } from '../CMCDPayload';
 import { transformToQueryParameters } from '../CMCDPayloadUtils';
 import { TransmissionModeStrategy } from './TransmissionModeStrategy';

diff --git a/cmcd/src/TransmissionModeStrategies/TransmissionModeStrategy.ts b/cmcd/src/TransmissionModeStrategies/TransmissionModeStrategy.ts
@@ -1,4 +1,4 @@
-import { InterceptableRequest } from 'theoplayer';
+import type { InterceptableRequest } from 'theoplayer';
 import { CMCDPayload } from '../CMCDPayload';
 import { Configuration, TransmissionMode } from '../Configuration';
 import { HTTPHeaderTransmissionModeStrategy } from './HTTPHeaderTransmissionModeStrategy';

diff --git a/conviva/src/integration/ConvivaConnector.ts b/conviva/src/integration/ConvivaConnector.ts
@@ -1,6 +1,6 @@
-import { ChromelessPlayer } from 'theoplayer';
-import { ConvivaMetadata } from '@convivainc/conviva-js-coresdk';
-import { YospaceConnector } from '@theoplayer/yospace-connector-web';
+import type { ChromelessPlayer } from 'theoplayer';
+import type { ConvivaMetadata } from '@convivainc/conviva-js-coresdk';
+import type { YospaceConnector } from '@theoplayer/yospace-connector-web';
 import { ConvivaConfiguration, ConvivaHandler } from './ConvivaHandler';
 
 export class ConvivaConnector {

diff --git a/conviva/src/integration/ConvivaHandler.ts b/conviva/src/integration/ConvivaHandler.ts
@@ -1,6 +1,12 @@
-import { ChromelessPlayer, SourceDescription, VideoQuality } from 'theoplayer';
-import { AdAnalytics, Analytics, Constants, ConvivaMetadata, VideoAnalytics } from '@convivainc/conviva-js-coresdk';
-import { YospaceConnector } from '@theoplayer/yospace-connector-web';
+import type { ChromelessPlayer, SourceDescription, VideoQuality } from 'theoplayer';
+import {
+    type AdAnalytics,
+    Analytics,
+    Constants,
+    type ConvivaMetadata,
+    type VideoAnalytics
+} from '@convivainc/conviva-js-coresdk';
+import type { YospaceConnector } from '@theoplayer/yospace-connector-web';
 import { CONVIVA_CALLBACK_FUNCTIONS } from './ConvivaCallbackFunctions';
 import {
     calculateBufferLength,

diff --git a/conviva/src/integration/ads/AdReporter.ts b/conviva/src/integration/ads/AdReporter.ts
@@ -1,5 +1,5 @@
-import { Ad, AdBreak, ChromelessPlayer, GoogleImaAd } from 'theoplayer';
-import { AdAnalytics, Constants, ConvivaMetadata, VideoAnalytics } from '@convivainc/conviva-js-coresdk';
+import type { Ad, AdBreak, ChromelessPlayer, GoogleImaAd } from 'theoplayer';
+import { type AdAnalytics, Constants, type ConvivaMetadata, type VideoAnalytics } from '@convivainc/conviva-js-coresdk';
 import { calculateAdType, calculateCurrentAdBreakInfo, collectAdMetadata, collectPlayerInfo } from '../../utils/Utils';
 
 export class AdReporter {
@@ -52,7 +52,7 @@ export class AdReporter {
         // there are two tags that are critical:
         // - `c3.csid`: the content’s sessionID;
         // - `contentAssetName`: the content's assetName.
-        // @ts-ignore: getSessionId() is not present in type declarations.
+        // @ts-expect-error: getSessionId() is not present in type declarations.
         adMetadata['c3.csid'] = `${this.convivaVideoAnalytics.getSessionId()}`;
         adMetadata.contentAssetName =
             this.contentInfo()[Constants.ASSET_NAME] ?? this.player.source?.metadata?.title ?? 'NA';

diff --git a/conviva/src/integration/ads/VerizonAdReporter.ts b/conviva/src/integration/ads/VerizonAdReporter.ts
@@ -1,4 +1,4 @@
-import {
+import type {
     ChromelessPlayer,
     VerizonMediaAdBeginEvent,
     VerizonMediaAdBreak,
@@ -7,7 +7,7 @@ import {
     VerizonMediaRemoveAdBreakEvent,
     VideoQuality
 } from 'theoplayer';
-import { AdAnalytics, Constants, VideoAnalytics } from '@convivainc/conviva-js-coresdk';
+import { type AdAnalytics, Constants, type VideoAnalytics } from '@convivainc/conviva-js-coresdk';
 import { calculateVerizonAdBreakInfo, collectPlayerInfo, collectVerizonAdMetadata } from '../../utils/Utils';
 
 export class VerizonAdReporter {

diff --git a/conviva/src/integration/ads/YospaceAdReporter.ts b/conviva/src/integration/ads/YospaceAdReporter.ts
@@ -1,11 +1,11 @@
-import { ChromelessPlayer, VideoQuality } from 'theoplayer';
-import { AdAnalytics, Constants, VideoAnalytics } from '@convivainc/conviva-js-coresdk';
+import type { ChromelessPlayer, VideoQuality } from 'theoplayer';
+import { type AdAnalytics, Constants, type VideoAnalytics } from '@convivainc/conviva-js-coresdk';
 import {
-    AdBreak,
-    AdVert,
-    AnalyticEventObserver,
+    type AdBreak,
+    type AdVert,
+    type AnalyticEventObserver,
     SessionErrorCode,
-    YospaceConnector
+    type YospaceConnector
 } from '@theoplayer/yospace-connector-web';
 import { collectPlayerInfo, collectYospaceAdMetadata } from '../../utils/Utils';
 

diff --git a/conviva/src/integration/extension/ConvivaAdEventsExtension.d.ts b/conviva/src/integration/extension/ConvivaAdEventsExtension.d.ts
@@ -1,4 +1,4 @@
-import { AdsEventMap, EventDispatcher } from 'theoplayer';
+import type { AdsEventMap, EventDispatcher } from 'theoplayer';
 
 declare module 'theoplayer' {
     interface Ads extends EventDispatcher<AdsEventMap> {

diff --git a/conviva/src/utils/Utils.ts b/conviva/src/utils/Utils.ts
@@ -1,13 +1,21 @@
 import {
     Constants,
-    ConvivaAdBreakInfo,
-    ConvivaDeviceMetadata,
-    ConvivaMetadata,
-    ConvivaOptions,
-    ConvivaPlayerInfo
+    type ConvivaAdBreakInfo,
+    type ConvivaDeviceMetadata,
+    type ConvivaMetadata,
+    type ConvivaOptions,
+    type ConvivaPlayerInfo
 } from '@convivainc/conviva-js-coresdk';
-import { AdVert } from '@theoplayer/yospace-connector-web';
-import { Ad, AdBreak, ChromelessPlayer, GoogleImaAd, VerizonMediaAd, VerizonMediaAdBreak, version } from 'theoplayer';
+import type { AdVert } from '@theoplayer/yospace-connector-web';
+import {
+    type Ad,
+    type AdBreak,
+    type ChromelessPlayer,
+    type GoogleImaAd,
+    type VerizonMediaAd,
+    type VerizonMediaAdBreak,
+    version
+} from 'theoplayer';
 import { ConvivaConfiguration } from '../integration/ConvivaHandler';
 
 export function collectDeviceMetadata(): ConvivaDeviceMetadata {
@@ -17,8 +25,6 @@ export function collectDeviceMetadata(): ConvivaDeviceMetadata {
     };
 }
 
-type AdBreakPosition = 'preroll' | 'midroll' | 'postroll';
-
 export function calculateAdType(player: ChromelessPlayer) {
     return player.source?.ads?.length ? Constants.AdType.CLIENT_SIDE : Constants.AdType.SERVER_SIDE;
 }
@@ -77,7 +83,6 @@ export function collectContentMetadata(
     if (!Number.isNaN(duration) && duration !== Infinity) {
         contentInfo[Constants.DURATION] = duration;
     }
-    // @ts-ignore
     return {
         ...configuredContentMetadata,
         ...contentInfo

diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -0,0 +1,22 @@
+// @ts-check
+
+import eslint from '@eslint/js';
+import eslintConfigPrettier from 'eslint-config-prettier';
+import typescriptEslint from 'typescript-eslint';
+
+export default typescriptEslint.config(
+    eslint.configs.recommended,
+    ...typescriptEslint.configs.recommended,
+    eslintConfigPrettier,
+    {
+        rules: {
+            '@typescript-eslint/no-unused-vars': [
+                'warn',
+                {
+                    argsIgnorePattern: '^_'
+                }
+            ],
+            '@typescript-eslint/no-explicit-any': 'off'
+        }
+    }
+);
diff --git a/nielsen/src/integration/NielsenConnector.ts b/nielsen/src/integration/NielsenConnector.ts
@@ -1,4 +1,4 @@
-import { ChromelessPlayer } from 'theoplayer';
+import type { ChromelessPlayer } from 'theoplayer';
 import { NielsenOptions } from '../nielsen/Types';
 import { NielsenHandler } from './NielsenHandler';
 

diff --git a/nielsen/src/integration/NielsenHandler.ts b/nielsen/src/integration/NielsenHandler.ts
@@ -1,10 +1,17 @@
-import { Ad, AddTrackEvent, ChromelessPlayer, TextTrack, TextTrackEnterCueEvent, VolumeChangeEvent } from 'theoplayer';
+import type {
+    Ad,
+    AddTrackEvent,
+    ChromelessPlayer,
+    TextTrack,
+    TextTrackEnterCueEvent,
+    VolumeChangeEvent
+} from 'theoplayer';
 import { loadNielsenLibrary } from '../nielsen/NOLBUNDLE';
 import { AdMetadata, ContentMetadata, NielsenOptions } from '../nielsen/Types';
 import { getAdType } from '../utils/Util';
 
-const EMSG_PRIV_SUFFIX = "PRIV{";
-const EMSG_PAYLOAD_SUFFIX = "payload=";
+const EMSG_PRIV_SUFFIX = 'PRIV{';
+const EMSG_PAYLOAD_SUFFIX = 'payload=';
 
 export class NielsenHandler {
     private player: ChromelessPlayer;
@@ -121,7 +128,7 @@ export class NielsenHandler {
         if (content.id === 'PRIV' && content.ownerIdentifier.indexOf('www.nielsen.com') !== -1) {
             this.nSdkInstance.ggPM('sendID3', content.ownerIdentifier);
         }
-    }
+    };
 
     private handleNielsenEmsgPayload = (content: any) => {
         const cueContentText = this.decoder.decode(content);
@@ -143,16 +150,19 @@ export class NielsenHandler {
                     // - drop everything before ID3 PRIV{
                     let sanitizedPayload = payload.replace(/[^ -~]|\D+$/g, '');
                     const privIndex = sanitizedPayload.indexOf(EMSG_PRIV_SUFFIX);
-                    sanitizedPayload = privIndex !== -1 ? sanitizedPayload.substring(privIndex + EMSG_PRIV_SUFFIX.length) : sanitizedPayload;
+                    sanitizedPayload =
+                        privIndex !== -1
+                            ? sanitizedPayload.substring(privIndex + EMSG_PRIV_SUFFIX.length)
+                            : sanitizedPayload;
 
                     // send payload. Note that there is no separate method for sending emsg content.
                     this.nSdkInstance.ggPM('sendID3', sanitizedPayload);
                 }
             } catch (error) {
-                console.error("NielsenConnector", "Failed to parse Nielsen payload", error);
+                console.error('NielsenConnector', 'Failed to parse Nielsen payload', error);
             }
         }
-    }
+    };
 
     private onAdBegin = () => {
         const currentAd = this.player.ads!.currentAds.filter((ad: Ad) => ad.type === 'linear');

diff --git a/nielsen/src/utils/Util.ts b/nielsen/src/utils/Util.ts
@@ -1,4 +1,4 @@
-import { AdBreak } from 'theoplayer';
+import type { AdBreak } from 'theoplayer';
 import { AdType } from '../nielsen/Types';
 
 export function getAdType(adBreak: AdBreak): AdType {