eslint-plugin-cvsdk-rules 1.0.0-test2 → 1.0.0

package/build/index.d.ts

@@ -0,0 +1,11 @@
+declare const plugin: {
+    rules: {
+        'prefer-no-lodash-cloneDeep': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"forbiddenCloneDeepUsage", never[], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener>;
+        'prefer-self-over-window': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"forbiddenWindowAccess", never[], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener>;
+        'prefer-txml-over-domparser': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"forbiddenDomParserUsage", never[], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener>;
+        'no-device-type-imports': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"forbiddenDeviceTypeUsage" | "forbiddenDeviceTypeUtilUsage", never[], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener>;
+        'prefer-private-exposables': import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"preferPrivateExposable", never[], unknown, import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener>;
+    };
+};
+export { plugin };
+//# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAcA,QAAA,MAAM,MAAM;;;;;;;;CAEX,CAAC;AAEF,OAAO,EAAE,MAAM,EAAE,CAAC"}

package/build/index.js

@@ -0,0 +1,17 @@
+import { rule as preferSelfOverWindow } from './rules/prefer-self-over-window.js';
+import { rule as preferTxmlOverDomParser } from './rules/prefer-txml-over-domparser.js';
+import { rule as preferNoLodashCloneDeep } from './rules/prefer-no-lodash-clone-deep.js';
+import { rule as noDeviceTypeImports } from './rules/no-device-type-imports.js';
+import { rule as preferPrivateExposables } from './rules/prefer-private-exposables.js';
+var rules = {
+    'prefer-no-lodash-cloneDeep': preferNoLodashCloneDeep,
+    'prefer-self-over-window': preferSelfOverWindow,
+    'prefer-txml-over-domparser': preferTxmlOverDomParser,
+    'no-device-type-imports': noDeviceTypeImports,
+    'prefer-private-exposables': preferPrivateExposables,
+};
+var plugin = {
+    rules: rules,
+};
+export { plugin };
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,IAAI,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAClF,OAAO,EAAE,IAAI,IAAI,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AACxF,OAAO,EAAE,IAAI,IAAI,uBAAuB,EAAE,MAAM,wCAAwC,CAAC;AACzF,OAAO,EAAE,IAAI,IAAI,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AAChF,OAAO,EAAE,IAAI,IAAI,uBAAuB,EAAE,MAAM,sCAAsC,CAAC;AAEvF,IAAM,KAAK,GAAG;IACV,4BAA4B,EAAE,uBAAuB;IACrD,yBAAyB,EAAE,oBAAoB;IAC/C,4BAA4B,EAAE,uBAAuB;IACrD,wBAAwB,EAAE,mBAAmB;IAC7C,2BAA2B,EAAE,uBAAuB;CACvD,CAAC;AAEF,IAAM,MAAM,GAAG;IACX,KAAK,OAAA;CACR,CAAC;AAEF,OAAO,EAAE,MAAM,EAAE,CAAC"}

package/build/rules/no-device-type-imports.d.ts

@@ -0,0 +1,3 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+export declare const rule: ESLintUtils.RuleModule<"forbiddenDeviceTypeUsage" | "forbiddenDeviceTypeUtilUsage", never[], unknown, ESLintUtils.RuleListener>;
+//# sourceMappingURL=no-device-type-imports.d.ts.map

package/build/rules/no-device-type-imports.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-device-type-imports.d.ts","sourceRoot":"","sources":["../../src/rules/no-device-type-imports.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAiB,MAAM,0BAA0B,CAAC;AAItE,eAAO,MAAM,IAAI,iIAoCf,CAAC"}

package/build/rules/no-device-type-imports.js

