fixed lint issues and added unit tests

Author: it-s

jest.config.js

@@ -0,0 +1,26 @@
+// jest.config.js
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+
+module.exports = {
+    preset: 'ts-jest',
+    roots: [
+        '<rootDir>'
+    ],
+    moduleDirectories: ["node_modules", "<rootDir>"],
+    modulePaths: ["<rootDir>"],
+    transform: {
+      '^.+\\.ts$': [
+        'ts-jest',
+        {
+          tsconfig: '<rootDir>/tsconfig.json',
+        },
+      ],
+    },
+    testEnvironment: "jsdom",
+    moduleFileExtensions: ['js', 'ts', 'tsx', 'd.ts'],
+    transformIgnorePatterns: ['node_modules'],
+    testMatch: ['**/*.test.ts'],
+    moduleNameMapper: {
+         "^.+\\.(css|less|scss)$": "babel-jest"
+    }
+};

package.json

@@ -43,12 +43,15 @@
     "devDependencies": {
         "@babel/core": "^7.22.11",
         "@babel/plugin-external-helpers": "^7.22.5",
-        "@babel/preset-env": "^7.22.10",
+        "@babel/preset-env": "^7.26.8",
         "@babel/preset-typescript": "^7.22.11",
         "@rollup/plugin-babel": "^5.3.1",
         "@rollup/plugin-commonjs": "^19.0.2",
         "@rollup/plugin-node-resolve": "^13.3.0",
         "@rollup/plugin-replace": "^2.4.2",
+        "@types/jest": "^29.5.14",
+        "@types/mocha": "^10.0.10",
+        "@types/node": "^22.13.4",
         "@typescript-eslint/eslint-plugin": "^5.62.0",
         "@typescript-eslint/parser": "^5.62.0",
         "eslint": "^8.48.0",
@@ -57,6 +60,9 @@
         "eslint-plugin-node": "^8.0.1",
         "eslint-plugin-promise": "^4.3.1",
         "eslint-plugin-standard": "^4.1.0",
+        "jest": "^29.7.0",
+        "jest-environment-jsdom": "^29.7.0",
+        "jsdom": "^26.0.0",
         "rollup": "^2.79.1",
         "rollup-plugin-eslint": "^5.1.0",
         "rollup-plugin-filesize": "^9.1.2",
@@ -66,15 +72,17 @@
         "rollup-plugin-sizes": "^0.4.2",
         "rollup-plugin-terser": "^7.0.2",
         "rollup-plugin-typescript2": "^0.34.1",
-        "sass": "^1.66.1"
+        "sass": "^1.66.1",
+        "ts-jest": "^29.2.5"
     },
     "commonjs": [
         "node_modules/**"
     ],
     "scripts": {
         "build": "rollup -c rollup.config.js",
         "devw": "rollup -w -c rollup.config.js",
-        "test": "npm run test --prefix ./test"
+        "test": "jest --config jest.config.js",
+        "lint": "eslint src --ext .js,.ts"
     },
     "browserslist": "> 0.25%, not dead"
 }

src/Tour.ts

@@ -1,18 +1,20 @@
 import u, { U } from "umbrellajs";
 
-import { AbstractStep, StepData } from "../@types/Step";
 import MemoryCacheManager from "./cachemanager/InMemoryCacheManager";
 import Guidedtour, {
   CacheKeys,
   KeyboardNavigationOptions,
-  StepsSource, TourOptions,
+  TourOptions,
   TourStyle,
   TourAction,
   Helpers,
   CacheManager,
   Direction,
-  TourStopState
-} from "../@types";
+  TourStopState,
+  AbstractStep,
+  StepData,
+  StepsSource,
+} from "@types";
 import { assert, clamp, getMaxZIndex, Style, Scroll, Color } from "./utils";
 import * as Utils from "./utils";
 import * as Abstracts from "./abstracts";
@@ -27,7 +29,7 @@ import CardStep from "./step/CardStep";
 import BaseStyle from "./Tour.scss";
 import { getDataContents } from "./utils/dom";
 
