@zipadee/dev-server 0.0.18

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2024 Justin Fagnani
+
+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,45 @@
+# @zipadee/dev-server
+
+A simple dev-server CLI.
+
+## Overview
+
+zpd is a web development server built with Zipadee. It serves JavaScript files
+and rewrites npm-style module specifiers to be browser-compatible by resolving them to
+on-disk paths.
+
+## Usage
+
+```
+zpd [options]
+```
+
+Options:
+
+- `--port`, `-p` The port to listen on. (default: 8080)
+- `--root`, `-r` Root directory to serve files from. (default: Current working directory)
+- `--base`, `-b` Base directory to resolve paths and imports from, as a relative path
+  from the root directory. (default: '')
+- `--css-modules` Whether to transform CSS modules to JavaScript.
+
+  If true, CSS imports - imports with a `type: 'css'` import attribute - will be transformed to remove the `type: 'css'` attribute and add a `?type=css--module` query parameter to the URL.
+  
+  Requests for these URLs will be served as JavaScript modules that export the CSS as a CSSStyleSheet object. (default: false)
+- `--help`          Show the help message (default: false)
+
+zpd serves files from the specified root directory (default: cwd).
+
+Absolute paths and JavaScript module specifiers are resolved relative to the
+base directory if set, otherwise to the root directory. If a module specifier
+resolves to a path outside of the base directory, it is rewritten to be relative
+to the root directory by prefixing it with the a special root path prefix.
+
+Example:
+
+If you have a monorepo with packages at `packages/foo` and `packages/bar`
+and you want to serve content from the package `foo`, you should set the root
+to the monorepo root and base to `packages/foo`.
+
+`import 'bar'` from within the `foo` package will be rewritten to `import
+'/__root__/packages/bar/index.js'`, and the server will serve the file from
+`packages/bar/index.js`.

package/bin/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export declare const run: () => Promise<void>;
+//# sourceMappingURL=cli.d.ts.map

package/bin/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/bin/cli.ts"],"names":[],"mappings":";AA+HA,eAAO,MAAM,GAAG,qBAiBf,CAAC"}

package/bin/cli.js

@@ -0,0 +1,117 @@
+#!/usr/bin/env node
+import { startServer } from '../index.js';
+import { parseArgs, } from 'node:util';
+import dedent from 'dedent';
+const parseArgsConfig = {
+    options: {
+        port: {
+            type: 'string',
+            short: 'p',
+            help: 'The port to listen on.',
+            default: '8080',
+        },
+        root: {
+            type: 'string',
+            short: 'r',
+            default: process.cwd(),
+            help: 'Root directory to serve files from.',
+            defaultDescription: 'Current working directory',
+        },
+        base: {
+            type: 'string',
+            short: 'b',
+            help: dedent `
+        Base directory to resolve paths and imports from, as a relative path
+        from the root directory.`,
+            default: '',
+            defaultDescription: "''",
+        },
+        ['css-modules']: {
+            type: 'boolean',
+            help: dedent `
+        Whether to transform CSS modules to JavaScript. If true, CSS imports -
+        imports with a \`type: 'css'\` import attribute - will be transformed to
+        remove the \`type: 'css'\` attribute and add a \`?type=css--module\` query
+        parameter to the URL. Requests for these URLs will be served as JavaScript
+        modules that export the CSS as a CSSStyleSheet object.`,
+            default: false,
+        },
+        help: {
+            type: 'boolean',
+            default: false,
+            help: 'Show this help message',
+        },
+    },
+};
+const generateHelp = (config) => {
+    return dedent `
+    zpd - Zipadee Dev Server
+
+    Usage: zpd [options]
+
+    Options:
+      ${Object.entries(config.options)
+        .map(([key, descriptor]) => {
+        const { help } = descriptor;
+        const args = getArgs(key, descriptor);
+        const helpText = help + getDefault(descriptor);
+        const indent = ' '.repeat(16 - args.length);
+        const helpLines = helpText.split('\n');
+        return `${args}${indent}${helpLines.join(`\n${' '.repeat(22)}`)}`;
+    })
+        .join('\n      ')}
+
+    zpd is a web development server built with Zipadee. It serves JavaScript
+    files and rewrites module specifiers to be browser-compatible by resolving
+    them to on-disk paths.
+    
+    zpd serves files from the specified root directory (default: cwd).
+
+    Absolute paths and JavaScript module specifiers are resolved relative to
+    the base directory if set, otherwise to the root directory. If a module
+    specifier resolves to a path outside of the base directory, it is rewritten
+    to be relative to the root directory by prefixing it with the a special root
+    path prefix.
+
+    Example:
+    
+    If you have a monorepo with packages at \`packages/foo\` and \`packages/bar\`
+    and you want to serve content from the package \`foo\`, you should set the
+    root to the monorepo root and base to \`packages/foo\`.
+    
+    An import \`bar\` from within the \`foo\` package will be rewritten to
+    \`import '/__root__/packages/bar/index.js'\`, and the server will serve
+    the file from \`packages/bar/index.js\`.
+  `;
+};
+const getArgs = (key, descriptor) => {
+    let result = `--${key}`;
+    if (descriptor.short) {
+        result += `, -${descriptor.short}`;
+    }
+    return result;
+};
+const getDefault = (descriptor) => {
+    const defaultValue = descriptor.defaultDescription ?? descriptor.default;
+    if (defaultValue === undefined) {
+        return '';
+    }
+    return ` (default: ${defaultValue})`;
+};
+export const run = async () => {
+    const args = parseArgs(parseArgsConfig);
+    if (args.values.help) {
+        console.log(generateHelp(parseArgsConfig));
+        return;
+    }
+    const port = parseInt(args.values.port);
+    console.log('css-modules:', args.values['css-modules']);
+    await startServer({
+        port,
+        rootDir: args.values.root,
+        baseDir: args.values.base,
+        cssModules: args.values['css-modules'],
+    });
+};
+await run();
+//# sourceMappingURL=cli.js.map

