static-dir-list 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,122 @@
+# static-dir-list
+
+A Node.js library and CLI tool that generates static HTML directory listings for a given folder. It recursively scans directories and creates `index.html` files for easy browsing without requiring any server-side logic.
+
+## Live Demo
+
+You can see an example of the generated output here:
+
+https://hugo-olabi.github.io/static-dir-list/
+
+## Features
+
+* Recursive directory traversal
+* Static HTML output (no JavaScript required in the browser)
+* Supports custom output directory
+* Ignore files support (similar to `.gitignore`)
+* Configurable root path for generated links
+* Simple CLI and programmatic API
+
+## Installation
+
+```bash
+npm install static-dir-list
+```
+
+## Usage
+
+### CLI
+
+Basic usage:
+
+```bash
+npx static-dir-list <source-dir> [output-dir]
+```
+
+* `<source-dir>`: Directory to scan and generate listings from (required)
+* `[output-dir]`: Directory where the HTML files will be written (defaults to `source-dir`)
+
+### Options
+
+#### Ignore files
+
+You can provide one or more ignore files:
+
+```bash
+npx static-dir-list ./public/files -if .gitignore -if .staticignore
+```
+
+or
+
+```bash
+npx static-dir-list ./public/files --ignore-file .gitignore
+```
+
+Each ignore file should contain patterns (one per line). Empty lines and lines starting with `#` are ignored.
+
+#### Root path
+
+Set a custom root path for generated links:
+
+```bash
+npx static-dir-list ./public/files -root /files/
+```
+
+This is useful when your files are served from a subpath.
+
+### Examples
+
+Generate listings in-place:
+
+```bash
+npx static-dir-list ./public/files
+```
+
+Generate listings into a separate directory:
+
+```bash
+npx static-dir-list ./public/files ./dist/files
+```
+
+Use ignore file and custom root:
+
+```bash
+npx static-dir-list ./public/files ./dist/files -if .gitignore -root /files/
+```
+
+## Library Usage
+
+You can also use it programmatically:
+
+```ts
+import { generateStaticListing } from 'static-dir-list';
+
+await generateStaticListing(
+  './public/files',     // source directory
+  './dist/files',       // output directory
+  ['node_modules'],     // optional ignore list
+  '/files/'             // optional root path
+);
+```
+
+### API
+
+```ts
+generateStaticListing(
+  sourceDir: string,
+  outputDir: string,
+  ignoreList?: string[],
+  rootLocation?: string
+): Promise<{ filesListed: number; dirsListed: number }>
+```
+
+## Behavior
+
+* Generates an `index.html` file inside each directory
+* Preserves directory structure in the output directory
+* If no ignore list is provided, all files are included
+* Ignore patterns are applied before traversal
+
+## License
+
+MIT

package/dist/chunk-ZH66Q66Y.js