@@ -0,0 +1,36 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+var createRule = ESLintUtils.RuleCreator(function (name) { return name; });
+export var rule = createRule({
+    create: function (context) {
+        return {
+            "Program:has(ImportDeclaration[source.value='@sky-uk-ott/client-lib-js-device'] > ImportSpecifier[imported.name=DeviceType])": function (node) {
+                context.report({
+                    node: node,
+                    messageId: 'forbiddenDeviceTypeUsage',
+                });
+            },
+            // Note the unicode character here is required to match a forward slash in the import path
+            // See https://eslint.org/docs/latest/extend/selectors#known-issues
+            'Program:has(ImportDeclaration[source.value=/.*\\u002Fdevice-type/])': function (node) {
+                context.report({
+                    node: node,
+                    messageId: 'forbiddenDeviceTypeUtilUsage',
+                });
+            },
+        };
+    },
+    name: 'no-device-type-imports',
+    meta: {
+        docs: {
+            description: 'Detect DeviceType usage in the CVSDK',
+        },
+        messages: {
+            forbiddenDeviceTypeUsage: 'This portion of the CVSDK is device agnostic. Please do not directly use DeviceType for device specific functionality.',
+            forbiddenDeviceTypeUtilUsage: 'This portion of the CVSDK is device agnostic. Please do not directly use the utils/device-type module for device specific functionality.',
+        },
+        schema: [],
+        type: 'problem',
+    },
+    defaultOptions: [],
+});
+//# sourceMappingURL=no-device-type-imports.js.map

package/build/rules/no-device-type-imports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-device-type-imports.js","sourceRoot":"","sources":["../../src/rules/no-device-type-imports.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAiB,MAAM,0BAA0B,CAAC;AAEtE,IAAM,UAAU,GAAG,WAAW,CAAC,WAAW,CAAC,UAAC,IAAI,IAAK,OAAA,IAAI,EAAJ,CAAI,CAAC,CAAC;AAE3D,MAAM,CAAC,IAAM,IAAI,GAAG,UAAU,CAAC;IAC3B,MAAM,YAAC,OAAO;QACV,OAAO;YACH,6HAA6H,EAAE,UAC3H,IAAoC;gBAEpC,OAAO,CAAC,MAAM,CAAC;oBACX,IAAI,MAAA;oBACJ,SAAS,EAAE,0BAA0B;iBACxC,CAAC,CAAC;YACP,CAAC;YACD,0FAA0F;YAC1F,mEAAmE;YACnE,qEAAqE,EAAE,UAAC,IAAI;gBACxE,OAAO,CAAC,MAAM,CAAC;oBACX,IAAI,MAAA;oBACJ,SAAS,EAAE,8BAA8B;iBAC5C,CAAC,CAAC;YACP,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,EAAE,wBAAwB;IAC9B,IAAI,EAAE;QACF,IAAI,EAAE;YACF,WAAW,EAAE,sCAAsC;SACtD;QACD,QAAQ,EAAE;YACN,wBAAwB,EACpB,wHAAwH;YAC5H,4BAA4B,EACxB,0IAA0I;SACjJ;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,SAAS;KAClB;IACD,cAAc,EAAE,EAAE;CACrB,CAAC,CAAC"}

package/build/rules/prefer-no-lodash-clone-deep.d.ts

@@ -0,0 +1,3 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+export declare const rule: ESLintUtils.RuleModule<"forbiddenCloneDeepUsage", never[], unknown, ESLintUtils.RuleListener>;
+//# sourceMappingURL=prefer-no-lodash-clone-deep.d.ts.map

package/build/rules/prefer-no-lodash-clone-deep.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefer-no-lodash-clone-deep.d.ts","sourceRoot":"","sources":["../../src/rules/prefer-no-lodash-clone-deep.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAIvD,eAAO,MAAM,IAAI,+FAwBf,CAAC"}

package/build/rules/prefer-no-lodash-clone-deep.js

@@ -0,0 +1,27 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+var createRule = ESLintUtils.RuleCreator(function (name) { return name; });
+export var rule = createRule({
+    create: function (context) {
+        return {
+            "Program:has(ImportDeclaration[source.value='lodash'] > ImportSpecifier[imported.name=cloneDeep]) CallExpression[callee.name=cloneDeep]": function (node) {
+                context.report({
+                    node: node,
+                    messageId: 'forbiddenCloneDeepUsage',
+                });
+            },
+        };
+    },
+    name: 'prefer-no-lodash-cloneDeep',
+    meta: {
+        docs: {
+            description: 'Detect usage of Lodash cloneDeep',
+        },
+        messages: {
+            forbiddenCloneDeepUsage: "Prefer using rfdc (@sky-uk-ott/core-video-sdk-js-external-rfdc) over lodash.cloneDeep as it cost a lot in performance",
+        },
+        schema: [],
+        type: 'problem',
+    },
+    defaultOptions: [],
+});
+//# sourceMappingURL=prefer-no-lodash-clone-deep.js.map