package/bin/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/bin/cli.ts"],"names":[],"mappings":";AAEA,OAAO,EAAC,WAAW,EAAC,MAAM,aAAa,CAAC;AACxC,OAAO,EACL,SAAS,GAGV,MAAM,WAAW,CAAC;AAEnB,OAAO,MAAM,MAAM,QAAQ,CAAC;AAe5B,MAAM,eAAe,GAAG;IACtB,OAAO,EAAE;QACP,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,IAAI,EAAE,wBAAwB;YAC9B,OAAO,EAAE,MAAM;SAChB;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,OAAO,CAAC,GAAG,EAAE;YACtB,IAAI,EAAE,qCAAqC;YAC3C,kBAAkB,EAAE,2BAA2B;SAChD;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,IAAI,EAAE,MAAM,CAAA;;iCAEe;YAC3B,OAAO,EAAE,EAAE;YACX,kBAAkB,EAAE,IAAI;SACzB;QACD,CAAC,aAAa,CAAC,EAAE;YACf,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,MAAM,CAAA;;;;;+DAK6C;YACzD,OAAO,EAAE,KAAK;SACf;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;YACd,IAAI,EAAE,wBAAwB;SAC/B;KACF;CACyC,CAAC;AAE7C,MAAM,YAAY,GAAG,CAAC,MAA+B,EAAE,EAAE;IACvD,OAAO,MAAM,CAAA;;;;;;QAMP,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC;SAC7B,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,UAAU,CAAC,EAAE,EAAE;QACzB,MAAM,EAAC,IAAI,EAAC,GAAG,UAAU,CAAC;QAC1B,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG,IAAI,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC;QAC/C,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5C,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACvC,OAAO,GAAG,IAAI,GAAG,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;IACpE,CAAC,CAAC;SACD,IAAI,CAAC,UAAU,CAAC;;;;;;;;;;;;;;;;;;;;;;;GAuBtB,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,OAAO,GAAG,CACd,GAAW,EACX,UAA6C,EAC7C,EAAE;IACF,IAAI,MAAM,GAAG,KAAK,GAAG,EAAE,CAAC;IACxB,IAAI,UAAU,CAAC,KAAK,EAAE,CAAC;QACrB,MAAM,IAAI,MAAM,UAAU,CAAC,KAAK,EAAE,CAAC;IACrC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,UAA6C,EAAE,EAAE;IACnE,MAAM,YAAY,GAAG,UAAU,CAAC,kBAAkB,IAAI,UAAU,CAAC,OAAO,CAAC;IACzE,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,OAAO,cAAc,YAAY,GAAG,CAAC;AACvC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,GAAG,GAAG,KAAK,IAAI,EAAE;IAC5B,MAAM,IAAI,GAAG,SAAS,CAAC,eAAe,CAAC,CAAC;IAExC,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QACrB,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC;QAC3C,OAAO;IACT,CAAC;IACD,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAExC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC;IAExD,MAAM,WAAW,CAAC;QAChB,IAAI;QACJ,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI;QACzB,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI;QACzB,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC;KACvC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,GAAG,EAAE,CAAC"}

package/index.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Options for the Zipadee dev server.
+ */
+export interface Options {
+    /**
+     * The port to listen on.
+     */
+    port: number;
+    /**
+     * The root directory to serve files from. The dev server will not serve files
+     * outside this directory.
+     */
+    rootDir: string;
+    /**
+     * The base directory to serve from, as a relative path from the root
+     * directory. Absolute paths will be resolved relative to this directory.
+     *
+     * If a JavaScript modules specifier resolves to outside of this directory, it
+     * will be rewritten to be relative to the root directory.
+     */
+    baseDir?: string;
+    /**
+     * Whether to transform CSS modules to JavaScript. If true, CSS imports -
+     * imports with a `type: 'css'` import attribute - will be transformed to
+     * remove the `type: 'css'` attribute and add a `?type=css--module` query
+     * parameter to the URL. Requests for these URLs will be served as JavaScript
+     * modules that export the CSS as a CSSStyleSheet object.
+     */
+    cssModules?: boolean;
+}
+/**
+ * Starts the Zipadee dev server.
+ */
+export declare const startServer: ({ port, rootDir, baseDir, cssModules, }: Options) => Promise<void>;
+//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,eAAO,MAAM,WAAW,GAAU,yCAK/B,OAAO,kBAoBT,CAAC"}