@@ -0,0 +1,210 @@
+// src/index.ts
+import fs from "fs";
+import path from "path";
+import ignore from "ignore";
+
+// src/static.ts
+var style = `<style>
+    body { font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif; padding: 20px; color: #333; line-height: 1.5; background-color: #fff; }
+    h1 { font-size: 1.5rem; border-bottom: 1px solid #eee; padding-bottom: 0.75rem; margin-bottom: 1.5rem; }
+    table { width: 100%; border-collapse: collapse; }
+    th, td { text-align: left; padding: 0.75rem; border-bottom: 1px solid #f0f0f0; }
+    th { background: #fafafa; font-weight: 600; font-size: 0.875rem; text-transform: uppercase; letter-spacing: 0.05em; color: #666; cursor: pointer; user-select: none; position: relative; }
+    th:hover { background: #f0f0f0; }
+    th.sort-asc::after { content: ' \u2191'; position: absolute; }
+    th.sort-desc::after { content: ' \u2193'; position: absolute; }
+    .detailsColumn { text-align: right; color: #888; font-size: 0.875rem; font-variant-numeric: tabular-nums; }
+    .icon { text-decoration: none; color: #2563eb; font-weight: 500; }
+    .icon:hover { text-decoration: underline; color: #1d4ed8; }
+    .dir::before { content: "\u{1F4C1} "; margin-right: 0.5rem; }
+    .file::before { content: "\u{1F4C4} "; margin-right: 0.5rem; }
+    .up::before { content: "\u2B06\uFE0F "; margin-right: 0.5rem; }
+    #parentDirLinkBox { margin-bottom: 1rem; }
+    
+    @media (prefers-color-scheme: dark) {
+      body { background-color: #121212; color: #e0e0e0; }
+      h1 { border-bottom-color: #333; }
+      th { background: #1e1e1e; color: #aaa; border-bottom-color: #333; }
+      th:hover { background: #2a2a2a; }
+      td { border-bottom-color: #222; }
+      .detailsColumn { color: #999; }
+      .icon { color: #60a5fa; }
+      .icon:hover { color: #93c5fd; }
+    }
+
+    @media (max-width: 640px) {
+      .detailsColumn { display: none; }
+    }
+  </style>`;
+var script = ` <script>
+    function sortTable(n) {
+      const table = document.getElementById("tbody");
+      const headers = document.querySelectorAll("th");
+      let rows = Array.from(table.rows);
+      let dir = headers[n].getAttribute("data-dir") === "asc" ? "desc" : "asc";
+      
+      // Reset headers
+      headers.forEach(h => {
+        h.classList.remove("sort-asc", "sort-desc");
+        h.removeAttribute("data-dir");
+      });
+      
+      headers[n].classList.add(dir === "asc" ? "sort-asc" : "sort-desc");
+      headers[n].setAttribute("data-dir", dir);
+
+      rows.sort((a, b) => {
+        const aIsDir = a.getAttribute("data-is-dir") === "true";
+        const bIsDir = b.getAttribute("data-is-dir") === "true";
+
+        if (aIsDir && !bIsDir) return -1;
+        if (!aIsDir && bIsDir) return 1;
+
+        let x = a.cells[n].getAttribute("data-value");
+        let y = b.cells[n].getAttribute("data-value");
+        
+        if (n > 0) { // Size or Date (numeric)
+          x = parseFloat(x);
+          y = parseFloat(y);
+        } else { // Name (string)
+          x = x.toLowerCase();
+          y = y.toLowerCase();
+        }
+
+        if (x < y) return dir === "asc" ? -1 : 1;
+        if (x > y) return dir === "asc" ? 1 : -1;
+        return 0;
+      });
+
+      rows.forEach(row => table.appendChild(row));
+    }
+  </script>`;
+
+// src/html.ts
+var head = (title) => `<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>${title}</title>
+  ${style}
+</head>`;
+var body = (title, parentLink, rows) => `
+<body>
+  <h1 id="header">${title}</h1>
+
+  ${parentLink ? `
+  <div id="parentDirLinkBox">
+    <a id="parentDirLink" class="icon up" href="${parentLink}">
+      <span id="parentDirText">[parent directory]</span>
+    </a>
+  </div>` : ""}
+
+  <table>
+    <thead>
+      <tr class="header" id="theader">
+        <th onclick="sortTable(0)">Name</th>
+        <th onclick="sortTable(1)" class="detailsColumn">Size</th>
+        <th onclick="sortTable(2)" class="detailsColumn">Date Modified</th>
+      </tr>
+    </thead>
+    <tbody id="tbody">
+      ${rows}
+    </tbody>
+  </table>
+
+ ${script}
+</body>`;
+
+// src/index.ts
+function formatSize(bytes) {
+  if (bytes === 0) return "";
+  const units = ["B", "kB", "MB", "GB", "TB"];
+  const i = Math.floor(Math.log(bytes) / Math.log(1024));
+  return `${(bytes / Math.pow(1024, i)).toFixed(2)} ${units[i]}`.replace(/\.00\s/, " ");
+}
+function generateRowHtml(file) {
+  const iconClass = file.isDir ? "dir" : "file";
+  const href = file.isDir ? `${file.name}/` : file.name;
+  const value = file.isDir ? `${file.name}/` : file.name;
+  return `<tr data-is-dir="${file.isDir}">
+  <td data-value="${value}"><a class="icon ${iconClass}" href="${href}">${value}</a></td>
+  <td class="detailsColumn" data-value="${file.size}">${file.sizeStr}</td>
+  <td class="detailsColumn" data-value="${file.mtime}">${file.mtimeStr}</td>
+</tr>`;
+}
+function generateHtml(rootLocation, files, relativePath) {
+  const title = `Index of ${"/" + relativePath || "/"}`;
+  const parentPath = relativePath ? path.dirname(relativePath) : null;
+  const parentLink = parentPath === "." ? rootLocation : parentPath ? `${rootLocation}${parentPath}/` : null;
+  const rows = files.map(generateRowHtml).join("");
+  return `
+<!DOCTYPE html>
+<html lang="en">
+${head(title)}
+
+${body(title, parentLink, rows)}
+
+</html>`;
+}
+async function generateStaticListing(baseDir, outputDir, ignoreList, rootLocation = "/") {
+  const absoluteBaseDir = path.isAbsolute(baseDir) ? baseDir : path.resolve(process.cwd(), baseDir);
+  const absoluteOutputDir = path.isAbsolute(outputDir) ? outputDir : path.resolve(process.cwd(), outputDir);
+  var filesListed = 0;
+  var dirsListed = 0;
+  if (!fs.existsSync(absoluteBaseDir)) {
+    throw new Error(`Source directory not found: ${absoluteBaseDir}`);
+  }
+  const ig = ignoreList ? ignore().add(ignoreList) : null;
+  const traverse = (currentDir, relativePath) => {
+    const items = fs.readdirSync(currentDir);
+    const filesInfo = [];
+    for (const item of items) {
+      const fullPath = path.join(currentDir, item);
+      const itemRelativePath = path.join(relativePath, item);
+      if (ig && ig.ignores(itemRelativePath)) {
+        continue;
+      }
+      const stats = fs.statSync(fullPath);
+      const isDir = stats.isDirectory();
+      filesInfo.push({
+        name: item,
+        isDir,
+        size: isDir ? 0 : stats.size,
+        sizeStr: isDir ? "" : formatSize(stats.size),
+        mtime: stats.mtimeMs,
+        mtimeStr: stats.mtime.toLocaleString()
+      });
+      if (isDir) {
+        dirsListed++;
+        traverse(fullPath, itemRelativePath);
+      } else {
+        filesListed++;
+        const targetFilePath = path.join(absoluteOutputDir, itemRelativePath);
+        const targetFileDir = path.dirname(targetFilePath);
+        if (!fs.existsSync(targetFileDir)) {
+          fs.mkdirSync(targetFileDir, { recursive: true });
+        }
+        fs.copyFileSync(fullPath, targetFilePath);
+      }
+    }
+    const html = generateHtml(rootLocation, filesInfo.sort((a, b) => {
+      if (a.isDir && !b.isDir) return -1;
+      if (!a.isDir && b.isDir) return 1;
+      return a.name.localeCompare(b.name);
+    }), relativePath);
+    const targetDir = path.join(absoluteOutputDir, relativePath);
+    if (!fs.existsSync(targetDir)) {
+      fs.mkdirSync(targetDir, { recursive: true });
+    }
+    const outputFilePath = path.join(targetDir, "index.html");
+    fs.writeFileSync(outputFilePath, html, "utf8");
+    console.log(`Generated: ${outputFilePath} (${filesInfo.length} items)`);
+  };
+  traverse(absoluteBaseDir, "");
+  return {
+    filesListed,
+    dirsListed
+  };
+}
+
+export {
+  generateStaticListing
+};