package/build/rules/prefer-no-lodash-clone-deep.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefer-no-lodash-clone-deep.js","sourceRoot":"","sources":["../../src/rules/prefer-no-lodash-clone-deep.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,IAAM,UAAU,GAAG,WAAW,CAAC,WAAW,CAAC,UAAC,IAAI,IAAK,OAAA,IAAI,EAAJ,CAAI,CAAC,CAAC;AAE3D,MAAM,CAAC,IAAM,IAAI,GAAG,UAAU,CAAC;IAC3B,MAAM,YAAC,OAAO;QACV,OAAO;YACH,wIAAwI,EACpI,UAAC,IAAI;gBACD,OAAO,CAAC,MAAM,CAAC;oBACX,IAAI,MAAA;oBACJ,SAAS,EAAE,yBAAyB;iBACvC,CAAC,CAAC;YACP,CAAC;SACR,CAAC;IACN,CAAC;IACD,IAAI,EAAE,4BAA4B;IAClC,IAAI,EAAE;QACF,IAAI,EAAE;YACF,WAAW,EAAE,kCAAkC;SAClD;QACD,QAAQ,EAAE;YACN,uBAAuB,EAAE,uHAAuH;SACnJ;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,SAAS;KAClB;IACD,cAAc,EAAE,EAAE;CACrB,CAAC,CAAC"}

package/build/rules/prefer-private-exposables.d.ts

@@ -0,0 +1,3 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+export declare const rule: ESLintUtils.RuleModule<"preferPrivateExposable", never[], unknown, ESLintUtils.RuleListener>;
+//# sourceMappingURL=prefer-private-exposables.d.ts.map

package/build/rules/prefer-private-exposables.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefer-private-exposables.d.ts","sourceRoot":"","sources":["../../src/rules/prefer-private-exposables.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAiB,MAAM,0BAA0B,CAAC;AAItE,eAAO,MAAM,IAAI,8FAyBf,CAAC"}

package/build/rules/prefer-private-exposables.js

@@ -0,0 +1,30 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+var createRule = ESLintUtils.RuleCreator(function (name) { return name; });
+export var rule = createRule({
+    create: function (context) {
+        var _a;
+        var publicExposableNames = ['Ad', 'AdBreak', 'AdPosition', 'Track'];
+        var selector = publicExposableNames.map(function (name) { return "ImportSpecifier[imported.name=".concat(name, "]"); }).join(', ');
+        return _a = {},
+            _a["Program:has(".concat(selector, ")")] = function (node) {
+                context.report({
+                    node: node,
+                    messageId: 'preferPrivateExposable',
+                });
+            },
+            _a;
+    },
+    name: 'prefer-private-exposables',
+    meta: {
+        docs: {
+            description: 'Prefer private versions of exposables within CVSDK core',
+        },
+        messages: {
+            preferPrivateExposable: 'Please use Internal variant of public data type (eg. AdBreakInternal instead of AdBreak) inside the core',
+        },
+        schema: [],
+        type: 'problem',
+    },
+    defaultOptions: [],
+});
+//# sourceMappingURL=prefer-private-exposables.js.map

package/build/rules/prefer-private-exposables.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefer-private-exposables.js","sourceRoot":"","sources":["../../src/rules/prefer-private-exposables.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAiB,MAAM,0BAA0B,CAAC;AAEtE,IAAM,UAAU,GAAG,WAAW,CAAC,WAAW,CAAC,UAAC,IAAI,IAAK,OAAA,IAAI,EAAJ,CAAI,CAAC,CAAC;AAE3D,MAAM,CAAC,IAAM,IAAI,GAAG,UAAU,CAAC;IAC3B,MAAM,YAAC,OAAO;;QACV,IAAM,oBAAoB,GAAG,CAAC,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;QACtE,IAAM,QAAQ,GAAG,oBAAoB,CAAC,GAAG,CAAC,UAAC,IAAI,IAAK,OAAA,wCAAiC,IAAI,MAAG,EAAxC,CAAwC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzG;YACI,GAAC,sBAAe,QAAQ,MAAG,IAAG,UAAC,IAAoC;gBAC/D,OAAO,CAAC,MAAM,CAAC;oBACX,IAAI,MAAA;oBACJ,SAAS,EAAE,wBAAwB;iBACtC,CAAC,CAAC;YACP,CAAC;eACH;IACN,CAAC;IACD,IAAI,EAAE,2BAA2B;IACjC,IAAI,EAAE;QACF,IAAI,EAAE;YACF,WAAW,EAAE,yDAAyD;SACzE;QACD,QAAQ,EAAE;YACN,sBAAsB,EAAE,0GAA0G;SACrI;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,SAAS;KAClB;IACD,cAAc,EAAE,EAAE;CACrB,CAAC,CAAC"}

