kempo-server 1.9.1 → 1.9.2

package/README.md

@@ -215,10 +215,12 @@ Kempo Server can be customized with a simple JSON configuration file to control
 
 For detailed configuration options and examples, see **[CONFIG.md](./CONFIG.md)**.
 
+**Important:** The config file must be placed **inside the server root directory** (the `--root` folder). All paths in the config (like `customRoutes`) are resolved relative to the config file location.
+
 Quick start:
 ```bash
-# Create a basic config file
-echo '{"cache": {"enabled": true}}' > .config.json
+# Create a config file INSIDE the server root
+echo '{"cache": {"enabled": true}}' > public/.config.json
 
 # Use different configs for different environments
 kempo-server --root public --config dev.config.json

package/docs/configuration.html

@@ -15,6 +15,9 @@
     <p>Customize Kempo Server's behavior with a simple JSON configuration file.</p>
 
     <h2>Configuration File</h2>
+    <div class="callout warning">
+      <strong>Important:</strong> The configuration file must be placed <strong>inside the server root directory</strong> (the folder specified by <code>--root</code>). For example, if you run <code>kempo-server --root public</code>, your config file should be at <code>public/.config.json</code> or <code>public/dev.config.json</code>, not in the project root.
+    </div>
     <p>To configure the server, create a configuration file (by default <code>.config.json</code>) within the root directory of your server (<code>public</code> in the start example). You can specify a different configuration file using the <code>--config</code> flag:</p>
     <pre><code class="hljs bash"># Use default .config.json<br />kempo-server --root public<br /><br /># Use custom config file<br />kempo-server --root public --config staging.config.json<br /><br /># Use absolute path<br />kempo-server --root public --config /etc/kempo/production.config.json</code></pre>
     <p>This json file can have any of the following properties. Any property not defined will use the default configuration.</p>
@@ -64,6 +67,14 @@
     <h3 id="customRoutes">customRoutes</h3>
     <p>An object mapping custom route paths to file paths. Useful for aliasing or serving files from outside the document root.</p>
     
+    <div class="callout info">
+      <strong>Path Resolution:</strong> All paths in <code>customRoutes</code> are resolved <strong>relative to the config file's location</strong> (which is the server root). To reference files outside the server root (like <code>node_modules</code> or a <code>src</code> folder), use <code>../</code> to navigate up to the project root.
+    </div>
+    
+    <div class="callout info">
+      <strong>Route Priority:</strong> Custom routes take priority over files that exist in the directory structure. If you have both <code>public/dist/app.js</code> and a custom route <code>"/dist/**": "../src/**"</code>, the custom route will be used and the file will be served from <code>src/</code>.
+    </div>
+    
     <h4>Basic Routes</h4>
     <p>Map specific paths to files:</p>
     <pre><code class="hljs json">{<br />  <span class="hljs-attr">"customRoutes"</span>: {<br />    <span class="hljs-attr">"/vendor/bootstrap.css"</span>: <span class="hljs-string">"./node_modules/bootstrap/dist/css/bootstrap.min.css"</span>,<br />    <span class="hljs-attr">"/api/status"</span>: <span class="hljs-string">"./status.js"</span>,<br />    <span class="hljs-attr">"/health"</span>: <span class="hljs-string">"./health-check.js"</span><br />  }<br />}</code></pre>
@@ -79,7 +90,32 @@
       <li><code>docs/readme.md</code> would serve <code>./documentation/readme.md</code></li>
       <li><code>lib/utils.js</code> would serve <code>./node_modules/my-library/build/utils.js</code></li>
     </ul>
-    <p>The <code>*</code> wildcard matches any single path segment (anything between <code>/</code> characters). Multiple wildcards can be used in a single route pattern.</p>
+    <h4>Wildcard Syntax</h4>
+    <ul>
+      <li><code>*</code> - Matches a single path segment (anything between <code>/</code> characters)</li>
+      <li><code>**</code> - Matches recursively (any depth of subdirectories)</li>
+    </ul>
+    <p>Use <code>**</code> when you want to redirect an entire directory tree. Multiple wildcards can be used in a single route pattern.</p>
+    
+    <h4>Common Use Case: Dev vs Production Builds</h4>
+    <p>A common pattern is to serve source files during development but built/minified files in production. Given this project structure:</p>
+    <pre><code class="hljs">project/
+├── src/                    # Source files
+│   └── app.js
+├── node_modules/
+├── public/                 # Server root (--root public)
+│   ├── dev.config.json     # Config lives HERE (inside server root)
+│   ├── dist/               # Built files
+│   │   └── app.js
+│   └── index.html</code></pre>
+    <p>Your <code>dev.config.json</code> can redirect <code>/dist/**</code> requests to serve from <code>src/</code> instead:</p>
+    <pre><code class="hljs json">{
+  "customRoutes": {
+    "/dist/**": "../src/**",
+    "/kempo-ui/**": "../node_modules/kempo-ui/**"
+  }
+}</code></pre>
+    <p>Now requests to <code>/dist/app.js</code> will serve <code>../src/app.js</code> (the unminified source), while production uses the actual <code>dist/</code> files.</p>
 
     <h3 id="maxRescanAttempts">maxRescanAttempts</h3>
     <p>The maximum number of times to attempt rescanning the file system when a file is not found. Defaults to 3.</p>

package/docs/index.html

@@ -6,9 +6,12 @@
   <meta name='viewport' content='width=device-width, initial-scale=1'>
   <link rel="icon" type="image/png" sizes="48x48" href="./media/icon48.png">
   <link rel="manifest" href="./manifest.json" />
-  <link rel="stylesheet" href="./kempo.min.css" />
+  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/kempo-css@1.3.2/dist/kempo.min.css" />
+  <link rel="stylesheet" href="./theme.css" />
+  <script>window.litDisableBundleWarning = true;</script>
 </head>
 <body>
+  <k-import src="./nav.inc.html"></k-import>
   <main>
     <h1 class="ta-center">Kempo Server</h1>
     <div class="ta-center">
@@ -80,5 +83,6 @@ npx kempo-server --root public</code></pre>
     </div>
   </main>
   <div style="height:25vh"></div>
+  <script type="module" src="https://cdn.jsdelivr.net/npm/kempo-ui@0.0.42/dist/components/Import.js"></script>
 </body>
 </html>

package/docs/nav.inc.html

@@ -0,0 +1,41 @@
+<nav
+  class="d-f bg-primary fixed"
+>
+  <button
+    id="toggleNavSideMenu"
+    class="link"
+  >
+    <k-icon name="menu"></k-icon>
+  </button>
+  <a
+    href="./"
+    class="d-if ph"
+    style="align-items: center"
+  >
+    <img src="./media/icon32.png" alt="Kempo Server Icon" class="pr" />
+    Kempo Server
+  </a>
+  <div class="flex"></div>
+  <a href="https://github.com/dustinpoissant/kempo-ui?tab=License-1-ov-file#creative-commons-attribution-noncommercial-sharealike-20" target="_blank"><k-icon name="license"></k-icont></a>
+  <a href="https://github.com/dustinpoissant/kempo-ui" target="_blank"><k-icon name="github-mark"></k-icont></a>
+  <k-theme-switcher></k-theme-switcher>
+</nav>
+<div style="width: 100%; height: 4rem;"></div>
+<k-side-menu
+  id="navSideMenu"
+>
+  <menu>
+    <a href="./" class="ta-center bb mb r0">
+      <h1 class="tc-primary">Kempo Server</h1>
+      <img src="./media/icon128.png" alt="Kempo UI Icon" />
+    </a>
+    
+    <div class="pl mb">
+			<a href="./">Quick Start</a>
+		</div>
+  </menu>
+</k-side-menu>
+<script src="https://cdn.jsdelivr.net/npm/kempo-ui@0.0.42/dist/components/SideMenu.js" type="module"></script>
+<script src="https://cdn.jsdelivr.net/npm/kempo-ui@0.0.42/dist/components/Icon.js" type="module"></script>
+<script src="https://cdn.jsdelivr.net/npm/kempo-ui@0.0.42/dist/components/ThemeSwitcher.js" type="module"></script>
+<script src="./nav.inc.js" type="module"></script>

package/docs/nav.inc.js

@@ -0,0 +1,16 @@
+document.getElementById('toggleNavSideMenu').addEventListener('click', async () => {
+	await window.customElements.whenDefined('k-side-menu');
+	document.getElementById('navSideMenu').toggle();
+});
+document.addEventListener('click', function(e) {
+	if (e.target.matches('a[href^="#"]')) {
+		e.preventDefault();
+		const targetId = e.target.getAttribute('href').replace('#', '');
+		const target = document.getElementById(targetId);
+		if (target) {
+			target.scrollIntoView({ behavior: 'smooth' });
+			const url = window.location.pathname + window.location.search + '#' + targetId;
+			history.replaceState(null, '', url);
+		}
+	}
+});

package/docs/theme.css

@@ -0,0 +1,9 @@
+:root {
+	--c_primary: rgb(153, 51, 255);
+	--c_primary__hover: rgb(119, 17, 221);
+	--c_secondary: rgb(51, 102, 255);
+	--c_secondary__hover: rgb(17, 68, 221);
+	--tc_primary: light-dark(#93f, rgb(187, 102, 255));
+	--tc_secondary: light-dark(#36f, rgb(138, 180, 248));
+	--c_highlight: light-dark(rgba(153, 51, 255, 0.25), rgba(153, 51, 255, 0.25));
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "kempo-server",
   "type": "module",
-  "version": "1.9.1",
+  "version": "1.9.2",
   "description": "A lightweight, zero-dependency, file based routing server.",
   "main": "dist/index.js",
   "exports": {
@@ -23,15 +23,11 @@
   "author": "",
   "license": "ISC",
   "devDependencies": {
-    "essentialcss": "^2.0.1",
     "kempo-testing-framework": "^1.2.3",
     "terser": "^5.43.1"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/dustinpoissant/kempo-server"
-  },
-  "dependencies": {
-    "kempo-css": "^1.0.5"
   }
 }

package/src/defaultConfig.js

@@ -55,7 +55,6 @@ export default {
     "\\.bak$",
     "\\.sql$",
     "\\.ini$",
-    "password",
     "config\\.php$",
     "wp-config\\.php$",
     "\\.DS_Store$"

package/docs/.config.json

@@ -1,6 +0,0 @@
-{
-  "customRoutes": {
-    "/./kempo.min.css": "./node_modules/essentialcss/dist/essential.min.css",
-    "/essential-hljs.css": "./node_modules/essentialcss/dist/essential-hljs.min.css"
-  }
-}