adding tslint-microsoft-contrib

packages/clarity-decode/package.json

@@ -26,7 +26,8 @@
     "url": "https://github.com/Microsoft/clarity/issues"
   },
   "dependencies": {
-    "clarity-js": "^0.5.9"
+    "clarity-js": "^0.5.9",
+    "tslint-microsoft-contrib": "^6.2.0"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^11.1.0",

packages/clarity-decode/src/clarity.ts

@@ -1,18 +1,18 @@
 import { Data, version } from "clarity-js";
-import { DecodedPayload, DecodedVersion } from "../types/data";
-import { MetricEvent, PageEvent, PingEvent, SummaryEvent, TagEvent, TargetEvent, UpgradeEvent, UploadEvent } from "../types/data";
-import { ImageErrorEvent, InternalErrorEvent, ScriptErrorEvent } from "../types/diagnostic";
-import { ClickEvent, InputEvent, PointerEvent, ResizeEvent, ScrollEvent } from "../types/interaction";
-import { SelectionEvent, UnloadEvent, VisibilityEvent } from "../types/interaction";
-import { BoxModelEvent, DocumentEvent, DomEvent, HashEvent, ResourceEvent } from "../types/layout";
-import { ConnectionEvent, LargestContentfulPaintEvent, LongTaskEvent, MemoryEvent } from "../types/performance";
-import { NavigationEvent, NetworkEvent, PaintEvent } from "../types/performance";
+import { DecodedPayload, DecodedVersion } from "@clarity-types/data";
+import { MetricEvent, PageEvent, PingEvent, SummaryEvent, TagEvent, TargetEvent, UpgradeEvent, UploadEvent } from "@clarity-types/data";
+import { ImageErrorEvent, InternalErrorEvent, ScriptErrorEvent } from "@clarity-types/diagnostic";
+import { ClickEvent, InputEvent, PointerEvent, ResizeEvent, ScrollEvent } from "@clarity-types/interaction";
+import { SelectionEvent, UnloadEvent, VisibilityEvent } from "@clarity-types/interaction";
+import { BoxModelEvent, DocumentEvent, DomEvent, HashEvent, ResourceEvent } from "@clarity-types/layout";
+import { ConnectionEvent, LargestContentfulPaintEvent, LongTaskEvent, MemoryEvent } from "@clarity-types/performance";
+import { NavigationEvent, NetworkEvent, PaintEvent } from "@clarity-types/performance";
 
-import * as data from "./data";
-import * as diagnostic from "./diagnostic";
-import * as interaction from "./interaction";
-import * as layout from "./layout";
-import * as performance from "./performance";
+import * as data from "@src/data";
+import * as diagnostic from "@src/diagnostic";
+import * as interaction from "@src/interaction";
+import * as layout from "@src/layout";
+import * as performance from "@src/performance";
 
 export function decode(input: string): DecodedPayload {
     let json: Data.Payload = JSON.parse(input);
@@ -34,7 +34,7 @@ export function decode(input: string): DecodedPayload {
         throw new Error(`Invalid version. Actual: ${payload.envelope.version} | Expected: ${version} (+/- 1) | ${input.substr(0, 250)}`);
     }
 
-    /* Reset components before decoding to keep them stateless */
+    // Reset components before decoding to keep them stateless
     data.reset();
     layout.reset();
 
@@ -175,7 +175,7 @@ export function decode(input: string): DecodedPayload {
         }
     }
 
-    /* Enrich decoded payload with derived events */
+    // Enrich decoded payload with derived events
     payload.summary = data.summary() as SummaryEvent[];
     if (payload.dom && payload.dom.length > 0) { payload.hash = layout.hash() as HashEvent[]; }
     if (layout.resources.length > 0) { payload.resource = layout.resource() as ResourceEvent[]; }

packages/clarity-decode/src/data.ts

@@ -1,5 +1,5 @@
 import { Data } from "clarity-js";
-import { DataEvent } from "../types/data";
+import { DataEvent } from "@clarity-types/data";
 
 let summaries: { [key: number]: Data.SummaryData[] } = null;
 const SUMMARY_THRESHOLD = 30;

packages/clarity-decode/src/diagnostic.ts

@@ -1,5 +1,5 @@
 import { Data, Diagnostic } from "clarity-js";
-import { DiagnosticEvent } from "../types/diagnostic";
+import { DiagnosticEvent } from "@clarity-types/diagnostic";
 
 export function decode(tokens: Data.Token[]): DiagnosticEvent {
     let time = tokens[0] as number;

packages/clarity-decode/src/global.ts

@@ -1,6 +1,7 @@
 import * as decode from "@src/clarity";
 
 // Expose clarity variable globally to allow access to public interface in a browser
+// tslint:disable-next-line:no-typeof-undefined
 if (typeof window !== "undefined") {
     if ((window as any).clarity === undefined || (window as any).clarity === null) {
         (window as any).clarity = {};

packages/clarity-decode/src/index.ts

@@ -1 +1 @@
-export { decode } from "./clarity";
+export { decode } from "@src/clarity";

packages/clarity-decode/src/interaction.ts

@@ -1,7 +1,7 @@
 import { Data, Interaction } from "clarity-js";
-import { InteractionEvent } from "../types/interaction";
+import { InteractionEvent } from "@clarity-types/interaction";
 
-export function decode(tokens: Data.Token[]): InteractionEvent  {
+export function decode(tokens: Data.Token[]): InteractionEvent {
     let time = tokens[0] as number;
     let event = tokens[1] as Data.Event;
     switch (event) {

packages/clarity-decode/src/layout.ts

@@ -1,5 +1,5 @@
 import { helper, Data, Layout } from "clarity-js";
-import { DomData, LayoutEvent } from "../types/layout";
+import { DomData, LayoutEvent } from "@clarity-types/layout";
 
 let placeholderImage = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR4nGNiOAMAANUAz5n+TlUAAAAASUVORK5CYII=";
 export let hashes: { [key: number]: Layout.HashData } = {};
@@ -39,7 +39,7 @@ export function decode(tokens: Data.Token[]): LayoutEvent {
             let domData: DomData[] = [];
             for (let i = 2; i < tokens.length; i++) {
                 let token = tokens[i];
-                let type = typeof(token);
+                let type = typeof (token);
                 switch (type) {
                     case "number":
                         if (type !== lastType && lastType !== null) {
@@ -55,7 +55,7 @@ export function decode(tokens: Data.Token[]): LayoutEvent {
                         break;
                     case "object":
                         let subtoken = token[0];
-                        let subtype = typeof(subtoken);
+                        let subtype = typeof (subtoken);
                         switch (subtype) {
                             case "number":
                                 for (let t of (token as number[])) {
@@ -85,7 +85,7 @@ export function resource(): LayoutEvent[] {
 }
 
 function process(node: any[] | number[], tagIndex: number): DomData {
-    let [tag, position]: string[]  = node[tagIndex] ? node[tagIndex].split("~") : [node[tagIndex]];
+    let [tag, position]: string[] = node[tagIndex] ? node[tagIndex].split("~") : [node[tagIndex]];
     let output: DomData = {
         id: node[0],
         parent: tagIndex > 1 ? node[1] : null,
@@ -137,7 +137,7 @@ function getResource(tag: string, attributes: Layout.Attributes): void {
     switch (tag) {
         case "LINK":
             if ("href" in attributes && "rel" in attributes && attributes["rel"] === "stylesheet") {
-                resources.push({ tag, url: attributes["href"]});
+                resources.push({ tag, url: attributes["href"] });
             }
             break;
     }

packages/clarity-decode/src/performance.ts

@@ -1,7 +1,7 @@
 import { Data, Performance } from "clarity-js";
-import { PerformanceEvent } from "../types/performance";
+import { PerformanceEvent } from "@clarity-types/performance";
 
-export function decode(tokens: Data.Token[]): PerformanceEvent  {
+export function decode(tokens: Data.Token[]): PerformanceEvent {
     let time = tokens[0] as number;
     let event = tokens[1] as Data.Event;
     switch (event) {
@@ -64,7 +64,7 @@ export function decode(tokens: Data.Token[]): PerformanceEvent  {
             let networkData: Performance.NetworkData[] = [];
             for (let i = 2; i < tokens.length; i++) {
                 let token = tokens[i];
-                let type = typeof(token);
+                let type = typeof (token);
                 switch (type) {
                     case "number":
                         if (type !== lastType && lastType !== null) {
@@ -89,7 +89,7 @@ export function decode(tokens: Data.Token[]): PerformanceEvent  {
                             network.push(token);
                         } else {
                             let subtoken = token[0];
-                            let subtype = typeof(subtoken);
+                            let subtype = typeof (subtoken);
                             switch (subtype) {
                                 case "number":
                                     for (let t of (token as number[])) {

packages/clarity-decode/tsconfig.json

@@ -2,7 +2,12 @@
     "compilerOptions": {
         "module": "esnext",
         "target": "es5",
-        "lib": ["es6", "dom", "es2016", "es2017"],
+        "lib": [
+            "es6",
+            "dom",
+            "es2016",
+            "es2017"
+        ],
         "moduleResolution": "node",
         "forceConsistentCasingInFileNames": true,
         "noImplicitReturns": true,
@@ -11,10 +16,20 @@
         "esModuleInterop": true,
         "baseUrl": ".",
         "paths": {
-            "@src/*": ["src/*"],
-            "@clarity-types/*": ["types/*"]
+            "@src/*": [
+                "src/*"
+            ],
+            "@clarity-types/*": [
+                "types/*"
+            ]
         }
     },
-    "include":["src/**/*.ts","types/**/*.d.ts"],
-    "exclude": ["node_modules", "build"]
-}
+    "include": [
+        "src/**/*.ts",
+        "types/**/*.d.ts"
+    ],
+    "exclude": [
+        "node_modules",
+        "build"
+    ]
+}

packages/clarity-decode/tslint.json

@@ -1,5 +1,8 @@
 {
-  "extends": "tslint:recommended",
+  "extends": [
+    "tslint-microsoft-contrib/recommended",
+    "tslint:recommended"
+  ],
   "rules": {
     "max-line-length": [
       true,
@@ -20,6 +23,13 @@
     "interface-name": false,
     "interface-over-type-literal": false,
     "only-arrow-functions": false,
+    "prefer-type-cast": false,
+    "export-name": false,
+    "max-func-body-length": [
+      true,
+      200
+    ],
+    "no-for-in": false,
     "typedef": [
       true,
       "call-signature",

packages/clarity-devtools/package.json

@@ -26,7 +26,8 @@
   "dependencies": {
     "clarity-decode": "^0.5.9",
     "clarity-js": "^0.5.9",
-    "clarity-visualize": "^0.5.9"
+    "clarity-visualize": "^0.5.9",
+    "tslint-microsoft-contrib": "^6.2.0"
   },
   "devDependencies": {
     "@rollup/plugin-node-resolve": "^7.1.3",

packages/clarity-devtools/src/content.ts

@@ -1,5 +1,5 @@
+import { regions } from "@src/regions";
 import { clarity, Layout } from "clarity-js";
-import { regions } from "./regions";
 
 chrome.runtime.onMessage.addListener(function(message: any): void {
   if (message.action === "activate") {

packages/clarity-devtools/src/devtools.ts

@@ -8,7 +8,7 @@ chrome.devtools.panels.elements.createSidebarPane("Clarity", function(sidebar: a
     function updateClarityInfo(): void {
         let code = "(" + inspect.toString() + ")()";
         let inspectedWindow = chrome.devtools.inspectedWindow as any;
-        inspectedWindow.eval(code, {useContentScriptContext: true}, function(result: any): void {
+        inspectedWindow.eval(code, { useContentScriptContext: true }, function(result: any): void {
             sidebar.setObject(result);
         });
     }
@@ -26,6 +26,5 @@ function inspect(): any {
     let id = hookEnabled && value ? value.id : null;
     let history = hookEnabled && id ? window[DEVTOOLS_HOOK].history(id) : null;
     let parent = hookEnabled && value ? window[DEVTOOLS_HOOK].getNode(value.parent) : null;
-    let output = { id, tag, node: $0, parent, value, history };
-    return output;
+    return { id, tag, node: $0, parent, value, history };
 }

packages/clarity-devtools/src/panel.ts

@@ -1,6 +1,6 @@
+import * as data from "@src/data";
 import { Data, decode } from "clarity-decode";
 import { visualize } from "clarity-visualize";
-import * as data from "./data";
 
 let activeTabId = chrome.devtools.inspectedWindow.tabId;
 let background = chrome.runtime.connect({ name: "panel" });
@@ -11,8 +11,8 @@ let dJson: Data.DecodedPayload[] = [];
 
 function save(encoded: boolean = true): void {
     let json = encoded ? JSON.stringify(eJson) : JSON.stringify(dJson, null, 2);
-    let blob = new Blob([json], {type: "application/json"});
-    let url  = URL.createObjectURL(blob);
+    let blob = new Blob([json], { type: "application/json" });
+    let url = URL.createObjectURL(blob);
 
     let a = document.createElement("a");
     let suffix = encoded ? "encoded" : "decoded";

packages/clarity-devtools/src/regions.ts

@@ -1,6 +1,6 @@
 // Following regions are for demonstration purposes only
 export const regions = {
-    /* Bing */
+    // Bing
     Body: "body",
     Answers: ".b_ans",
     SearchBox: ".b_searchboxForm",
@@ -9,7 +9,7 @@ export const regions = {
     WebResults: ".b_algo",
     DisambiguationAnswer: ".disambig-outline",
     Footer: "#b_footer",
-    /* Wordpress */
+    // Wordpress
     Header: "header",
     SlickStream: ".slick-film-strip",
     PostPhoto: ".size-full",

packages/clarity-devtools/tslint.json

@@ -1,5 +1,8 @@
 {
-  "extends": "tslint:recommended",
+  "extends": [
+    "tslint-microsoft-contrib/recommended",
+    "tslint:recommended"
+  ],
   "rules": {
     "max-line-length": [
       true,
@@ -20,6 +23,9 @@
     "interface-name": false,
     "interface-over-type-literal": false,
     "only-arrow-functions": false,
+    "no-function-expression": false,
+    "prefer-type-cast": false,
+    "export-name": false,
     "typedef": [
       true,
       "call-signature",

packages/clarity-js/package.json

@@ -36,7 +36,8 @@
     "rollup-plugin-typescript2": "^0.27.0",
     "ts-node": "8.8.2",
     "tslint": "6.1.1",
-    "typescript": "^3.8.3"
+    "typescript": "^3.8.3",
+    "tslint-microsoft-contrib": "^6.2.0"
   },
   "scripts": {
     "build": "yarn build:clean && yarn build:main",
@@ -55,4 +56,4 @@
       "tslint --format codeFrame"
     ]
   }
-}
+}

packages/clarity-js/src/clarity.ts

@@ -20,7 +20,7 @@ export function config(override: Config): boolean {
   // Process custom configuration overrides, if available
   if (active) { return false; }
   for (let key in override) {
-      if (key in configuration) { configuration[key] = override[key]; }
+    if (key in config) { configuration[key] = override[key]; }
   }
   return true;
 }

packages/clarity-js/src/core/event.ts

@@ -1,16 +1,16 @@
 import { BrowserEvent } from "@clarity-types/core";
-import measure from "./measure";
+import measure from "@src/core/measure";
 
 let bindings: BrowserEvent[] = [];
 
 export function bind(target: EventTarget, event: string, listener: EventListener, capture: boolean = false): void {
-    listener = measure(listener) as EventListener;
-    // Wrapping following lines inside try / catch to cover edge cases where we might try to access an inaccessible element.
-    // E.g. Iframe may start off as same-origin but later turn into cross-origin, and the following lines will throw an exception.
-    try {
-      target.addEventListener(event, listener, capture);
-      bindings.push({ event, target, listener, capture });
-    } catch { /* do nothing */ }
+  listener = measure(listener) as EventListener;
+  // Wrapping following lines inside try / catch to cover edge cases where we might try to access an inaccessible element.
+  // E.g. Iframe may start off as same-origin but later turn into cross-origin, and the following lines will throw an exception.
+  try {
+    target.addEventListener(event, listener, capture);
+    bindings.push({ event, target, listener, capture });
+  } catch { /* do nothing */ }
 }
 
 export function reset(): void {

packages/clarity-js/src/core/index.ts

@@ -16,12 +16,12 @@ export function end(): void {
 
 export function check(): boolean {
     try {
-        return typeof Promise !== "undefined" &&
+        return window["Promise"] &&
             window["MutationObserver"] &&
             document["createTreeWalker"] &&
             "now" in Date &&
             "now" in performance &&
-            typeof WeakMap !== "undefined";
+            !!window["WeakMap"];
     } catch (ex) {
         return false;
     }

packages/clarity-js/src/core/task.ts

@@ -46,7 +46,7 @@ export async function schedule(task: TaskFunction, priority: Priority = Priority
 
     let promise = new Promise<void>((resolve: TaskResolve): void => {
         let insert = priority === Priority.High ? "unshift" : "push";
-        queuedTasks[insert]({task, resolve});
+        queuedTasks[insert]({ task, resolve });
     });
 
     // If there is no active task running, and Clarity is not in pause state,