package/dist/cli.cjs

@@ -0,0 +1,349 @@
+#!/usr/bin/env node
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+
+// src/index.ts
+var import_node_fs = __toESM(require("fs"), 1);
+var import_node_path = __toESM(require("path"), 1);
+var import_ignore = __toESM(require("ignore"), 1);
+
+// src/static.ts
+var style = `<style>
+    body { font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif; padding: 20px; color: #333; line-height: 1.5; background-color: #fff; }
+    h1 { font-size: 1.5rem; border-bottom: 1px solid #eee; padding-bottom: 0.75rem; margin-bottom: 1.5rem; }
+    table { width: 100%; border-collapse: collapse; }
+    th, td { text-align: left; padding: 0.75rem; border-bottom: 1px solid #f0f0f0; }
+    th { background: #fafafa; font-weight: 600; font-size: 0.875rem; text-transform: uppercase; letter-spacing: 0.05em; color: #666; cursor: pointer; user-select: none; position: relative; }
+    th:hover { background: #f0f0f0; }
+    th.sort-asc::after { content: ' \u2191'; position: absolute; }
+    th.sort-desc::after { content: ' \u2193'; position: absolute; }
+    .detailsColumn { text-align: right; color: #888; font-size: 0.875rem; font-variant-numeric: tabular-nums; }
+    .icon { text-decoration: none; color: #2563eb; font-weight: 500; }
+    .icon:hover { text-decoration: underline; color: #1d4ed8; }
+    .dir::before { content: "\u{1F4C1} "; margin-right: 0.5rem; }
+    .file::before { content: "\u{1F4C4} "; margin-right: 0.5rem; }
+    .up::before { content: "\u2B06\uFE0F "; margin-right: 0.5rem; }
+    #parentDirLinkBox { margin-bottom: 1rem; }
+    
+    @media (prefers-color-scheme: dark) {
+      body { background-color: #121212; color: #e0e0e0; }
+      h1 { border-bottom-color: #333; }
+      th { background: #1e1e1e; color: #aaa; border-bottom-color: #333; }
+      th:hover { background: #2a2a2a; }
+      td { border-bottom-color: #222; }
+      .detailsColumn { color: #999; }
+      .icon { color: #60a5fa; }
+      .icon:hover { color: #93c5fd; }
+    }
+
+    @media (max-width: 640px) {
+      .detailsColumn { display: none; }
+    }
+  </style>`;
+var script = ` <script>
+    function sortTable(n) {
+      const table = document.getElementById("tbody");
+      const headers = document.querySelectorAll("th");
+      let rows = Array.from(table.rows);
+      let dir = headers[n].getAttribute("data-dir") === "asc" ? "desc" : "asc";
+      
+      // Reset headers
+      headers.forEach(h => {
+        h.classList.remove("sort-asc", "sort-desc");
+        h.removeAttribute("data-dir");
+      });
+      
+      headers[n].classList.add(dir === "asc" ? "sort-asc" : "sort-desc");
+      headers[n].setAttribute("data-dir", dir);
+
+      rows.sort((a, b) => {
+        const aIsDir = a.getAttribute("data-is-dir") === "true";
+        const bIsDir = b.getAttribute("data-is-dir") === "true";
+
+        if (aIsDir && !bIsDir) return -1;
+        if (!aIsDir && bIsDir) return 1;
+
+        let x = a.cells[n].getAttribute("data-value");
+        let y = b.cells[n].getAttribute("data-value");
+        
+        if (n > 0) { // Size or Date (numeric)
+          x = parseFloat(x);
+          y = parseFloat(y);
+        } else { // Name (string)
+          x = x.toLowerCase();
+          y = y.toLowerCase();
+        }
+
+        if (x < y) return dir === "asc" ? -1 : 1;
+        if (x > y) return dir === "asc" ? 1 : -1;
+        return 0;
+      });
+
+      rows.forEach(row => table.appendChild(row));
+    }
+  </script>`;
+
+// src/html.ts
+var head = (title) => `<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>${title}</title>
+  ${style}
+</head>`;
+var body = (title, parentLink, rows) => `
+<body>
+  <h1 id="header">${title}</h1>
+
+  ${parentLink ? `
+  <div id="parentDirLinkBox">
+    <a id="parentDirLink" class="icon up" href="${parentLink}">
+      <span id="parentDirText">[parent directory]</span>
+    </a>
+  </div>` : ""}
+
+  <table>
+    <thead>
+      <tr class="header" id="theader">
+        <th onclick="sortTable(0)">Name</th>
+        <th onclick="sortTable(1)" class="detailsColumn">Size</th>
+        <th onclick="sortTable(2)" class="detailsColumn">Date Modified</th>
+      </tr>
+    </thead>
+    <tbody id="tbody">
+      ${rows}
+    </tbody>
+  </table>
+
+ ${script}
+</body>`;
+
+// src/index.ts
+function formatSize(bytes) {
+  if (bytes === 0) return "";
+  const units = ["B", "kB", "MB", "GB", "TB"];
+  const i = Math.floor(Math.log(bytes) / Math.log(1024));
+  return `${(bytes / Math.pow(1024, i)).toFixed(2)} ${units[i]}`.replace(/\.00\s/, " ");
+}
+function generateRowHtml(file) {
+  const iconClass = file.isDir ? "dir" : "file";
+  const href = file.isDir ? `${file.name}/` : file.name;
+  const value = file.isDir ? `${file.name}/` : file.name;
+  return `<tr data-is-dir="${file.isDir}">
+  <td data-value="${value}"><a class="icon ${iconClass}" href="${href}">${value}</a></td>
+  <td class="detailsColumn" data-value="${file.size}">${file.sizeStr}</td>
+  <td class="detailsColumn" data-value="${file.mtime}">${file.mtimeStr}</td>
+</tr>`;
+}
+function generateHtml(rootLocation2, files, relativePath) {
+  const title = `Index of ${"/" + relativePath || "/"}`;
+  const parentPath = relativePath ? import_node_path.default.dirname(relativePath) : null;
+  const parentLink = parentPath === "." ? rootLocation2 : parentPath ? `${rootLocation2}${parentPath}/` : null;
+  const rows = files.map(generateRowHtml).join("");
+  return `
+<!DOCTYPE html>
+<html lang="en">
+${head(title)}
+
+${body(title, parentLink, rows)}
+
+</html>`;
+}
+async function generateStaticListing(baseDir, outputDir2, ignoreList2, rootLocation2 = "/") {
+  const absoluteBaseDir = import_node_path.default.isAbsolute(baseDir) ? baseDir : import_node_path.default.resolve(process.cwd(), baseDir);
+  const absoluteOutputDir = import_node_path.default.isAbsolute(outputDir2) ? outputDir2 : import_node_path.default.resolve(process.cwd(), outputDir2);
+  var filesListed = 0;
+  var dirsListed = 0;
+  if (!import_node_fs.default.existsSync(absoluteBaseDir)) {
+    throw new Error(`Source directory not found: ${absoluteBaseDir}`);
+  }
+  const ig = ignoreList2 ? (0, import_ignore.default)().add(ignoreList2) : null;
+  const traverse = (currentDir, relativePath) => {
+    const items = import_node_fs.default.readdirSync(currentDir);
+    const filesInfo = [];
+    for (const item of items) {
+      const fullPath = import_node_path.default.join(currentDir, item);
+      const itemRelativePath = import_node_path.default.join(relativePath, item);
+      if (ig && ig.ignores(itemRelativePath)) {
+        continue;
+      }
+      const stats = import_node_fs.default.statSync(fullPath);
+      const isDir = stats.isDirectory();
+      filesInfo.push({
+        name: item,
+        isDir,
+        size: isDir ? 0 : stats.size,
+        sizeStr: isDir ? "" : formatSize(stats.size),
+        mtime: stats.mtimeMs,
+        mtimeStr: stats.mtime.toLocaleString()
+      });
+      if (isDir) {
+        dirsListed++;
+        traverse(fullPath, itemRelativePath);
+      } else {
+        filesListed++;
+        const targetFilePath = import_node_path.default.join(absoluteOutputDir, itemRelativePath);
+        const targetFileDir = import_node_path.default.dirname(targetFilePath);
+        if (!import_node_fs.default.existsSync(targetFileDir)) {
+          import_node_fs.default.mkdirSync(targetFileDir, { recursive: true });
+        }
+        import_node_fs.default.copyFileSync(fullPath, targetFilePath);
+      }
+    }
+    const html = generateHtml(rootLocation2, filesInfo.sort((a, b) => {
+      if (a.isDir && !b.isDir) return -1;
+      if (!a.isDir && b.isDir) return 1;
+      return a.name.localeCompare(b.name);
+    }), relativePath);
+    const targetDir = import_node_path.default.join(absoluteOutputDir, relativePath);
+    if (!import_node_fs.default.existsSync(targetDir)) {
+      import_node_fs.default.mkdirSync(targetDir, { recursive: true });
+    }
+    const outputFilePath = import_node_path.default.join(targetDir, "index.html");
+    import_node_fs.default.writeFileSync(outputFilePath, html, "utf8");
+    console.log(`Generated: ${outputFilePath} (${filesInfo.length} items)`);
+  };
+  traverse(absoluteBaseDir, "");
+  return {
+    filesListed,
+    dirsListed
+  };
+}
+
+// src/cli.ts
+var import_node_fs2 = __toESM(require("fs"), 1);
+var import_node_path2 = __toESM(require("path"), 1);
+var import_meta = {};
+var color = {
+  reset: "\x1B[0m",
+  bold: "\x1B[1m",
+  red: "\x1B[31m",
+  yellow: "\x1B[33m",
+  green: "\x1B[32m",
+  cyan: "\x1B[36m"
+};
+function printHelp() {
+  console.log(`
+${color.bold}static-dir-list${color.reset}
+
+Generate static HTML directory listings for a folder.
+
+${color.bold}Usage:${color.reset}
+  static-dir-list <source-dir> [output-dir] [options]
+
+${color.bold}Arguments:${color.reset}
+  <source-dir>        Directory to scan (required)
+  [output-dir]        Directory to write output (default: source-dir)
+
+${color.bold}Options:${color.reset}
+  -if, --ignore-file <file>   Path to ignore file (can be used multiple times)
+  -root <path>                Root path for generated links (default: /)
+  -h, --help                  Show this help message
+  -v, --version               Show CLI version
+
+${color.bold}Examples:${color.reset}
+  static-dir-list ./public/files
+  static-dir-list ./public/files ./dist/files
+  static-dir-list ./public/files -if .gitignore
+  static-dir-list ./public/files ./dist -if .gitignore -root /files/
+
+${color.bold}Notes:${color.reset}
+  - Ignore files use one pattern per line
+  - Empty lines and lines starting with "#" are ignored
+  - Multiple ignore files are merged
+`);
+}
+function printVersion() {
+  try {
+    const pkgPath = new URL("../package.json", import_meta.url);
+    const pkg = JSON.parse(import_node_fs2.default.readFileSync(pkgPath, "utf8"));
+    console.log(`static-dir-list v${pkg.version}`);
+  } catch {
+    console.log("static-dir-list (version unknown)");
+  }
+}
+var args = process.argv.slice(2);
+if (args.length === 0 || args.includes("-h") || args.includes("--help")) {
+  printHelp();
+  process.exit(0);
+}
+if (args.includes("-v") || args.includes("--version")) {
+  printVersion();
+  process.exit(0);
+}
+var sourceDir = "";
+var outputDir = "";
+var rootLocation = "/";
+var ignoreFiles = [];
+var ignoreList = [];
+for (let i = 0; i < args.length; i++) {
+  if (args[i] === "-if" || args[i] === "--ignore-file") {
+    if (i + 1 < args.length) {
+      ignoreFiles.push(args[++i]);
+    }
+  } else if (args[i] === "-root") {
+    if (i + 1 < args.length) {
+      rootLocation = args[++i];
+    }
+  } else if (!sourceDir) {
+    sourceDir = args[i];
+  } else if (!outputDir) {
+    outputDir = args[i];
+  }
+}
+if (!sourceDir) {
+  console.error(`${color.red}Error:${color.reset} Missing <source-dir>
+`);
+  printHelp();
+  process.exit(1);
+}
+if (!outputDir) {
+  outputDir = sourceDir;
+}
+for (const file of ignoreFiles) {
+  const absolutePath = import_node_path2.default.resolve(process.cwd(), file);
+  if (import_node_fs2.default.existsSync(absolutePath)) {
+    const content = import_node_fs2.default.readFileSync(absolutePath, "utf8");
+    ignoreList.push(
+      ...content.split(/\r?\n/).filter((line) => line.trim() !== "" && !line.startsWith("#"))
+    );
+  } else {
+    console.warn(
+      `${color.yellow}Warning:${color.reset} Ignore file not found: ${absolutePath}`
+    );
+  }
+}
+generateStaticListing(
+  sourceDir,
+  outputDir,
+  ignoreList.length > 0 ? ignoreList : void 0,
+  rootLocation
+).then(({ filesListed, dirsListed }) => {
+  console.log(
+    `${color.green}Done:${color.reset} Generated ${color.cyan}${filesListed}${color.reset} files and ${color.cyan}${dirsListed}${color.reset} directories.`
+  );
+}).catch((err) => {
+  console.error(`${color.red}Error:${color.reset} Failed to generate listings`);
+  console.error(err);
+  process.exit(1);
+});