-const defaultKeyNavOptions: KeyboardNavigationOptions = {
+export const defaultKeyNavOptions: KeyboardNavigationOptions = {
   next: "ArrowRight",
   prev: "ArrowLeft",
   first: "Home",
@@ -36,7 +38,7 @@ const defaultKeyNavOptions: KeyboardNavigationOptions = {
   stop: "Escape",
 };
 
-const defaultStyle: TourStyle = {
+export const defaultStyle: TourStyle = {
   fontFamily: "sans-serif",
   fontSize: "14px",
 
@@ -57,7 +59,7 @@ const defaultStyle: TourStyle = {
   stepCardPadding: "5px",
 };
 
-const defaultOptions: TourOptions = {
+export const defaultOptions: TourOptions = {
   identifier: "default",
   root: "body",
   selector: "[data-tour]",

src/abstracts/CacheManager.ts

@@ -1,4 +1,4 @@
-import { CacheManager } from "../../@types";
+import { CacheManager } from "@types";
 
 export abstract class AbstractCacheManager implements CacheManager {
     constructor(identifier = "") {

src/abstracts/Step.ts

@@ -1,6 +1,6 @@
 import { Element } from "umbrellajs";
 import {GUID} from "../utils/guid";
-import Tour, { AbstractStep, StepData } from "../../@types";
+import Tour, { AbstractStep, StepData } from "@types";
 
 export abstract class Step<StepDataType = StepData> implements AbstractStep<StepDataType> {
   static Type = "default";

src/decorator/ContentDecorator.ts

@@ -1,4 +1,4 @@
-import Tour from "../../@types";
+import Tour from "@types";
 
 export interface Match {
     match: string;
@@ -62,4 +62,4 @@ export class ContentDecorator {
             return text;
         }
     }
-}
+}

src/handler/ActionHandler.ts

@@ -1,4 +1,4 @@
-import Tour, { ActionHandlerType, TourAction } from "../../@types";
+import Tour, { ActionHandlerType, TourAction } from "@types";
 
 export type ActionHandlerFn = (event: Event, action: TourAction, context: Tour) => void;
 

src/lib/snarkdown.ts

@@ -54,16 +54,17 @@ function encodeAttr(str: string): string {
  * Parse Markdown into an HTML String.
  */
 export default function parse(md: string, prevLinks?: Record<string, string>): string {
-    let tokenizer = /((?:^|\n+)(?:\n---+|\* \*(?: \*)+)\n)|(?:^``` *(\w*)\n([\s\S]*?)\n```$)|((?:(?:^|\n+)(?:\t|  {2,}).+)+\n*)|((?:(?:^|\n)([>*+-]|\d+\.)\s+.*)+)|(?:!\[([^\]]*?)\]\(([^)]+?)\))|(\[)|(\](?:\(([^)]+?)\))?)|(?:(?:^|\n+)([^\s].*)\n(-{3,}|={3,})(?:\n+|$))|(?:(?:^|\n+)(#{1,6})\s*(.+)(?:\n+|$))|(?:`([^`].*?)`)|(  \n\n*|\n{2,}|__|\*\*|[_*]|~~)/gm;
-    let context: string[] = [];
-    let out: string = '';
-    let links: Record<string, string> = prevLinks || {};
-    let last: number = 0;
+// eslint-disable-next-line no-regex-spaces
+    const tokenizer = /((?:^|\n+)(?:\n---+|\* \*(?: \*)+)\n)|(?:^``` *(\w*)\n([\s\S]*?)\n```$)|((?:(?:^|\n+)(?:\t|  {2,}).+)+\n*)|((?:(?:^|\n)([>*+-]|\d+\.)\s+.*)+)|(?:!\[([^\]]*?)\]\(([^)]+?)\))|(\[)|(\](?:\(([^)]+?)\))?)|(?:(?:^|\n+)([^\s].*)\n(-{3,}|={3,})(?:\n+|$))|(?:(?:^|\n+)(#{1,6})\s*(.+)(?:\n+|$))|(?:`([^`].*?)`)|(  \n\n*|\n{2,}|__|\*\*|[_*]|~~)/gm;
+    const context: string[] = [];
+    let out = '';
+    const links: Record<string, string> = prevLinks || {};
+    let last = 0;
     let chunk: string | null = null;
-    let prev: string = '';
+    let prev = '';
     let token: RegExpExecArray | null = null;
-    let inner: string = ''
-    let t: string = '';
+    let inner = ''
+    let t = '';
 
     function tag(token: string): string {
         const desc: string[] = TAGS[token[1] || ''];
@@ -76,7 +77,7 @@ export default function parse(md: string, prevLinks?: Record<string, string>): s
     }
 
     function flush(): string {
-        let str: string = '';
+        let str = '';
         while (context.length > 0) str += tag(context[context.length - 1]);
         return str;
     }
@@ -94,6 +95,7 @@ export default function parse(md: string, prevLinks?: Record<string, string>): s
             // escaped
         }
         // Code/Indent blocks:
+// eslint-disable-next-line no-cond-assign
         else if (t = (token[3] || token[4])) {
             chunk = '<pre class="code '
                 + (token[4]
@@ -110,6 +112,7 @@ export default function parse(md: string, prevLinks?: Record<string, string>): s
                 + '</code></pre>';
         }
         // > Quotes, -* lists:
+// eslint-disable-next-line no-cond-assign
         else if (t = token[6]) {
             if (t.match(/\./)) {
                 token[5] = token[5].replace(/^\d+/gm, '');

src/step/PopoverStep.ts

@@ -1,5 +1,5 @@
 // import scrollIntoView from "scroll-into-view";
-import Tour, { AbstractStep, StepData } from "../../@types";
+import Tour, { AbstractStep, StepData } from "@types";
 import { Element, U } from "umbrellajs";
 
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
@@ -20,7 +20,7 @@ export interface PopoverStepData extends StepData {
     navigation: boolean;
 }
 
-const popoverStepDataDefaults: PopoverStepData = {
+export const popoverStepDataDefaults: PopoverStepData = {
     layout: "vertical",
     image: "",
     title: "",

src/utils/clamp.ts

@@ -1,4 +1,4 @@
-export function clamp(value: number, min: number, max = NaN): number {
+export function clamp(value: number, min = NaN, max = NaN): number {
     min = isNaN(min) ? value : min;
     max = isNaN(max) ? value : max;
     return Math.max(min, Math.min(value, max));