package/build/rules/prefer-self-over-window.d.ts

@@ -0,0 +1,3 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+export declare const rule: ESLintUtils.RuleModule<"forbiddenWindowAccess", never[], unknown, ESLintUtils.RuleListener>;
+//# sourceMappingURL=prefer-self-over-window.d.ts.map

package/build/rules/prefer-self-over-window.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefer-self-over-window.d.ts","sourceRoot":"","sources":["../../src/rules/prefer-self-over-window.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAiB,MAAM,0BAA0B,CAAC;AAItE,eAAO,MAAM,IAAI,6FAoCf,CAAC"}

package/build/rules/prefer-self-over-window.js

@@ -0,0 +1,38 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+var createRule = ESLintUtils.RuleCreator(function (name) { return name; });
+export var rule = createRule({
+    create: function (context) {
+        var parserServices = ESLintUtils.getParserServices(context);
+        function reportWindowError(node) {
+            if (node.parent.type !== 'VariableDeclarator') {
+                var nodeType = parserServices.getTypeAtLocation(node);
+                if (Object.prototype.hasOwnProperty.call(nodeType, 'aliasSymbol')) {
+                    context.report({
+                        messageId: 'forbiddenWindowAccess',
+                        node: node,
+                        fix: function (fixer) {
+                            return fixer.replaceText(node, 'self');
+                        },
+                    });
+                }
+            }
+        }
+        return {
+            "Identifier[name='window']": reportWindowError,
+        };
+    },
+    name: 'uppercase-first-declarations',
+    meta: {
+        docs: {
+            description: 'Disallow window access.',
+        },
+        messages: {
+            forbiddenWindowAccess: '`window` cannot be accessed inside some containers, we prefer using `self` as it has more compatibility.',
+        },
+        schema: [],
+        type: 'problem',
+        fixable: 'code',
+    },
+    defaultOptions: [],
+});
+//# sourceMappingURL=prefer-self-over-window.js.map

package/build/rules/prefer-self-over-window.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefer-self-over-window.js","sourceRoot":"","sources":["../../src/rules/prefer-self-over-window.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAiB,MAAM,0BAA0B,CAAC;AAEtE,IAAM,UAAU,GAAG,WAAW,CAAC,WAAW,CAAC,UAAC,IAAI,IAAK,OAAA,IAAI,EAAJ,CAAI,CAAC,CAAC;AAE3D,MAAM,CAAC,IAAM,IAAI,GAAG,UAAU,CAAC;IAC3B,MAAM,YAAC,OAAO;QACV,IAAM,cAAc,GAAG,WAAW,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAE9D,SAAS,iBAAiB,CAAC,IAAmB;YAC1C,IAAI,IAAI,CAAC,MAAO,CAAC,IAAI,KAAK,oBAAoB,EAAE;gBAC5C,IAAM,QAAQ,GAAG,cAAc,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;gBACxD,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC,EAAE;oBAC/D,OAAO,CAAC,MAAM,CAAC;wBACX,SAAS,EAAE,uBAAuB;wBAClC,IAAI,MAAA;wBACJ,GAAG,EAAE,UAAU,KAAK;4BAChB,OAAO,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;wBAC3C,CAAC;qBACJ,CAAC,CAAC;iBACN;aACJ;QACL,CAAC;QAED,OAAO;YACH,2BAA2B,EAAE,iBAAiB;SACjD,CAAC;IACN,CAAC;IACD,IAAI,EAAE,8BAA8B;IACpC,IAAI,EAAE;QACF,IAAI,EAAE;YACF,WAAW,EAAE,yBAAyB;SACzC;QACD,QAAQ,EAAE;YACN,qBAAqB,EAAE,0GAA0G;SACpI;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,MAAM;KAClB;IACD,cAAc,EAAE,EAAE;CACrB,CAAC,CAAC"}

package/build/rules/prefer-txml-over-domparser.d.ts

@@ -0,0 +1,3 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+export declare const rule: ESLintUtils.RuleModule<"forbiddenDomParserUsage", never[], unknown, ESLintUtils.RuleListener>;
+//# sourceMappingURL=prefer-txml-over-domparser.d.ts.map

