ghtml 3.0.0 → 3.0.2

package/.github/workflows/benchmark.yml

@@ -25,7 +25,7 @@ jobs:
 
       # Install dependencies
       - name: Install dependencies
-        run: npm install --ignore-scripts
+        run: npm install
 
       # Run benchmark on PR code
       - name: Run benchmark on PR code

package/.github/workflows/npm-publish.yml

@@ -18,6 +18,8 @@ jobs:
         with:
           node-version: ^20
           registry-url: https://registry.npmjs.org
+      - run: npm install
+      - run: npm run typescript
       - run: npm publish --provenance --access public
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/npm-test.yml

@@ -22,5 +22,5 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
-      - run: npm install --ignore-scripts
+      - run: npm install
       - run: npm test

package/package.json

@@ -3,7 +3,7 @@
   "description": "Replace your template engine with fast JavaScript by leveraging the power of tagged templates.",
   "author": "Gürgün Dayıoğlu",
   "license": "MIT",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "type": "module",
   "bin": "./bin/src/index.js",
   "main": "./src/index.js",
@@ -18,7 +18,8 @@
     "benchmark": "node bench/index.js",
     "test": "npm run lint && c8 --100 node --test test/*.js",
     "lint": "eslint . && prettier --check .",
-    "lint:fix": "eslint --fix . && prettier --write ."
+    "lint:fix": "eslint --fix . && prettier --write .",
+    "typescript": "tsc src/*.js --allowJs --declaration --emitDeclarationOnly"
   },
   "dependencies": {
     "glob": "^10.4.5"
@@ -27,7 +28,8 @@
     "@fastify/pre-commit": "^2.1.0",
     "c8": "^10.1.2",
     "grules": "^0.23.0",
-    "tinybench": "^2.8.0"
+    "tinybench": "^2.8.0",
+    "typescript": ">=5.5.4"
   },
   "repository": {
     "type": "git",

package/src/html.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @param {{ raw: Readonly<string[]> }} literals Tagged template literals.
+ * @param {...any} expressions Expressions to interpolate.
+ * @returns {string} The HTML string.
+ */
+export function html({ raw: literals }: {
+    raw: Readonly<string[]>;
+}, ...expressions: any[]): string;
+/**
+ * @param {{ raw: Readonly<string[]> }} literals Tagged template literals.
+ * @param {...any} expressions Expressions to interpolate.
+ * @yields {string} The HTML strings.
+ */
+export function htmlGenerator({ raw: literals }: {
+    raw: Readonly<string[]>;
+}, ...expressions: any[]): {};
+/**
+ * @param {{ raw: Readonly<string[]> }} literals Tagged template literals.
+ * @param {...any} expressions Expressions to interpolate.
+ * @yields {string} The HTML strings.
+ */
+export function htmlAsyncGenerator({ raw: literals }: {
+    raw: Readonly<string[]>;
+}, ...expressions: any[]): {};

package/src/html.js

@@ -39,7 +39,7 @@ const escapeFunction = (string) => {
 };
 
 /**
- * @param {{ raw: string[] }} literals Tagged template literals.
+ * @param {{ raw: Readonly<string[]> }} literals Tagged template literals.
  * @param {...any} expressions Expressions to interpolate.
  * @returns {string} The HTML string.
  */
@@ -72,7 +72,7 @@ const html = ({ raw: literals }, ...expressions) => {
 };
 
 /**
- * @param {{ raw: string[] }} literals Tagged template literals.
+ * @param {{ raw: Readonly<string[]> }} literals Tagged template literals.
  * @param {...any} expressions Expressions to interpolate.
  * @yields {string} The HTML strings.
  */
@@ -166,7 +166,7 @@ const htmlGenerator = function* ({ raw: literals }, ...expressions) {
 };
 
 /**
- * @param {{ raw: string[] }} literals Tagged template literals.
+ * @param {{ raw: Readonly<string[]> }} literals Tagged template literals.
  * @param {...any} expressions Expressions to interpolate.
  * @yields {string} The HTML strings.
  */

package/src/includeFile.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @param {string} path The path to the file to render.
+ * @returns {string} The cached content of the file.
+ */
+export function includeFile(path: string): string;

package/src/index.d.ts

@@ -0,0 +1 @@
+export { html, htmlGenerator, htmlAsyncGenerator } from "./html.js";