🤖 Merge PR DefinitelyTyped#74119 Add karma-html2js-preprocessor types by @niksy

Author: niksy

types/karma-html2js-preprocessor/.npmignore

@@ -0,0 +1,5 @@
+*
+!**/*.d.ts
+!**/*.d.cts
+!**/*.d.mts
+!**/*.d.*.ts

types/karma-html2js-preprocessor/index.d.ts

@@ -0,0 +1,40 @@
+import "karma";
+
+declare module "karma" {
+    interface ConfigOptions {
+        /**
+         * see {@link https://github.com/karma-runner/karma-html2js-preprocessor#configuration}
+         */
+        html2JsPreprocessor?: HTML2JSPreprocessorOptions | undefined;
+    }
+
+    interface HTML2JSPreprocessorOptions {
+        /**
+         * Strip this from the file path
+         *
+         * @default ''
+         */
+        stripPrefix?: string | undefined;
+
+        /**
+         * Prepend this to the file path
+         *
+         * @default ''
+         */
+        prependPrefix?: string | undefined;
+
+        /**
+         * Define a custom transform function
+         */
+        processPath?: (filePath: string) => string;
+    }
+}
+
+declare global {
+    interface Window {
+        /**
+         * Collection of HTML files converted into JS strings by karma-html2js-preprocessor.
+         */
+        __html__: Record<string, string>;
+    }
+}

types/karma-html2js-preprocessor/karma-html2js-preprocessor-tests.ts

@@ -0,0 +1,24 @@
+import karma = require("karma");
+
+// Mocha reporter options tests
+const mochaReporter: karma.HTML2JSPreprocessorOptions = {
+    stripPrefix: "strip",
+    prependPrefix: "prepend",
+    processPath: (filePath) => filePath,
+};
+
+module.exports = (config: karma.Config) => {
+    config.set({
+        preprocessors: {
+            "**/*.json": ["json"],
+        },
+        files: ["**/*.js", "**/*.json"],
+        html2JsPreprocessor: {
+            stripPrefix: "strip",
+            prependPrefix: "$json",
+            processPath: (filePath) => filePath,
+        },
+    });
+};
+
+window.__html__["fixture"];

types/karma-html2js-preprocessor/package.json

@@ -0,0 +1,20 @@
+{
+    "private": true,
+    "name": "@types/karma-html2js-preprocessor",
+    "version": "1.1.9999",
+    "projects": [
+        "https://github.com/karma-runner/karma-html2js-preprocessor#readme"
+    ],
+    "dependencies": {
+        "@types/karma": "*"
+    },
+    "devDependencies": {
+        "@types/karma-html2js-preprocessor": "workspace:."
+    },
+    "owners": [
+        {
+            "name": "Ivan Nikolić",
+            "githubUsername": "niksy"
+        }
+    ]
+}

types/karma-html2js-preprocessor/tsconfig.json

@@ -0,0 +1,20 @@
+{
+    "compilerOptions": {
+        "module": "node16",
+        "lib": [
+            "es6",
+            "dom"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "karma-html2js-preprocessor-tests.ts"
+    ]
+}