package/index.js

@@ -0,0 +1,23 @@
+import { App } from '@zipadee/core';
+import { serve as serveJs } from '@zipadee/javascript';
+import { serve } from '@zipadee/static';
+import path from 'node:path';
+/**
+ * Starts the Zipadee dev server.
+ */
+export const startServer = async ({ port, rootDir, baseDir, cssModules, }) => {
+    const app = new App();
+    app.use(serveJs({
+        root: rootDir,
+        base: baseDir,
+        conditions: ['browser', 'development', 'import'],
+        cssModules,
+    }));
+    const resolvedBaseDir = path.resolve(rootDir, baseDir ?? '');
+    app.use(serve(resolvedBaseDir, { index: 'index.html' }));
+    await app.listen(port);
+    console.log(`Zipadee dev server is running on port ${port}`);
+    console.log(`Serving files from ${resolvedBaseDir}`);
+    console.log(`Press Ctrl+C to stop the server.`);
+};
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,GAAG,EAAC,MAAM,eAAe,CAAC;AAClC,OAAO,EAAC,KAAK,IAAI,OAAO,EAAC,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAC,KAAK,EAAC,MAAM,iBAAiB,CAAC;AACtC,OAAO,IAAI,MAAM,WAAW,CAAC;AAoC7B;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,KAAK,EAAE,EAChC,IAAI,EACJ,OAAO,EACP,OAAO,EACP,UAAU,GACF,EAAE,EAAE;IACZ,MAAM,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC;IAEtB,GAAG,CAAC,GAAG,CACL,OAAO,CAAC;QACN,IAAI,EAAE,OAAO;QACb,IAAI,EAAE,OAAO;QACb,UAAU,EAAE,CAAC,SAAS,EAAE,aAAa,EAAE,QAAQ,CAAC;QAChD,UAAU;KACX,CAAC,CACH,CAAC;IAEF,MAAM,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC;IAC7D,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,eAAe,EAAE,EAAC,KAAK,EAAE,YAAY,EAAC,CAAC,CAAC,CAAC;IAEvD,MAAM,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAEvB,OAAO,CAAC,GAAG,CAAC,yCAAyC,IAAI,EAAE,CAAC,CAAC;IAC7D,OAAO,CAAC,GAAG,CAAC,sBAAsB,eAAe,EAAE,CAAC,CAAC;IACrD,OAAO,CAAC,GAAG,CAAC,kCAAkC,CAAC,CAAC;AAClD,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@zipadee/dev-server",
+  "description": "A lightweight development server for modern web apps.",
+  "version": "0.0.18",
+  "type": "module",
+  "main": "index.js",
+  "scripts": {
+    "build": "wireit",
+    "test": "wireit",
+    "start": "wireit"
+  },
+  "keywords": [],
+  "author": "",
+  "homepage": "https://github.com/justinfagnani/zipadee#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/justinfagnani/zipadee.git",
+    "directory": "packages/dev-server"
+  },
+  "license": "MIT",
+  "bin": {
+    "zpd": "./bin/cli.js"
+  },
+  "files": [
+    "/index.{d.ts.map,d.ts,js.map,js}",
+    "/bin/"
+  ],
+  "wireit": {
+    "build": {
+      "command": "tsc",
+      "dependencies": [
+        "../core:build",
+        "../cors:build",
+        "../javascript:build",
+        "../router:build",
+        "../static:build"
+      ],
+      "files": [
+        "src/**/*.ts",
+        "tsconfig.json"
+      ],
+      "output": [
+        "index.{js,js.map,d.ts,d.ts.map}",
+        ".tsbuildinfo",
+        "lib"
+      ],
+      "clean": "if-file-deleted"
+    },
+    "test": {
+      "command": "node --enable-source-maps --test --test-reporter=spec \"test/**/*_test.js\"",
+      "dependencies": [
+        "build"
+      ],
+      "files": []
+    },
+    "start": {
+      "command": "node --enable-source-maps index.js",
+      "dependencies": [
+        "build"
+      ]
+    }
+  },
+  "dependencies": {
+    "@zipadee/core": "^0.0.17",
+    "@zipadee/cors": "^0.0.17",
+    "@zipadee/javascript": "^0.0.17",
+    "@zipadee/router": "^0.0.17",
+    "@zipadee/static": "^0.0.17"
+  },
+  "devDependencies": {
+    "@types/node": "^22.15.17",
+    "dedent": "^1.6.0"
+  }
+}