package/build/rules/prefer-txml-over-domparser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefer-txml-over-domparser.d.ts","sourceRoot":"","sources":["../../src/rules/prefer-txml-over-domparser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAIvD,eAAO,MAAM,IAAI,+FAuBf,CAAC"}

package/build/rules/prefer-txml-over-domparser.js

@@ -0,0 +1,27 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+var createRule = ESLintUtils.RuleCreator(function (name) { return name; });
+export var rule = createRule({
+    create: function (context) {
+        return {
+            Identifier: function (node) {
+                if (node.type === 'Identifier' && node.name === 'DOMParser' && node.parent.type === 'NewExpression') {
+                    context.report({
+                        node: node,
+                        messageId: 'forbiddenDomParserUsage',
+                    });
+                }
+            },
+        };
+    },
+    name: 'prefer-txml-over-domparser',
+    meta: {
+        docs: { description: 'Disallow DOMParser usage.' },
+        messages: {
+            forbiddenDomParserUsage: "Prefer using txml (https://www.npmjs.com/package/txml) over DOMParser as DOMParser isn't supported on ION.",
+        },
+        schema: [],
+        type: 'problem',
+    },
+    defaultOptions: [],
+});
+//# sourceMappingURL=prefer-txml-over-domparser.js.map

package/build/rules/prefer-txml-over-domparser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefer-txml-over-domparser.js","sourceRoot":"","sources":["../../src/rules/prefer-txml-over-domparser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,IAAM,UAAU,GAAG,WAAW,CAAC,WAAW,CAAC,UAAC,IAAI,IAAK,OAAA,IAAI,EAAJ,CAAI,CAAC,CAAC;AAE3D,MAAM,CAAC,IAAM,IAAI,GAAG,UAAU,CAAC;IAC3B,MAAM,YAAC,OAAO;QACV,OAAO;YACH,UAAU,YAAC,IAAI;gBACX,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,eAAe,EAAE;oBACjG,OAAO,CAAC,MAAM,CAAC;wBACX,IAAI,MAAA;wBACJ,SAAS,EAAE,yBAAyB;qBACvC,CAAC,CAAC;iBACN;YACL,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,EAAE,4BAA4B;IAClC,IAAI,EAAE;QACF,IAAI,EAAE,EAAE,WAAW,EAAE,2BAA2B,EAAE;QAClD,QAAQ,EAAE;YACN,uBAAuB,EAAE,4GAA4G;SACxI;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,SAAS;KAClB;IACD,cAAc,EAAE,EAAE;CACrB,CAAC,CAAC"}

package/jest.config.js

@@ -1,2 +1,40 @@
-{
-}
+import path from 'node:path';
+
+export default {
+    collectCoverage: false,
+    collectCoverageFrom: ['src/**/*.{js,jsx,ts,tsx}'],
+    coverageReporters: ['lcov'],
+    moduleFileExtensions: [
+      'ts',
+      'tsx',
+      'mts',
+      'mtsx',
+      'cjs',
+      'js',
+      'jsx',
+      'mjs',
+      'mjsx',
+      'json',
+      'node',
+    ],
+    setupFilesAfterEnv: [
+      path.join(path.resolve(), 'node_modules/console-fail-test/setup.cjs'),
+    ],
+    testRegex: ['./tests/.+\\.test\\.ts$', './src/rules/.+\\.spec\\.ts$'],
+    transform: {
+      '^.+\\.(t|j)sx?$': [
+        '@swc/jest',
+        {
+          jsc: {
+            target: 'es2019',
+            transform: {
+              react: {
+                runtime: 'automatic',
+              },
+            },
+          },
+        },
+      ],
+    },
+    workerIdleMemoryLimit: '300MB',
+  };

package/package.json

