@rollup-extras/plugin-serve 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Konstantin Shutkin
+
+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,140 @@
+# Plugin Serve
+
+Rollup plugin for dev server.
+
+Points:
+
+- Uses `koa`, customizable through koa middleware
+- Zero config by default (works if you have output.dir defined)
+
+Uses [`@niceties/logger`](https://github.com/kshutkin/niceties/blob/main/logger/README.md) to log messages, can be configured through `@niceties/logger` API.
+
+[Changlelog](./CHANGELOG.md)
+
+## Installation
+
+Using npm:
+```
+npm install --save-dev @rollup-extras/plugin-serve
+```
+
+## Usage
+
+```javascript
+import serve from '@rollup-extras/plugin-serve';
+
+export default {
+    input: 'src/index.js',
+
+    output: {
+        format: 'es',
+        dir: 'dest'
+    },
+
+    plugins: [serve()],
+} 
+```
+
+## Providing options
+
+Just pass options to the plugin function. Returned object is the plugin instance which can be passed to rollup.
+
+```javascript
+serve({option: value, option2: value2})
+```
+
+For additional plugin instances (in case of multiple configs) please use: `firstInstance.api.addInstance()`
+
+## Options
+
+### pluginName
+
+Optional, `string`.
+
+For debugging purposes, so many instances of a plugin can be differenciated in debugging output.
+
+### useWriteBundle
+
+Optional, `boolean`, default: `true`.
+
+Option to use `writeBundle` hook instead of `generateBundle`.
+
+### dirs
+
+Optional, `string` | `string[]`, default: `output.dir`.
+
+Defines what dir to serve using `koa-static` middleware. If you want to disable `koa-static` you can use `[]` (empty array) as `dirs`.
+
+### port
+
+Optional, `number`, default: `8080`.
+
+Port to use for server.
+
+### host
+
+Optional, `string`.
+
+Host to use, by default it does not provide host to createServer and lets nodejs to decide.
+
+### useKoaLogger
+
+Optional, `boolean`, default: `true`.
+
+If plugin should use koa-logger middleware.
+
+### koaStaticOptions
+
+Optional.
+
+Please check [`koa-static`](https://github.com/koajs/static) for options.
+
+### https
+
+Optional, `{ cert: string, key: string, ca?: string; }`.
+
+Key and certificate to use for https. Best way to generate cert and key (and to install ca) is [`mkcert`](https://github.com/FiloSottile/mkcert).
+
+### customizeKoa
+
+Optional, `(koa: Koa) => void`
+
+Extention point to customize `koa`.
+
+### onListen
+
+Optional, `(server: Server) => void | true`
+
+Extention point after server is live. Please return true to suppress default banner.
+
+## Configuration
+
+```typescript
+type ServePluginOptions = {
+    pluginName?: string;
+    useWriteBundle?: boolean;
+    dirs?: string | string[];
+    port?: number;
+    useKoaLogger?: boolean;
+    koaStaticOptions?: 'koa-static'.Options;
+    host?: string;
+    https?: {
+        cert: string;
+        key: string;
+        ca?: string;
+    },
+    customizeKoa?: (koa: Koa) => void;
+    onListen?: (server: Server) => void | true;
+} | string | string[]
+```
+
+## Prior Art
+
+- https://github.com/thgh/rollup-plugin-serve
+- https://github.com/pearofducks/rollup-plugin-dev
+- https://github.com/modernweb-dev/web/tree/master/packages/dev-server-rollup
+- https://github.com/lukeed/sirv (and any another standalone server)
+
+# License
+
+[MIT](./LICENSE)

package/dist/index.cjs

@@ -0,0 +1,103 @@
+'use strict';
+
+var http = require('http');
+var https = require('https');
+var Koa = require('koa');
+var koaLogger = require('koa-logger');
+var serveStatic = require('koa-static');
+var options = require('@rollup-extras/utils/options');
+var logger = require('@rollup-extras/utils/logger');
+var mutliConfigPluginBase = require('@rollup-extras/utils/mutli-config-plugin-base');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var Koa__default = /*#__PURE__*/_interopDefaultLegacy(Koa);
+var koaLogger__default = /*#__PURE__*/_interopDefaultLegacy(koaLogger);
+var serveStatic__default = /*#__PURE__*/_interopDefaultLegacy(serveStatic);
+var logger__default = /*#__PURE__*/_interopDefaultLegacy(logger);
+
+let globalServer;
+const factories = { logger: logger__default["default"] };
+function index (options$1 = {}) {
+    const normalizedOptions = options.getOptions(options$1, {
+        pluginName: '@rollup-extras/plugin-serve',
+        useWriteBundle: true,
+        port: 8080,
+        useKoaLogger: true
+    }, 'dirs', factories);
+    const { pluginName, useWriteBundle, port, host, https: https$1, useKoaLogger, customizeKoa, koaStaticOptions, onListen, logger } = normalizedOptions;
+    const instance = mutliConfigPluginBase.multiConfigPluginBase(useWriteBundle, pluginName, serve);
+    let { dirs } = normalizedOptions, collectDirs = false, started = false, watchMode = true;
+    const pluginInstance = Object.assign(Object.assign({}, instance), { outputOptions });
+    if (!dirs) {
+        dirs = [];
+        collectDirs = true;
+        pluginInstance.renderStart = renderStart;
+    }
+    return pluginInstance;
+    function renderStart(outputOptions, inputOptions) {
+        instance.renderStart.call(this, outputOptions, inputOptions);
+        if (collectDirs) {
+            if (outputOptions.dir) {
+                dirs.push(outputOptions.dir);
+            }
+        }
+    }
+    function outputOptions() {
+        watchMode = this.meta.watchMode;
+        return null;
+    }
+    async function serve() {
+        if (!started && watchMode) {
+            started = true;
+            if (globalServer) {
+                await new Promise(resolve => globalServer.close(resolve));
+                globalServer = undefined;
+            }
+            const app = new Koa__default["default"]();
+            if (customizeKoa) {
+                customizeKoa(app);
+            }
+            if (useKoaLogger) {
+                app.use(koaLogger__default["default"]());
+            }
+            for (const dir of dirs) {
+                app.use(serveStatic__default["default"](dir, koaStaticOptions));
+            }
+            const server = globalServer = https$1 ? https.createServer(https$1, app.callback()) : http.createServer(app.callback());
+            const listenCb = () => internalOnListen(server);
+            if (host) {
+                server.listen(port, host, listenCb);
+            }
+            else {
+                server.listen(port, listenCb);
+            }
+            server.on('error', (e) => {
+                if (e.code === 'EADDRINUSE') {
+                    logger.finish('address in use, please try another port', 3 /* error */);
+                }
+                else {
+                    throw e;
+                }
+            });
+        }
+    }
+    function internalOnListen(server) {
+        if (!onListen || !onListen(server)) {
+            logger.finish(`listening on ${linkFromAddress(server.address(), !!https$1)}`, 1 /* info */);
+        }
+    }
+}
+function linkFromAddress(address, https) {
+    if (address && typeof address !== 'string') {
+        return linkFromAddressInfo(address, https);
+    }
+    return `${address}`;
+}
+function linkFromAddressInfo({ address, port, family }, https) {
+    const serverName = family === 'IPv6' ? `[${address}]` : address;
+    const protocol = `http${https ? 's' : ''}://`;
+    return `${protocol}${serverName}:${port}`;
+}
+
+module.exports = index;

package/dist/index.d.ts

@@ -0,0 +1,34 @@
+import { NormalizedInputOptions, NormalizedOutputOptions, PluginContext } from 'rollup';
+import { ServePluginOptions } from './types';
+export default function (options?: ServePluginOptions): {
+    outputOptions: (this: PluginContext) => null;
+    buildEnd?: ((this: PluginContext, err?: Error | undefined) => void | Promise<void>) | undefined;
+    buildStart?: ((this: PluginContext, options: NormalizedInputOptions) => void | Promise<void>) | undefined;
+    closeBundle?: ((this: PluginContext) => void | Promise<void>) | undefined;
+    closeWatcher?: ((this: PluginContext) => void) | undefined;
+    load?: import("rollup").LoadHook | undefined;
+    moduleParsed?: import("rollup").ModuleParsedHook | undefined;
+    options?: ((this: import("rollup").MinimalPluginContext, options: import("rollup").InputOptions) => import("rollup").InputOptions | Promise<import("rollup").InputOptions | null | undefined> | null | undefined) | undefined;
+    resolveDynamicImport?: import("rollup").ResolveDynamicImportHook | undefined;
+    resolveId?: import("rollup").ResolveIdHook | undefined;
+    transform?: import("rollup").TransformHook | undefined;
+    watchChange?: import("rollup").WatchChangeHook | undefined;
+    augmentChunkHash?: ((this: PluginContext, chunk: import("rollup").PreRenderedChunk) => string | void) | undefined;
+    generateBundle?: ((this: PluginContext, options: NormalizedOutputOptions, bundle: import("rollup").OutputBundle, isWrite: boolean) => void | Promise<void>) | undefined;
+    renderChunk?: import("rollup").RenderChunkHook | undefined;
+    renderDynamicImport?: ((this: PluginContext, options: {
+        customResolution: string | null;
+        format: import("rollup").InternalModuleFormat;
+        moduleId: string;
+        targetModuleId: string | null;
+    }) => {
+        left: string;
+        right: string;
+    } | null | undefined) | undefined;
+    renderError?: ((this: PluginContext, err?: Error | undefined) => void | Promise<void>) | undefined;
+    renderStart?: ((this: PluginContext, outputOptions: NormalizedOutputOptions, inputOptions: NormalizedInputOptions) => void | Promise<void>) | undefined;
+    resolveAssetUrl?: import("rollup").ResolveAssetUrlHook | undefined;
+    resolveFileUrl?: import("rollup").ResolveFileUrlHook | undefined;
+    resolveImportMeta?: import("rollup").ResolveImportMetaHook | undefined;
+    writeBundle?: ((this: PluginContext, options: NormalizedOutputOptions, bundle: import("rollup").OutputBundle) => void | Promise<void>) | undefined;
+};

package/dist/index.mjs

@@ -0,0 +1,94 @@
+import { createServer as createServer$1 } from 'http';
+import { createServer } from 'https';
+import Koa from 'koa';
+import koaLogger from 'koa-logger';
+import serveStatic from 'koa-static';
+import { getOptions } from '@rollup-extras/utils/options';
+import logger from '@rollup-extras/utils/logger';
+import { multiConfigPluginBase } from '@rollup-extras/utils/mutli-config-plugin-base';
+
+let globalServer;
+const factories = { logger };
+function index (options = {}) {
+    const normalizedOptions = getOptions(options, {
+        pluginName: '@rollup-extras/plugin-serve',
+        useWriteBundle: true,
+        port: 8080,
+        useKoaLogger: true
+    }, 'dirs', factories);
+    const { pluginName, useWriteBundle, port, host, https, useKoaLogger, customizeKoa, koaStaticOptions, onListen, logger } = normalizedOptions;
+    const instance = multiConfigPluginBase(useWriteBundle, pluginName, serve);
+    let { dirs } = normalizedOptions, collectDirs = false, started = false, watchMode = true;
+    const pluginInstance = Object.assign(Object.assign({}, instance), { outputOptions });
+    if (!dirs) {
+        dirs = [];
+        collectDirs = true;
+        pluginInstance.renderStart = renderStart;
+    }
+    return pluginInstance;
+    function renderStart(outputOptions, inputOptions) {
+        instance.renderStart.call(this, outputOptions, inputOptions);
+        if (collectDirs) {
+            if (outputOptions.dir) {
+                dirs.push(outputOptions.dir);
+            }
+        }
+    }
+    function outputOptions() {
+        watchMode = this.meta.watchMode;
+        return null;
+    }
+    async function serve() {
+        if (!started && watchMode) {
+            started = true;
+            if (globalServer) {
+                await new Promise(resolve => globalServer.close(resolve));
+                globalServer = undefined;
+            }
+            const app = new Koa();
+            if (customizeKoa) {
+                customizeKoa(app);
+            }
+            if (useKoaLogger) {
+                app.use(koaLogger());
+            }
+            for (const dir of dirs) {
+                app.use(serveStatic(dir, koaStaticOptions));
+            }
+            const server = globalServer = https ? createServer(https, app.callback()) : createServer$1(app.callback());
+            const listenCb = () => internalOnListen(server);
+            if (host) {
+                server.listen(port, host, listenCb);
+            }
+            else {
+                server.listen(port, listenCb);
+            }
+            server.on('error', (e) => {
+                if (e.code === 'EADDRINUSE') {
+                    logger.finish('address in use, please try another port', 3 /* error */);
+                }
+                else {
+                    throw e;
+                }
+            });
+        }
+    }
+    function internalOnListen(server) {
+        if (!onListen || !onListen(server)) {
+            logger.finish(`listening on ${linkFromAddress(server.address(), !!https)}`, 1 /* info */);
+        }
+    }
+}
+function linkFromAddress(address, https) {
+    if (address && typeof address !== 'string') {
+        return linkFromAddressInfo(address, https);
+    }
+    return `${address}`;
+}
+function linkFromAddressInfo({ address, port, family }, https) {
+    const serverName = family === 'IPv6' ? `[${address}]` : address;
+    const protocol = `http${https ? 's' : ''}://`;
+    return `${protocol}${serverName}:${port}`;
+}
+
+export { index as default };

package/dist/types.d.ts

@@ -0,0 +1,20 @@
+/// <reference types="node" />
+import Koa from 'koa';
+import serve from 'koa-static';
+import { Server } from 'http';
+export declare type ServePluginOptions = {
+    pluginName?: string;
+    useWriteBundle?: boolean;
+    dirs?: string | string[];
+    port?: number;
+    useKoaLogger?: boolean;
+    koaStaticOptions?: serve.Options;
+    host?: string;
+    https?: {
+        cert: string;
+        key: string;
+        ca?: string;
+    };
+    customizeKoa?: (koa: Koa) => void;
+    onListen?: (server: Server) => void | true;
+} | string | string[];

package/package.json

@@ -0,0 +1,85 @@
+{
+  "version": "1.0.0",
+  "license": "MIT",
+  "name": "@rollup-extras/plugin-serve",
+  "author": {
+    "name": "Konstantin Shutkin"
+  },
+  "funding": "https://www.donationalerts.com/r/excitingcode",
+  "type": "module",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.mjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "typings": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=15"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kshutkin/rollup-extras.git"
+  },
+  "bugs": {
+    "url": "https://github.com/kshutkin/rollup-extras/issues"
+  },
+  "homepage": "https://github.com/kshutkin/rollup-extras/plugin-clean/README.md",
+  "readme": "README.md",
+  "keywords": [
+    "rollup-plugin"
+  ],
+  "scripts": {
+    "build": "rimraf ./dist && rollup -c",
+    "dev": "rimraf ./dist && rollup -c -w",
+    "test": "jest --collectCoverage",
+    "lint": "eslint ./src",
+    "semantic-release": "npx semantic-release"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "21.0.1",
+    "@rollup/plugin-node-resolve": "13.0.6",
+    "@semantic-release/changelog": "6.0.1",
+    "@semantic-release/commit-analyzer": "9.0.1",
+    "@semantic-release/git": "10.0.1",
+    "@semantic-release/npm": "8.0.2",
+    "@semantic-release/release-notes-generator": "10.0.2",
+    "@types/jest": "27.0.2",
+    "@typescript-eslint/eslint-plugin": "5.3.0",
+    "@typescript-eslint/parser": "5.3.0",
+    "conventional-changelog-angular": "5.0.13",
+    "eslint": "8.1.0",
+    "jest": "27.3.1",
+    "lodash": "4.17.21",
+    "rimraf": "3.0.2",
+    "is-builtin-module": "3.1.0",
+    "rollup": "2.60.1",
+    "rollup-plugin-terser": "7.0.2",
+    "rollup-plugin-typescript2": "0.31.1",
+    "rollup-plugin-preprocess": "0.0.4",
+    "semantic-release": "18.0.0",
+    "semantic-release-monorepo": "7.0.5",
+    "ts-jest": "27.0.7",
+    "typescript": "4.5.x",
+    "update-monorepo-package-json": "0.1.6",
+    "@types/koa": "^2.13.4",
+    "@types/koa-logger": "^3.1.2",
+    "@types/koa-static": "^4.0.2"
+  },
+  "peerDependencies": {
+    "rollup": "^2.60.2"
+  },
+  "dependencies": {
+    "koa": "^2.13.4",
+    "koa-static": "^5.0.0",
+    "koa-logger": "^3.2.1",
+    "@niceties/logger": "^1.0.4",
+    "@rollup-extras/utils": "^1.0.0"
+  },
+  "description": "README.md"
+}