@sdeverywhere/plugin-vite 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Climate Interactive / New Venture Fund
+
+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,13 @@
+# @sdeverywhere/plugin-vite
+
+This package provides a plugin that uses Vite and a given Vite configuration file
+to bundle an application or library as part of the SDEverywhere builder process
+(i.e., `sde bundle` or `sde dev`).
+
+## Documentation
+
+TODO
+
+## License
+
+SDEverywhere is distributed under the MIT license. See `LICENSE` for more details.

package/dist/index.cjs

@@ -0,0 +1,85 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  vitePlugin: () => vitePlugin
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/plugin.ts
+var import_vite = require("vite");
+function vitePlugin(options) {
+  return new VitePlugin(options);
+}
+var VitePlugin = class {
+  constructor(options) {
+    this.options = options;
+  }
+  async postGenerate(context) {
+    return this.buildIfNeeded(context, "post-generate");
+  }
+  async postBuild(context) {
+    return this.buildIfNeeded(context, "post-build");
+  }
+  async buildIfNeeded(context, caller) {
+    var _a, _b;
+    const applyDev = ((_a = this.options.apply) == null ? void 0 : _a.development) || "post-build";
+    const applyProd = ((_b = this.options.apply) == null ? void 0 : _b.production) || "post-build";
+    const shouldBuild = context.config.mode === "development" && applyDev === caller || context.config.mode === "production" && applyProd === caller;
+    if (shouldBuild) {
+      context.log("info", `Building ${this.options.name}`);
+      await (0, import_vite.build)(this.options.config);
+    }
+    return true;
+  }
+  async watch() {
+    var _a, _b;
+    if (((_a = this.options.apply) == null ? void 0 : _a.development) === "serve") {
+      const server = await (0, import_vite.createServer)(this.options.config);
+      await server.listen();
+    } else if (((_b = this.options.apply) == null ? void 0 : _b.development) === "watch") {
+      const config = __spreadValues({
+        build: {
+          watch: {}
+        }
+      }, this.options.config);
+      await (0, import_vite.build)(config);
+    }
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  vitePlugin
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/plugin.ts"],"sourcesContent":["// Copyright (c) 2022 Climate Interactive / New Venture Fund\n\nexport type { VitePluginOptions } from './options'\nexport { vitePlugin } from './plugin'\n","// Copyright (c) 2022 Climate Interactive / New Venture Fund\n\nimport type { InlineConfig, ViteDevServer } from 'vite'\nimport { build, createServer } from 'vite'\n\nimport type { BuildContext, Plugin } from '@sdeverywhere/build'\n\nimport type { VitePluginOptions } from './options'\n\nexport function vitePlugin(options: VitePluginOptions): Plugin {\n  return new VitePlugin(options)\n}\n\nclass VitePlugin implements Plugin {\n  constructor(private readonly options: VitePluginOptions) {}\n\n  async postGenerate(context: BuildContext): Promise<boolean> {\n    // Only build if the plugin is configured to run for 'post-generate'\n    return this.buildIfNeeded(context, 'post-generate')\n  }\n\n  async postBuild(context: BuildContext): Promise<boolean> {\n    // Only build if the plugin is configured to run for 'post-build'\n    return this.buildIfNeeded(context, 'post-build')\n  }\n\n  private async buildIfNeeded(context: BuildContext, caller: 'post-generate' | 'post-build'): Promise<boolean> {\n    // The apply values default to 'post-build' when left undefined\n    const applyDev = this.options.apply?.development || 'post-build'\n    const applyProd = this.options.apply?.production || 'post-build'\n\n    // Run \"vite build\" only if configured for this mode\n    const shouldBuild =\n      (context.config.mode === 'development' && applyDev === caller) ||\n      (context.config.mode === 'production' && applyProd === caller)\n    if (shouldBuild) {\n      context.log('info', `Building ${this.options.name}`)\n      await build(this.options.config)\n      // context.log('info', 'Done!')\n    }\n    return true\n  }\n\n  async watch(): Promise<void> {\n    if (this.options.apply?.development === 'serve') {\n      // Run \"vite dev\", which starts the app in a local server and\n      // refreshes when source files are changed\n      const server: ViteDevServer = await createServer(this.options.config)\n      await server.listen()\n    } else if (this.options.apply?.development === 'watch') {\n      // Run \"vite build\" in watch mode so that it rebuilds when source\n      // files are changed\n      const config: InlineConfig = {\n        build: {\n          // Enable watch mode\n          // TODO: Only do this if not already set up in the given config?\n          watch: {}\n        },\n        ...this.options.config\n      }\n      await build(config)\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACGA,kBAAoC;AAM7B,oBAAoB,SAAoC;AAC7D,SAAO,IAAI,WAAW,OAAO;AAC/B;AAEA,IAAM,aAAN,MAAmC;AAAA,EACjC,YAA6B,SAA4B;AAA5B;AAAA,EAA6B;AAAA,EAE1D,MAAM,aAAa,SAAyC;AAE1D,WAAO,KAAK,cAAc,SAAS,eAAe;AAAA,EACpD;AAAA,EAEA,MAAM,UAAU,SAAyC;AAEvD,WAAO,KAAK,cAAc,SAAS,YAAY;AAAA,EACjD;AAAA,EAEA,MAAc,cAAc,SAAuB,QAA0D;AA1B/G;AA4BI,UAAM,WAAW,YAAK,QAAQ,UAAb,mBAAoB,gBAAe;AACpD,UAAM,YAAY,YAAK,QAAQ,UAAb,mBAAoB,eAAc;AAGpD,UAAM,cACH,QAAQ,OAAO,SAAS,iBAAiB,aAAa,UACtD,QAAQ,OAAO,SAAS,gBAAgB,cAAc;AACzD,QAAI,aAAa;AACf,cAAQ,IAAI,QAAQ,YAAY,KAAK,QAAQ,MAAM;AACnD,YAAM,uBAAM,KAAK,QAAQ,MAAM;AAAA,IAEjC;AACA,WAAO;AAAA,EACT;AAAA,EAEA,MAAM,QAAuB;AA3C/B;AA4CI,QAAI,YAAK,QAAQ,UAAb,mBAAoB,iBAAgB,SAAS;AAG/C,YAAM,SAAwB,MAAM,8BAAa,KAAK,QAAQ,MAAM;AACpE,YAAM,OAAO,OAAO;AAAA,IACtB,WAAW,YAAK,QAAQ,UAAb,mBAAoB,iBAAgB,SAAS;AAGtD,YAAM,SAAuB;AAAA,QAC3B,OAAO;AAAA,UAGL,OAAO,CAAC;AAAA,QACV;AAAA,SACG,KAAK,QAAQ;AAElB,YAAM,uBAAM,MAAM;AAAA,IACpB;AAAA,EACF;AACF;","names":[]}

package/dist/index.d.ts

@@ -0,0 +1,52 @@
+import { InlineConfig } from 'vite';
+import { Plugin } from '@sdeverywhere/build';
+
+interface VitePluginOptions {
+    /** The name to include in log messages. */
+    name: string;
+    /** The Vite config to use. */
+    config: InlineConfig;
+    /** Specifies the behavior of the plugin for different `sde` build modes. */
+    apply?: {
+        /**
+         * The behavior of the plugin when sde is configured for development mode.
+         *
+         * If left undefined, defaults to 'post-build'.
+         *
+         * ```
+         * 'skip':
+         *   Don't run the plugin.
+         * 'post-generate':
+         *   Run "vite build" in the `postGenerate` phase.
+         * 'post-build':
+         *   Run "vite build" in the `postBuild` phase.
+         * 'watch':
+         *   Run "vite build" in the `watch` callback (rebuilds the library when
+         *   changes are detected in source files); useful for libraries.
+         * 'serve':
+         *   Run "vite dev" (sets up local server and refreshes the app
+         *   automatically when changes are detected); useful for applications.
+         * ```
+         */
+        development?: 'skip' | 'post-generate' | 'post-build' | 'watch' | 'serve';
+        /**
+         * The behavior of the plugin when sde is configured for production mode.
+         *
+         * If left undefined, defaults to 'post-build'.
+         *
+         * ```
+         * 'skip':
+         *   Don't run the plugin.
+         * 'post-generate':
+         *   Run "vite build" in the `postGenerate` phase.
+         * 'post-build':
+         *   Run "vite build" in the `postBuild` phase.
+         * ```
+         */
+        production?: 'skip' | 'post-generate' | 'post-build';
+    };
+}
+
+declare function vitePlugin(options: VitePluginOptions): Plugin;
+
+export { VitePluginOptions, vitePlugin };

package/dist/index.js

@@ -0,0 +1,62 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+
+// src/plugin.ts
+import { build, createServer } from "vite";
+function vitePlugin(options) {
+  return new VitePlugin(options);
+}
+var VitePlugin = class {
+  constructor(options) {
+    this.options = options;
+  }
+  async postGenerate(context) {
+    return this.buildIfNeeded(context, "post-generate");
+  }
+  async postBuild(context) {
+    return this.buildIfNeeded(context, "post-build");
+  }
+  async buildIfNeeded(context, caller) {
+    var _a, _b;
+    const applyDev = ((_a = this.options.apply) == null ? void 0 : _a.development) || "post-build";
+    const applyProd = ((_b = this.options.apply) == null ? void 0 : _b.production) || "post-build";
+    const shouldBuild = context.config.mode === "development" && applyDev === caller || context.config.mode === "production" && applyProd === caller;
+    if (shouldBuild) {
+      context.log("info", `Building ${this.options.name}`);
+      await build(this.options.config);
+    }
+    return true;
+  }
+  async watch() {
+    var _a, _b;
+    if (((_a = this.options.apply) == null ? void 0 : _a.development) === "serve") {
+      const server = await createServer(this.options.config);
+      await server.listen();
+    } else if (((_b = this.options.apply) == null ? void 0 : _b.development) === "watch") {
+      const config = __spreadValues({
+        build: {
+          watch: {}
+        }
+      }, this.options.config);
+      await build(config);
+    }
+  }
+};
+export {
+  vitePlugin
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/plugin.ts"],"sourcesContent":["// Copyright (c) 2022 Climate Interactive / New Venture Fund\n\nimport type { InlineConfig, ViteDevServer } from 'vite'\nimport { build, createServer } from 'vite'\n\nimport type { BuildContext, Plugin } from '@sdeverywhere/build'\n\nimport type { VitePluginOptions } from './options'\n\nexport function vitePlugin(options: VitePluginOptions): Plugin {\n  return new VitePlugin(options)\n}\n\nclass VitePlugin implements Plugin {\n  constructor(private readonly options: VitePluginOptions) {}\n\n  async postGenerate(context: BuildContext): Promise<boolean> {\n    // Only build if the plugin is configured to run for 'post-generate'\n    return this.buildIfNeeded(context, 'post-generate')\n  }\n\n  async postBuild(context: BuildContext): Promise<boolean> {\n    // Only build if the plugin is configured to run for 'post-build'\n    return this.buildIfNeeded(context, 'post-build')\n  }\n\n  private async buildIfNeeded(context: BuildContext, caller: 'post-generate' | 'post-build'): Promise<boolean> {\n    // The apply values default to 'post-build' when left undefined\n    const applyDev = this.options.apply?.development || 'post-build'\n    const applyProd = this.options.apply?.production || 'post-build'\n\n    // Run \"vite build\" only if configured for this mode\n    const shouldBuild =\n      (context.config.mode === 'development' && applyDev === caller) ||\n      (context.config.mode === 'production' && applyProd === caller)\n    if (shouldBuild) {\n      context.log('info', `Building ${this.options.name}`)\n      await build(this.options.config)\n      // context.log('info', 'Done!')\n    }\n    return true\n  }\n\n  async watch(): Promise<void> {\n    if (this.options.apply?.development === 'serve') {\n      // Run \"vite dev\", which starts the app in a local server and\n      // refreshes when source files are changed\n      const server: ViteDevServer = await createServer(this.options.config)\n      await server.listen()\n    } else if (this.options.apply?.development === 'watch') {\n      // Run \"vite build\" in watch mode so that it rebuilds when source\n      // files are changed\n      const config: InlineConfig = {\n        build: {\n          // Enable watch mode\n          // TODO: Only do this if not already set up in the given config?\n          watch: {}\n        },\n        ...this.options.config\n      }\n      await build(config)\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAGA;AAMO,oBAAoB,SAAoC;AAC7D,SAAO,IAAI,WAAW,OAAO;AAC/B;AAEA,IAAM,aAAN,MAAmC;AAAA,EACjC,YAA6B,SAA4B;AAA5B;AAAA,EAA6B;AAAA,EAE1D,MAAM,aAAa,SAAyC;AAE1D,WAAO,KAAK,cAAc,SAAS,eAAe;AAAA,EACpD;AAAA,EAEA,MAAM,UAAU,SAAyC;AAEvD,WAAO,KAAK,cAAc,SAAS,YAAY;AAAA,EACjD;AAAA,EAEA,MAAc,cAAc,SAAuB,QAA0D;AA1B/G;AA4BI,UAAM,WAAW,YAAK,QAAQ,UAAb,mBAAoB,gBAAe;AACpD,UAAM,YAAY,YAAK,QAAQ,UAAb,mBAAoB,eAAc;AAGpD,UAAM,cACH,QAAQ,OAAO,SAAS,iBAAiB,aAAa,UACtD,QAAQ,OAAO,SAAS,gBAAgB,cAAc;AACzD,QAAI,aAAa;AACf,cAAQ,IAAI,QAAQ,YAAY,KAAK,QAAQ,MAAM;AACnD,YAAM,MAAM,KAAK,QAAQ,MAAM;AAAA,IAEjC;AACA,WAAO;AAAA,EACT;AAAA,EAEA,MAAM,QAAuB;AA3C/B;AA4CI,QAAI,YAAK,QAAQ,UAAb,mBAAoB,iBAAgB,SAAS;AAG/C,YAAM,SAAwB,MAAM,aAAa,KAAK,QAAQ,MAAM;AACpE,YAAM,OAAO,OAAO;AAAA,IACtB,WAAW,YAAK,QAAQ,UAAb,mBAAoB,iBAAgB,SAAS;AAGtD,YAAM,SAAuB;AAAA,QAC3B,OAAO;AAAA,UAGL,OAAO,CAAC;AAAA,QACV;AAAA,SACG,KAAK,QAAQ;AAElB,YAAM,MAAM,MAAM;AAAA,IACpB;AAAA,EACF;AACF;","names":[]}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@sdeverywhere/plugin-vite",
+  "version": "0.1.0",
+  "files": [
+    "dist/**"
+  ],
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "dependencies": {
+    "@sdeverywhere/build": "^0.1.0",
+    "vite": "^2.9.12"
+  },
+  "author": "Climate Interactive",
+  "license": "MIT",
+  "homepage": "https://sdeverywhere.org",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/climateinteractive/SDEverywhere.git",
+    "directory": "packages/plugin-vite"
+  },
+  "bugs": {
+    "url": "https://github.com/climateinteractive/SDEverywhere/issues"
+  },
+  "scripts": {
+    "clean": "rm -rf dist",
+    "lint": "eslint src --ext .ts --max-warnings 0",
+    "prettier:check": "prettier --check .",
+    "prettier:fix": "prettier --write .",
+    "precommit": "../../scripts/precommit",
+    "test": "echo No tests yet",
+    "test:watch": "echo No tests yet",
+    "test:ci": "echo No tests yet",
+    "type-check": "tsc --noEmit -p tsconfig-build.json",
+    "build": "tsup",
+    "ci:build": "run-s clean lint prettier:check test:ci type-check build"
+  }
+}