@@ -1,18 +1,26 @@
 {
-    "name": "eslint-plugin-cvsdk-rules",
-    "version": "1.0.0-test2",
-    "main": "index.js",
-    "scripts": {
-        "test": "jest",
-        "test:nocoverage": "jest"
-    },
-    "dependencies": {
-        "@typescript-eslint/utils": "6.21.0",
-        "eslint": "8.54.0"
-    },
-    "devDependencies": {
-        "@typescript-eslint/rule-tester": "6.21.0",
-        "jest": "29.7.0"
-    },
-    "gitHead": "dc2d93e44d0f5dc4b6ba2fdc018bb510a3ca806a"
-}
+  "name": "eslint-plugin-cvsdk-rules",
+  "version": "1.0.0",
+  "main": "./build/index.js",
+  "type": "module",
+  "dependencies": {
+    "typescript-eslint": "8.8.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.8.0",
+    "@types/eslint": "^9.6.0",
+    "@types/eslint__js": "^8.42.3",
+    "@types/node": "^22.0.2",
+    "@typescript-eslint/utils": "8.34.0",
+    "@typescript-eslint/rule-tester": "8.8.0",
+    "console-fail-test": "^0.5.0",
+    "eslint": "^9.8.0",
+    "eslint-plugin-eslint-plugin": "6.2.0",
+    "typescript": "5.2.2"
+  },
+  "scripts": {
+    "test": "jest",
+    "test:nocoverage": "jest",
+    "build": "tsc"
+  }
+}

package/src/index.ts

@@ -0,0 +1,19 @@
+import { rule as preferSelfOverWindow } from './rules/prefer-self-over-window.js';
+import { rule as preferTxmlOverDomParser } from './rules/prefer-txml-over-domparser.js';
+import { rule as preferNoLodashCloneDeep } from './rules/prefer-no-lodash-clone-deep.js';
+import { rule as noDeviceTypeImports } from './rules/no-device-type-imports.js';
+import { rule as preferPrivateExposables } from './rules/prefer-private-exposables.js';
+
+const rules = {
+    'prefer-no-lodash-cloneDeep': preferNoLodashCloneDeep,
+    'prefer-self-over-window': preferSelfOverWindow,
+    'prefer-txml-over-domparser': preferTxmlOverDomParser,
+    'no-device-type-imports': noDeviceTypeImports,
+    'prefer-private-exposables': preferPrivateExposables,
+};
+
+const plugin = {
+    rules,
+};
+
+export { plugin };

package/src/rules/no-device-type-imports.ts

@@ -0,0 +1,41 @@
+import { ESLintUtils, type TSESTree } from '@typescript-eslint/utils';
+
+const createRule = ESLintUtils.RuleCreator((name) => name);
+
+export const rule = createRule({
+    create(context) {
+        return {
+            "Program:has(ImportDeclaration[source.value='@sky-uk-ott/client-lib-js-device'] > ImportSpecifier[imported.name=DeviceType])": (
+                node: TSESTree.Node | TSESTree.Token
+            ) => {
+                context.report({
+                    node,
+                    messageId: 'forbiddenDeviceTypeUsage',
+                });
+            },
+            // Note the unicode character here is required to match a forward slash in the import path
+            // See https://eslint.org/docs/latest/extend/selectors#known-issues
+            'Program:has(ImportDeclaration[source.value=/.*\\u002Fdevice-type/])': (node) => {
+                context.report({
+                    node,
+                    messageId: 'forbiddenDeviceTypeUtilUsage',
+                });
+            },
+        };
+    },
+    name: 'no-device-type-imports',
+    meta: {
+        docs: {
+            description: 'Detect DeviceType usage in the CVSDK',
+        },
+        messages: {
+            forbiddenDeviceTypeUsage:
+                'This portion of the CVSDK is device agnostic. Please do not directly use DeviceType for device specific functionality.',
+            forbiddenDeviceTypeUtilUsage:
+                'This portion of the CVSDK is device agnostic. Please do not directly use the utils/device-type module for device specific functionality.',
+        },
+        schema: [],
+        type: 'problem',
+    },
+    defaultOptions: [],
+});

package/src/rules/prefer-no-lodash-clone-deep.ts

@@ -0,0 +1,29 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+
+const createRule = ESLintUtils.RuleCreator((name) => name);
+
+export const rule = createRule({
+    create(context) {
+        return {
+            "Program:has(ImportDeclaration[source.value='lodash'] > ImportSpecifier[imported.name=cloneDeep]) CallExpression[callee.name=cloneDeep]":
+                (node) => {
+                    context.report({
+                        node,
+                        messageId: 'forbiddenCloneDeepUsage',
+                    });
+                },
+        };
+    },
+    name: 'prefer-no-lodash-cloneDeep',
+    meta: {
+        docs: {
+            description: 'Detect usage of Lodash cloneDeep',
+        },
+        messages: {
+            forbiddenCloneDeepUsage: `Prefer using rfdc (@sky-uk-ott/core-video-sdk-js-external-rfdc) over lodash.cloneDeep as it cost a lot in performance`,
+        },
+        schema: [],
+        type: 'problem',
+    },
+    defaultOptions: [],
+});