package/dist/cli.d.cts

@@ -0,0 +1 @@
+#!/usr/bin/env node

package/dist/cli.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node

package/dist/cli.js

@@ -0,0 +1,121 @@
+#!/usr/bin/env node
+import {
+  generateStaticListing
+} from "./chunk-ZH66Q66Y.js";
+
+// src/cli.ts
+import fs from "fs";
+import path from "path";
+var color = {
+  reset: "\x1B[0m",
+  bold: "\x1B[1m",
+  red: "\x1B[31m",
+  yellow: "\x1B[33m",
+  green: "\x1B[32m",
+  cyan: "\x1B[36m"
+};
+function printHelp() {
+  console.log(`
+${color.bold}static-dir-list${color.reset}
+
+Generate static HTML directory listings for a folder.
+
+${color.bold}Usage:${color.reset}
+  static-dir-list <source-dir> [output-dir] [options]
+
+${color.bold}Arguments:${color.reset}
+  <source-dir>        Directory to scan (required)
+  [output-dir]        Directory to write output (default: source-dir)
+
+${color.bold}Options:${color.reset}
+  -if, --ignore-file <file>   Path to ignore file (can be used multiple times)
+  -root <path>                Root path for generated links (default: /)
+  -h, --help                  Show this help message
+  -v, --version               Show CLI version
+
+${color.bold}Examples:${color.reset}
+  static-dir-list ./public/files
+  static-dir-list ./public/files ./dist/files
+  static-dir-list ./public/files -if .gitignore
+  static-dir-list ./public/files ./dist -if .gitignore -root /files/
+
+${color.bold}Notes:${color.reset}
+  - Ignore files use one pattern per line
+  - Empty lines and lines starting with "#" are ignored
+  - Multiple ignore files are merged
+`);
+}
+function printVersion() {
+  try {
+    const pkgPath = new URL("../package.json", import.meta.url);
+    const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf8"));
+    console.log(`static-dir-list v${pkg.version}`);
+  } catch {
+    console.log("static-dir-list (version unknown)");
+  }
+}
+var args = process.argv.slice(2);
+if (args.length === 0 || args.includes("-h") || args.includes("--help")) {
+  printHelp();
+  process.exit(0);
+}
+if (args.includes("-v") || args.includes("--version")) {
+  printVersion();
+  process.exit(0);
+}
+var sourceDir = "";
+var outputDir = "";
+var rootLocation = "/";
+var ignoreFiles = [];
+var ignoreList = [];
+for (let i = 0; i < args.length; i++) {
+  if (args[i] === "-if" || args[i] === "--ignore-file") {
+    if (i + 1 < args.length) {
+      ignoreFiles.push(args[++i]);
+    }
+  } else if (args[i] === "-root") {
+    if (i + 1 < args.length) {
+      rootLocation = args[++i];
+    }
+  } else if (!sourceDir) {
+    sourceDir = args[i];
+  } else if (!outputDir) {
+    outputDir = args[i];
+  }
+}
+if (!sourceDir) {
+  console.error(`${color.red}Error:${color.reset} Missing <source-dir>
+`);
+  printHelp();
+  process.exit(1);
+}
+if (!outputDir) {
+  outputDir = sourceDir;
+}
+for (const file of ignoreFiles) {
+  const absolutePath = path.resolve(process.cwd(), file);
+  if (fs.existsSync(absolutePath)) {
+    const content = fs.readFileSync(absolutePath, "utf8");
+    ignoreList.push(
+      ...content.split(/\r?\n/).filter((line) => line.trim() !== "" && !line.startsWith("#"))
+    );
+  } else {
+    console.warn(
+      `${color.yellow}Warning:${color.reset} Ignore file not found: ${absolutePath}`
+    );
+  }
+}
+generateStaticListing(
+  sourceDir,
+  outputDir,
+  ignoreList.length > 0 ? ignoreList : void 0,
+  rootLocation
+).then(({ filesListed, dirsListed }) => {
+  console.log(
+    `${color.green}Done:${color.reset} Generated ${color.cyan}${filesListed}${color.reset} files and ${color.cyan}${dirsListed}${color.reset} directories.`
+  );
+}).catch((err) => {
+  console.error(`${color.red}Error:${color.reset} Failed to generate listings`);
+  console.error(err);
+  process.exit(1);
+});

