test(browser): jsdoc, better config build function

Author: nobkd

packages/nuejs/test/README.md

@@ -7,10 +7,10 @@ This directory contains tests for the Nue.js using [domino](https://github.com/f
 You can run the tests using Bun's built-in test runner:
 
 ```bash
-# From the nuejs package directory
-cd nue/packages/nuejs
+# Go to nuejs package directory
+cd packages/nuejs
 
-# Run all tests
+# Run all nuejs tests
 bun test
 
 # Or, run a specific test suite
@@ -21,25 +21,28 @@ bun test test/test-clicks
 
 Each test has its own directory (with a name starting with `test-`) with the following files:
 
-1. `component.dhtml` - Contains one or more `.dhtml` Nue.js components
-2. `<test-name>.test.js` - The actual test file that imports the components and tests them
-3. `index.html` - An HTML file that can be used to render the components in a browser
+1. `component.dhtml` — Contains one or more `.dhtml` Nue.js components
+2. `<test-name>.test.js` — The actual test file that imports the components and tests them
+3. `index.html` — An HTML file that can be used to render the components in a browser
 
 ## Adding New Tests
 
 To add a new test:
 
-1. Create a new directory for your test (e.g., `test-my-feature/`)
+1. Create a new directory for your test (e.g. `test-my-feature/`)
 2. Create a `component.dhtml` file with one or more component definitions
-3. Create an `my-feature.test.js` file that imports and tests the components
+3. Create a `my-feature.test.js` file that imports and tests the components
 4. Create an `index.html` file to render the components in a browser
 
 ## Test Utilities
 
 The `test-utils.js` file provides utilities to make testing easier:
 
+- `mkConfigBase(import.meta.url)`: Creates a function to build a config for the current test directory
+  - Returns: `(componentName, data) => ({ testPath: currentDir, componentName, data })` where data is optional
+
 - `mountTestComponent({ testName, componentName, data })`: Mounts a specific component from a test directory
-  - `testName`: Name of the test directory
+  - `testPath`: Path to the test directory
   - `componentName`: Name of the component to mount
   - `data`: Optional data object to initialize the component with
   - Returns: `{ app, cleanup }` where `app` is the mounted component instance and `cleanup` is a function to clean up the test environment

packages/nuejs/test/test-utils.js

@@ -6,25 +6,39 @@ import { createWindow } from 'domino'
 
 import { parse } from '../src/compile.js'
 
-/* Use like `getDirname(import.meta.url)` */
+
+/**
+ * Get directory from url
+ * @param {Url} url - Pass `import.meta.url`
+ * @returns {string} Directory path containing the current file
+ */
 export function getDirname(url) {
   return dirname(fileURLToPath(url))
 }
 
+/**
+ * Get directory path from url and return function for usage with {@linkcode mountTestComponent}
+ * @param {Url} url - `import.meta.url` to get the test directory
+ */
 export function mkConfigBase(url) {
-  return componentName => ({ testName: getDirname(url), componentName })
+  /**
+   * @param {string} componentName
+   * @param {Object?} data
+   */
+  return (componentName, data) => ({ testPath: getDirname(url), componentName, data })
 }
 
+
 /**
  * Mounts a component from a test directory
  * @param {Object} options - Mount options
- * @param {string} options.testName - The name of the test directory
+ * @param {string} options.testPath - The path to the test directory
  * @param {string} options.componentName - Name of the specific component to mount
  * @param {Object} [options.data={}] - Data to initialize the component with
  */
-export async function mountTestComponent({ testName, componentName, data = {} }) {
+export async function mountTestComponent({ testPath, componentName, data = {} }) {
   // Validate inputs
-  if (!testName || !componentName) throw new Error('Required parameters missing: "testName" and "componentName" must be provided')
+  if (!testPath || !componentName) throw new Error('Required parameters missing: "testPath" and "componentName" must be provided')
 
   // Setup domino DOM environment
   const window = createWindow('<!DOCTYPE html><html><body></body></html>')
@@ -38,7 +52,7 @@ export async function mountTestComponent({ testName, componentName, data = {} })
 
   try {
     // Load and parse component
-    const dhtmlPath = join(testName, 'component.dhtml')
+    const dhtmlPath = join(testPath, 'component.dhtml')
     const source = readFileSync(dhtmlPath, 'utf-8')
     const components = parseComponents(source)
 
@@ -66,6 +80,7 @@ export async function mountTestComponent({ testName, componentName, data = {} })
   }
 }
 
+
 /**
  * Parses component source and returns an array of component objects
  * @param {string} source - The component source code