package/src/rules/prefer-private-exposables.ts

@@ -0,0 +1,30 @@
+import { ESLintUtils, type TSESTree } from '@typescript-eslint/utils';
+
+const createRule = ESLintUtils.RuleCreator((name) => name);
+
+export const rule = createRule({
+    create(context) {
+        const publicExposableNames = ['Ad', 'AdBreak', 'AdPosition', 'Track'];
+        const selector = publicExposableNames.map((name) => `ImportSpecifier[imported.name=${name}]`).join(', ');
+        return {
+            [`Program:has(${selector})`]: (node: TSESTree.Node | TSESTree.Token) => {
+                context.report({
+                    node,
+                    messageId: 'preferPrivateExposable',
+                });
+            },
+        };
+    },
+    name: 'prefer-private-exposables',
+    meta: {
+        docs: {
+            description: 'Prefer private versions of exposables within CVSDK core',
+        },
+        messages: {
+            preferPrivateExposable: 'Please use Internal variant of public data type (eg. AdBreakInternal instead of AdBreak) inside the core',
+        },
+        schema: [],
+        type: 'problem',
+    },
+    defaultOptions: [],
+});

package/{rules/prefer-self-over-window.spec.js → src/rules/prefer-self-over-window.spec.ts}

@@ -1,21 +1,26 @@
-const { RuleTester } = require('@typescript-eslint/rule-tester');
-const path = require('path');
+import { RuleTester } from '@typescript-eslint/rule-tester';
+import tseslint from 'typescript-eslint';
+import path from 'node:path';
+import { rule } from '../../build/rules/prefer-self-over-window.js';
 