package/dist/index.cjs

@@ -0,0 +1,244 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  generateStaticListing: () => generateStaticListing
+});
+module.exports = __toCommonJS(index_exports);
+var import_node_fs = __toESM(require("fs"), 1);
+var import_node_path = __toESM(require("path"), 1);
+var import_ignore = __toESM(require("ignore"), 1);
+
+// src/static.ts
+var style = `<style>
+    body { font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif; padding: 20px; color: #333; line-height: 1.5; background-color: #fff; }
+    h1 { font-size: 1.5rem; border-bottom: 1px solid #eee; padding-bottom: 0.75rem; margin-bottom: 1.5rem; }
+    table { width: 100%; border-collapse: collapse; }
+    th, td { text-align: left; padding: 0.75rem; border-bottom: 1px solid #f0f0f0; }
+    th { background: #fafafa; font-weight: 600; font-size: 0.875rem; text-transform: uppercase; letter-spacing: 0.05em; color: #666; cursor: pointer; user-select: none; position: relative; }
+    th:hover { background: #f0f0f0; }
+    th.sort-asc::after { content: ' \u2191'; position: absolute; }
+    th.sort-desc::after { content: ' \u2193'; position: absolute; }
+    .detailsColumn { text-align: right; color: #888; font-size: 0.875rem; font-variant-numeric: tabular-nums; }
+    .icon { text-decoration: none; color: #2563eb; font-weight: 500; }
+    .icon:hover { text-decoration: underline; color: #1d4ed8; }
+    .dir::before { content: "\u{1F4C1} "; margin-right: 0.5rem; }
+    .file::before { content: "\u{1F4C4} "; margin-right: 0.5rem; }
+    .up::before { content: "\u2B06\uFE0F "; margin-right: 0.5rem; }
+    #parentDirLinkBox { margin-bottom: 1rem; }
+    
+    @media (prefers-color-scheme: dark) {
+      body { background-color: #121212; color: #e0e0e0; }
+      h1 { border-bottom-color: #333; }
+      th { background: #1e1e1e; color: #aaa; border-bottom-color: #333; }
+      th:hover { background: #2a2a2a; }
+      td { border-bottom-color: #222; }
+      .detailsColumn { color: #999; }
+      .icon { color: #60a5fa; }
+      .icon:hover { color: #93c5fd; }
+    }
+
+    @media (max-width: 640px) {
+      .detailsColumn { display: none; }
+    }
+  </style>`;
+var script = ` <script>
+    function sortTable(n) {
+      const table = document.getElementById("tbody");
+      const headers = document.querySelectorAll("th");
+      let rows = Array.from(table.rows);
+      let dir = headers[n].getAttribute("data-dir") === "asc" ? "desc" : "asc";
+      
+      // Reset headers
+      headers.forEach(h => {
+        h.classList.remove("sort-asc", "sort-desc");
+        h.removeAttribute("data-dir");
+      });
+      
+      headers[n].classList.add(dir === "asc" ? "sort-asc" : "sort-desc");
+      headers[n].setAttribute("data-dir", dir);
+
+      rows.sort((a, b) => {
+        const aIsDir = a.getAttribute("data-is-dir") === "true";
+        const bIsDir = b.getAttribute("data-is-dir") === "true";
+
+        if (aIsDir && !bIsDir) return -1;
+        if (!aIsDir && bIsDir) return 1;
+
+        let x = a.cells[n].getAttribute("data-value");
+        let y = b.cells[n].getAttribute("data-value");
+        
+        if (n > 0) { // Size or Date (numeric)
+          x = parseFloat(x);
+          y = parseFloat(y);
+        } else { // Name (string)
+          x = x.toLowerCase();
+          y = y.toLowerCase();
+        }
+
+        if (x < y) return dir === "asc" ? -1 : 1;
+        if (x > y) return dir === "asc" ? 1 : -1;
+        return 0;
+      });
+
+      rows.forEach(row => table.appendChild(row));
+    }
+  </script>`;
+
+// src/html.ts
+var head = (title) => `<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>${title}</title>
+  ${style}
+</head>`;
+var body = (title, parentLink, rows) => `
+<body>
+  <h1 id="header">${title}</h1>
+
+  ${parentLink ? `
+  <div id="parentDirLinkBox">
+    <a id="parentDirLink" class="icon up" href="${parentLink}">
+      <span id="parentDirText">[parent directory]</span>
+    </a>
+  </div>` : ""}
+
+  <table>
+    <thead>
+      <tr class="header" id="theader">
+        <th onclick="sortTable(0)">Name</th>
+        <th onclick="sortTable(1)" class="detailsColumn">Size</th>
+        <th onclick="sortTable(2)" class="detailsColumn">Date Modified</th>
+      </tr>
+    </thead>
+    <tbody id="tbody">
+      ${rows}
+    </tbody>
+  </table>
+
+ ${script}
+</body>`;
+
+// src/index.ts
+function formatSize(bytes) {
+  if (bytes === 0) return "";
+  const units = ["B", "kB", "MB", "GB", "TB"];
+  const i = Math.floor(Math.log(bytes) / Math.log(1024));
+  return `${(bytes / Math.pow(1024, i)).toFixed(2)} ${units[i]}`.replace(/\.00\s/, " ");
+}
+function generateRowHtml(file) {
+  const iconClass = file.isDir ? "dir" : "file";
+  const href = file.isDir ? `${file.name}/` : file.name;
+  const value = file.isDir ? `${file.name}/` : file.name;
+  return `<tr data-is-dir="${file.isDir}">
+  <td data-value="${value}"><a class="icon ${iconClass}" href="${href}">${value}</a></td>
+  <td class="detailsColumn" data-value="${file.size}">${file.sizeStr}</td>
+  <td class="detailsColumn" data-value="${file.mtime}">${file.mtimeStr}</td>
+</tr>`;
+}
+function generateHtml(rootLocation, files, relativePath) {
+  const title = `Index of ${"/" + relativePath || "/"}`;
+  const parentPath = relativePath ? import_node_path.default.dirname(relativePath) : null;
+  const parentLink = parentPath === "." ? rootLocation : parentPath ? `${rootLocation}${parentPath}/` : null;
+  const rows = files.map(generateRowHtml).join("");
+  return `
+<!DOCTYPE html>
+<html lang="en">
+${head(title)}
+
+${body(title, parentLink, rows)}
+
+</html>`;
+}
+async function generateStaticListing(baseDir, outputDir, ignoreList, rootLocation = "/") {
+  const absoluteBaseDir = import_node_path.default.isAbsolute(baseDir) ? baseDir : import_node_path.default.resolve(process.cwd(), baseDir);
+  const absoluteOutputDir = import_node_path.default.isAbsolute(outputDir) ? outputDir : import_node_path.default.resolve(process.cwd(), outputDir);
+  var filesListed = 0;
+  var dirsListed = 0;
+  if (!import_node_fs.default.existsSync(absoluteBaseDir)) {
+    throw new Error(`Source directory not found: ${absoluteBaseDir}`);
+  }
+  const ig = ignoreList ? (0, import_ignore.default)().add(ignoreList) : null;
+  const traverse = (currentDir, relativePath) => {
+    const items = import_node_fs.default.readdirSync(currentDir);
+    const filesInfo = [];
+    for (const item of items) {
+      const fullPath = import_node_path.default.join(currentDir, item);
+      const itemRelativePath = import_node_path.default.join(relativePath, item);
+      if (ig && ig.ignores(itemRelativePath)) {
+        continue;
+      }
+      const stats = import_node_fs.default.statSync(fullPath);
+      const isDir = stats.isDirectory();
+      filesInfo.push({
+        name: item,
+        isDir,
+        size: isDir ? 0 : stats.size,
+        sizeStr: isDir ? "" : formatSize(stats.size),
+        mtime: stats.mtimeMs,
+        mtimeStr: stats.mtime.toLocaleString()
+      });
+      if (isDir) {
+        dirsListed++;
+        traverse(fullPath, itemRelativePath);
+      } else {
+        filesListed++;
+        const targetFilePath = import_node_path.default.join(absoluteOutputDir, itemRelativePath);
+        const targetFileDir = import_node_path.default.dirname(targetFilePath);
+        if (!import_node_fs.default.existsSync(targetFileDir)) {
+          import_node_fs.default.mkdirSync(targetFileDir, { recursive: true });
+        }
+        import_node_fs.default.copyFileSync(fullPath, targetFilePath);
+      }
+    }
+    const html = generateHtml(rootLocation, filesInfo.sort((a, b) => {
+      if (a.isDir && !b.isDir) return -1;
+      if (!a.isDir && b.isDir) return 1;
+      return a.name.localeCompare(b.name);
+    }), relativePath);
+    const targetDir = import_node_path.default.join(absoluteOutputDir, relativePath);
+    if (!import_node_fs.default.existsSync(targetDir)) {
+      import_node_fs.default.mkdirSync(targetDir, { recursive: true });
+    }
+    const outputFilePath = import_node_path.default.join(targetDir, "index.html");
+    import_node_fs.default.writeFileSync(outputFilePath, html, "utf8");
+    console.log(`Generated: ${outputFilePath} (${filesInfo.length} items)`);
+  };
+  traverse(absoluteBaseDir, "");
+  return {
+    filesListed,
+    dirsListed
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  generateStaticListing
+});