-const rule = require('./prefer-self-over-window');
-
-const ruleName = 'prefer-self-over-window';
+console.log(`Root dir: ${path.join(__dirname, '../..')}`);
 
 // https://typescript-eslint.io/packages/rule-tester/#type-aware-testing
 const ruleTester = new RuleTester({
-    parser: require.resolve('@typescript-eslint/parser'),
-    parserOptions: {
-        project: true,
-        tsconfigRootDir: path.join(__dirname, '../config'),
+    languageOptions: {
+        parser: tseslint.parser,
+        parserOptions: {
+            projectService: {
+                allowDefaultProject: ['*.ts*'],
+                defaultProject: 'tsconfig.json',
+            },
+            tsconfigRootDir: path.join(__dirname, '../..'),
+        },
     },
 });
 
 describe('Disallow window access', () => {
-    ruleTester.run(ruleName, rule, {
+    ruleTester.run('prefer-self-over-window', rule, {
         invalid: [
             {
                 code: 'window;',

package/src/rules/prefer-self-over-window.ts

@@ -0,0 +1,41 @@
+import { ESLintUtils, type TSESTree } from '@typescript-eslint/utils';
+
+const createRule = ESLintUtils.RuleCreator((name) => name);
+
+export const rule = createRule({
+    create(context) {
+        const parserServices = ESLintUtils.getParserServices(context);
+
+        function reportWindowError(node: TSESTree.Node) {
+            if (node.parent!.type !== 'VariableDeclarator') {
+                const nodeType = parserServices.getTypeAtLocation(node);
+                if (Object.prototype.hasOwnProperty.call(nodeType, 'aliasSymbol')) {
+                    context.report({
+                        messageId: 'forbiddenWindowAccess',
+                        node,
+                        fix: function (fixer) {
+                            return fixer.replaceText(node, 'self');
+                        },
+                    });
+                }
+            }
+        }
+
+        return {
+            "Identifier[name='window']": reportWindowError,
+        };
+    },
+    name: 'uppercase-first-declarations',
+    meta: {
+        docs: {
+            description: 'Disallow window access.',
+        },
+        messages: {
+            forbiddenWindowAccess: '`window` cannot be accessed inside some containers, we prefer using `self` as it has more compatibility.',
+        },
+        schema: [], // no options
+        type: 'problem',
+        fixable: 'code',
+    },
+    defaultOptions: [],
+});

package/src/rules/prefer-txml-over-domparser.ts

@@ -0,0 +1,28 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+
+const createRule = ESLintUtils.RuleCreator((name) => name);
+
+export const rule = createRule({
+    create(context) {
+        return {
+            Identifier(node) {
+                if (node.type === 'Identifier' && node.name === 'DOMParser' && node.parent.type === 'NewExpression') {
+                    context.report({
+                        node,
+                        messageId: 'forbiddenDomParserUsage',
+                    });
+                }
+            },
+        };
+    },
+    name: 'prefer-txml-over-domparser',
+    meta: {
+        docs: { description: 'Disallow DOMParser usage.' },
+        messages: {
+            forbiddenDomParserUsage: `Prefer using txml (https://www.npmjs.com/package/txml) over DOMParser as DOMParser isn't supported on ION.`,
+        },
+        schema: [],
+        type: 'problem',
+    },
+    defaultOptions: [],
+});

package/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+      "module": "esnext",
+      "declaration": true,
+      "outDir": "build",
+      "declarationMap": true,
+      "downlevelIteration": true,
+      "noImplicitAny": true,
+      "preserveConstEnums": true,
+      "sourceMap": true,
+      "target": "es5",
+      "strict": true,
+      "noUnusedLocals": true,
+      "skipLibCheck": true,
+      "moduleResolution": "node",
+      "resolveJsonModule": true,
+      "importHelpers": true,
+      "esModuleInterop": true,
+      "jsx": "react",
+      "useDefineForClassFields": false,
+      "lib": ["dom", "dom.iterable", "es2017"]
+  },
+"include": ["src/**/*.ts"],
+"exclude": ["**/*.spec.ts"]
+}

package/config/file.ts

@@ -1 +0,0 @@
-// See: https://typescript-eslint.io/packages/rule-tester/#type-aware-testing

package/config/tsconfig.json

@@ -1,11 +0,0 @@
-{
-  // https://typescript-eslint.io/packages/rule-tester/#type-aware-testing
-  "compilerOptions": {
-    // Otherwise TS will complain it'll override the base project's output
-    "outDir": "./",
-    "strict": true
-  },
-  "exclude": [],
-  // See: https://typescript-eslint.io/packages/rule-tester/#type-aware-testing
-  "include": ["file.ts"]
-}

package/index.js

@@ -1,6 +0,0 @@
-module.exports = {
-    rules: {
-        'prefer-self-over-window': require('./rules/prefer-self-over-window'),
-        'prefer-txml-over-domparser': require('./rules/prefer-txml-over-domparser'),
-    },
-};

package/rules/prefer-self-over-window.js

@@ -1,41 +0,0 @@
-const { ESLintUtils } = require('@typescript-eslint/utils');
-
-const meta = {
-    docs: {
-        description: 'Disallow window access.',
-    },
-    messages: {
-        forbiddenWindowAccess: '`window` cannot be accessed inside some containers, we prefer using `self` as it has more compatibility.',
-    },
-    schema: [], // no options
-    type: 'problem',
-    fixable: 'code',
-};
-
-function create(context) {
-    const parserServices = ESLintUtils.getParserServices(context);
-
-    function reportWindowError(node) {
-        if (node.parent.type !== 'VariableDeclarator') {
-            const nodeType = parserServices.getTypeAtLocation(node);
-            if (Object.prototype.hasOwnProperty.call(nodeType, 'aliasSymbol')) {
-                context.report({
-                    messageId: 'forbiddenWindowAccess',
-                    node,
-                    fix: function (fixer) {
-                        return fixer.replaceText(node, 'self');
-                    },
-                });
-            }
-        }
-    }
-
-    return {
-        "Identifier[name='window']": reportWindowError,
-    };
-}
-
-module.exports = {
-    create,
-    meta,
-};

package/rules/prefer-txml-over-domparser.js

@@ -1,26 +0,0 @@
-const meta = {
-    docs: 'Disallow DOMParser usage.',
-    messages: {
-        forbiddenDomParserUsage: `Prefer using txml (https://www.npmjs.com/package/txml) over DOMParser as DOMParser isn't supported on ION.`,
-    },
-    schema: [],
-    type: 'problem',
-};
-
-function create(context) {
-    return {
-        Identifier(node) {
-            if (node.type === 'Identifier' && node.name === 'DOMParser' && node.parent.type === 'NewExpression') {
-                context.report({
-                    node,
-                    messageId: 'forbiddenDomParserUsage',
-                });
-            }
-        },
-    };
-}
-
-module.exports = {
-    create,
-    meta,
-};