package/dist/index.d.cts

@@ -0,0 +1,22 @@
+interface FileInfo {
+    name: string;
+    isDir: boolean;
+    size: number;
+    sizeStr: string;
+    mtime: number;
+    mtimeStr: string;
+}
+/**
+ * Generates static HTML directory listings for a directory and its subdirectories.
+ *
+ * @param baseDir - The directory to scan for files (relative to project root or absolute).
+ * @param outputDir - The directory where the generated index.html files will be saved.
+ * @param ignoreList - An optional list of patterns to ignore (similar to .gitignore).
+ * @param rootLocation - The base URL path where the static files will be served from (defaults to "/").
+*/
+declare function generateStaticListing(baseDir: string, outputDir: string, ignoreList?: string[], rootLocation?: string): Promise<{
+    filesListed: number;
+    dirsListed: number;
+}>;
+
+export { type FileInfo, generateStaticListing };

package/dist/index.d.ts

@@ -0,0 +1,22 @@
+interface FileInfo {
+    name: string;
+    isDir: boolean;
+    size: number;
+    sizeStr: string;
+    mtime: number;
+    mtimeStr: string;
+}
+/**
+ * Generates static HTML directory listings for a directory and its subdirectories.
+ *
+ * @param baseDir - The directory to scan for files (relative to project root or absolute).
+ * @param outputDir - The directory where the generated index.html files will be saved.
+ * @param ignoreList - An optional list of patterns to ignore (similar to .gitignore).
+ * @param rootLocation - The base URL path where the static files will be served from (defaults to "/").
+*/
+declare function generateStaticListing(baseDir: string, outputDir: string, ignoreList?: string[], rootLocation?: string): Promise<{
+    filesListed: number;
+    dirsListed: number;
+}>;
+
+export { type FileInfo, generateStaticListing };

package/dist/index.js

@@ -0,0 +1,6 @@
+import {
+  generateStaticListing
+} from "./chunk-ZH66Q66Y.js";
+export {
+  generateStaticListing
+};

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "static-dir-list",
+  "version": "1.0.0",
+  "description": "A Node.js library and CLI tool that generates static HTML directory listings for a specified directory.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hugo-olabi/static-dir-list.git"
+  },
+  "homepage": "https://hugo-olabi.github.io/static-dir-list/",
+  "bugs": {
+    "url": "https://github.com/hugo-olabi/static-dir-list/issues"
+  },
+  "keywords": [
+    "directory listing",
+    "static html",
+    "file browser",
+    "cli",
+    "nodejs",
+    "static site",
+    "index generator"
+  ],
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "static-dir-list": "dist/cli.js"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts src/cli.ts --format cjs,esm --dts --clean && chmod +x dist/cli.js",
+    "lint": "tsc --noEmit",
+    "clean": "rm -rf dist"
+  },
+  "devDependencies": {
+    "@types/node": "^22.14.0",
+    "tsup": "^8.5.1",
+    "typescript": "~5.8.2"
+  },
+  "dependencies": {
+    "ignore": "^7.0.5"
+  }
+}