edge-functions 1.0.0 → 1.3.0

package/.eslintrc.json

@@ -4,7 +4,10 @@
     "es2021": true,
     "jest/globals": true
   },
-  "plugins": ["jsdoc", "jest"],
+  "plugins": [
+    "jsdoc",
+    "jest"
+  ],
   "extends": [
     "airbnb-base",
     "plugin:jsdoc/recommended",
@@ -19,24 +22,66 @@
     "import/resolver": {
       "alias": {
         "map": [
-          ["#root/*", "./"],
-          ["#lib/*", "./lib"],
-          ["#utils", "./lib/utils/index.js"],
-          ["#polyfills", "./lib/build/polyfills/index.js"],
-          ["#build", "./lib/build/dispatcher/index.js"],
-          ["#bundlers", "./lib/build/bundlers/index.js"],
-          ["#notations/*", "./lib/notations"],
-          ["#env", "./lib/env/index.js"],
-          ["#platform", "./lib/platform/index.js"],
-          ["#constants", "./lib/constants/index.js"],
-          ["#edge", "./lib/platform/edgehooks/index.js"]
+          [
+            "#root/*",
+            "./"
+          ],
+          [
+            "#lib/*",
+            "./lib"
+          ],
+          [
+            "#utils",
+            "./lib/utils/index.js"
+          ],
+          [
+            "#polyfills",
+            "./lib/env/polyfills/index.js"
+          ],
+          [
+            "#build",
+            "./lib/build/dispatcher/index.js"
+          ],
+          [
+            "#bundlers",
+            "./lib/build/bundlers/index.js"
+          ],
+          [
+            "#notations/*",
+            "./lib/notations"
+          ],
+          [
+            "#env",
+            "./lib/env/index.js"
+          ],
+          [
+            "#platform",
+            "./lib/platform/index.js"
+          ],
+          [
+            "#constants",
+            "./lib/constants/index.js"
+          ],
+          [
+            "#edge",
+            "./lib/platform/edgehooks/index.js"
+          ]
         ],
-        "extensions": [".js", ".json"]
+        "extensions": [
+          ".js",
+          ".json"
+        ]
       }
     }
   },
   "rules": {
-    "import/extensions": ["error", "always"],
+    "import/extensions": [
+      "error",
+      "always"
+    ],
     "no-console": "off"
+  },
+  "globals": {
+    "AZION_VERSION_ID": "readonly"
   }
-}
+}

package/.github/workflows/major.yml

@@ -25,4 +25,4 @@ jobs:
       - name: Create Release
         env:
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: npx semantic-release -e ./releaserc.json
+        run: npx semantic-release -e ./releaserc.jsong

package/.github/workflows/minor.yml

@@ -1,8 +1,7 @@
 name: Release (Minor/Patch)
 
 on:
-  pull_request:
-    types: [closed]
+  push:
     branches:
       - dev
 jobs:

package/README.md

@@ -1,5 +1,7 @@
 
 # Vulcan - Forging The Edge
+![vulcan](https://github.com/aziontech/vulcan/assets/12740219/a5043e6f-11cb-4498-a300-5bdb617a9989)
+
 
 Vulcan is a powerful tool designed to streamline the development and deployment of JavaScript applications and frameworks. This powerful utility automates polyfills for Edge Computing, significantly simplifying the process of creating Workers, particularly for the Azion platform.
 
@@ -45,6 +47,40 @@ Follow these steps to start using Vulcan:
 
 5. Start developing: Once the project is set up, you can start developing your JavaScript applications or frameworks using the power of Vulcan. Leverage the automated polyfills, Worker creation assistance, and other features provided by Vulcan to enhance your development workflow.
 
+## Using Vulcan
+
+See some examples below:
+
+* Build a JavaScript/Node project (back-end)
+
+   ```shell
+   vulcan build
+   ```
+   
+* Build a TypeScript/Node (back-end)
+
+   ```shell
+   vulcan build --preset typescript
+   ```
+   
+* Build a Static Next.js project
+
+   ```shell
+   vulcan build --preset next --mode deliver
+   ```
+   
+ * Build a Static Astro.js project
+
+   ```shell
+   vulcan build --preset astro --mode deliver
+   ```
+   
+* Test your project locally (after build)
+
+   ```shell
+   vulcan dev
+   ```
+
 
 ## Docs
 * [Overview](docs/overview.md)

package/aliases.js

@@ -2,7 +2,7 @@ export default [
   ['#root/*', './'],
   ['#lib/*', './lib'],
   ['#utils', './lib/utils/index.js'],
-  ['#polyfills', './lib/build/polyfills/index.js'],
+  ['#polyfills', './lib/env/polyfills/index.js'],
   ['#build', './lib/build/dispatcher/index.js'],
   ['#bundlers', './lib/build/bundlers/index.js'],
   ['#notations/*', './lib/notations'],

package/docs/overview.md

@@ -31,6 +31,7 @@ Polyfills can be used to generate the worker(s) file(s).
 Some configs can be passed to the builder but if user tries to override `azion worker configs` this passed configs will be ignored.
 
 ### Artifacts
-Files generated to run in azion structure:
-* js worker(s);
-* Storage assets files;
+The **'.edge'** folder will be generated representing the edge locally. Files generated to run on the infrastructure:
+* JS worker(s) => '.edge/workers.js';
+* Assets => '.edge/storage/*';
+* Environment variables => '.edge/.env'.

package/docs/presets.md

@@ -9,8 +9,9 @@ Vulcan is an extensible platform that allows you to easily create new presets fo
 To add a new preset, you need to create appropriate folders in two directories: `presets/default` or `presets/custom`. The folder representing your framework or library will automatically be included in the preset listings. Each preset has two modes, represented by folders of the same name: `compute` and `deliver`.
 
 
+https://github.com/aziontech/vulcan/assets/12740219/84c7d7a1-4167-4e7e-993f-41a6eb653758
+
 
-https://github.com/aziontech/vulcan/assets/12740219/06edb9a0-26cd-4055-bd2e-d400b6a06f3c
 
 
 
@@ -35,7 +36,7 @@ Each preset is made up of three primary files: `config.js`, `prebuild.js`, and `
 
 	- `getPackageManager`: This method returns the package manager relative to the user's project (can be yarn, npm, or pnpm).
 
-	- `copyDirectory`: This function is used to copy the resulting static files from the framework build to the local Edge environment (.edge/statics).
+	- `copyDirectory`: This function is used to copy the resulting static files from the framework build to the local Edge environment (.edge/storage).
 
 	- `feedback`: This interface is used to display messages during the process, if necessary, or in case of error.
 
@@ -54,7 +55,18 @@ Each preset is made up of three primary files: `config.js`, `prebuild.js`, and `
 
 Here's a step-by-step guide on how to add a new preset in Vulcan:
 
-1.  ## **Create a folder inside `./lib/presets/custom`:**
+## **Use the command to automatic creation:**
+
+    vulcan presets create
+
+https://github.com/aziontech/vulcan/assets/12740219/9ca7371e-713a-4b29-a99b-c1a18d28bc67
+
+
+
+### Or do it manually:
+
+
+## 1. **Create a folder inside `./lib/presets/custom`:**
    https://github.com/aziontech/vulcan/assets/12740219/abb1b2cc-5f74-473d-b731-c0b7157cb95e
 
   -   The name of this folder should represent the name of your framework or library.
@@ -65,7 +77,7 @@ Here's a step-by-step guide on how to add a new preset in Vulcan:
 
 -   **Deliver**: This mode should be used when you intend to use the worker only for routing requests and delivering static files that will be computed on the client side.
         
-3.  ## **Create the following files in your preset's folder:**
+2.  ## **Create the following files in your preset's folder:**
     
     ##  handler.js
     This file contains the code that is executed within the worker in the edge function. Essentially, it is the code that runs directly on the edge. In the context of the `deliver` mode, this may simply act as a router. However, in cases where computation is needed, it can be designed to perform more complex tasks. Remember, the capabilities of your handler.js are dependent on your use case and the mode of operation you've chosen for your preset.
@@ -83,7 +95,7 @@ Here's a step-by-step guide on how to add a new preset in Vulcan:
 	   This file serves as an extension to the edge build. It enables the inclusion of polyfills, plugins, or any other procedures that relate to the build process executed on the edge. Although it is editable, we strongly advise against making changes to this file unless absolutely necessary. It's designed to ensure optimal operation, and modifications should be undertaken with careful consideration.
 	   
 	   ## prebuild.js
-	   In this file, you should adapt the native build process of your framework or library. Usually, in the case of *deliver* presets, this file will be used to ensure that the generated static artifacts are placed in the *.edge/statics/* directory.
+	   In this file, you should adapt the native build process of your framework or library. Usually, in the case of *deliver* presets, this file will be used to ensure that the generated static artifacts are placed in the *.edge/storage/* directory.
       #### React (deliver) Example:
 
 ![prebuild](https://github.com/aziontech/vulcan/assets/12740219/85adc374-220b-4003-8c3e-6ec5b06a483f)
@@ -112,4 +124,4 @@ For `deliver` mode:
 
     vulcan build --preset <name> --mode deliver
 
-Replace `<name>` with the name of your preset. This will initiate Vulcan's build process for your preset, allowing you to verify its functionality.
+Replace `<name>` with the name of your preset. This will initiate Vulcan's build process for your preset, allowing you to verify its functionality.

package/examples/angular-static/package.json

@@ -27,7 +27,6 @@
     "@angular/cli": "~16.1.3",
     "@angular/compiler-cli": "^16.1.0",
     "@types/jasmine": "~4.3.0",
-    "edge-functions": "^0.0.1",
     "jasmine-core": "~4.6.0",
     "karma": "~6.4.0",
     "karma-chrome-launcher": "~3.2.0",

package/examples/simple-js-esm/main.js

@@ -4,11 +4,16 @@ import messages from './messages.js';
 
 const message = messages[Math.floor(Math.random() * messages.length)];
 
-console.log('selected message:', message);
-
-return new Response(message, {
-  headers: new Headers([
-    ["X-Custom-Feat", "my random message"],
-  ]),
-  status: 200,
-});
+function main(event) {
+  console.log('selected message:', message);
+  console.log('VERSION_ID =', AZION_VERSION_ID);
+
+  return new Response(message, {
+    headers: new Headers([
+      ["X-Custom-Feat", "my random message"],
+    ]),
+    status: 200,
+  });
+}
+
+/* eslint-enable */

package/examples/simple-js-esm-node/index.js

@@ -0,0 +1,45 @@
+import { Buffer } from 'buffer';
+
+/**
+ * Buffer use examples
+ */
+function buffeExamples() {
+  const buffer1 = Buffer.alloc(10);
+  const buffer2 = Buffer.from([1, 2, 3]);
+  const buffer3 = Buffer.from('Hello, world!', 'utf-8');
+
+  console.log(buffer1); // Output: <Buffer 00 00 00 00 00 00 00 00 00 00>
+  console.log(buffer2); // Output: <Buffer 01 02 03>
+  console.log(buffer3.toString()); // Output: "Hello, world!"
+
+  buffer1.write('Hello', 'utf-8');
+  console.log(buffer1.toString()); // Output: "Hello"
+
+  buffer1[5] = 33;
+  console.log(buffer1); // Output: <Buffer 48 65 6c 6c 6f 21>
+
+  const combinedBuffer = Buffer.concat([buffer1, buffer2]);
+  console.log(combinedBuffer.toString()); // Output: "Hello, world!♡"
+
+  const slicedBuffer = buffer3.slice(0, 5);
+  console.log(slicedBuffer.toString()); // Output: "Hello"
+
+  console.log(buffer1.length); // Output: 10
+  console.log(buffer1.equals(buffer2)); // Output: false
+
+  const json = JSON.stringify(buffer3);
+  // Output: {"type":"Buffer","data":[72,101,108,108,111,44,32,119,111,114,108,100,33]}
+  console.log(json);
+
+  const parsedJson = JSON.parse(json, (key, value) => (value && value.type === 'Buffer' ? Buffer.from(value.data) : value));
+  console.log(parsedJson.toString()); // Output: "Hello, world!"
+}
+
+// eslint-disable-next-line
+function main(event) {
+  buffeExamples();
+
+  return new Response('Hello!', {
+    status: 200,
+  });
+}

package/examples/simple-ts-esm/main.ts

@@ -0,0 +1,24 @@
+/* eslint-disable */
+declare const AZION_VERSION_ID: string;
+
+import getMessages from "./messages.js";
+
+function getRandomMessage(messages: string[]): string {
+  const randomIndex: number = Math.floor(Math.random() * messages.length);
+
+  return messages[randomIndex];
+}
+
+function main(event: any) {
+  const messages = getMessages();
+  const message = getRandomMessage(messages);
+
+  console.log("selected message:", message);
+  console.log("VERSION_ID =", AZION_VERSION_ID);
+
+  return new Response(message, {
+    headers: new Headers([["X-Custom-Feat", "my random message"]]),
+    status: 200,
+  });
+}
+/* eslint-enable */

package/examples/simple-ts-esm/messages.ts

@@ -0,0 +1,11 @@
+function getMessages(): string[] {
+  return [
+    "Even the smallest person can change the course of the future. — Galadriel",
+    "Not all those who wander are lost. — Bilbo Baggins",
+    "Despair is only for those who see the end beyond all doubt. We do not. — Gandalf",
+    "All we have to decide is what to do with the time that is given us. — Gandalf",
+    "You are the luckiest, the canniest, and the most reckless man I ever knew. – Gimli",
+  ];
+}
+
+export default getMessages;

package/examples/simple-ts-esm/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "simple-ts-esm",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "devDependencies": {
+    "typescript": "^5.1.6"
+  }
+}

package/examples/simple-ts-esm/tsconfig.json

@@ -0,0 +1,109 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "ES2022" /* Specify what module code is generated. */,
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+
+    /* Type Checking */
+    "strict": true /* Enable all strict type-checking options. */,
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */
+  }
+}

package/examples/simple-ts-esm/yarn.lock

@@ -0,0 +1,8 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+typescript@^5.1.6:
+  version "5.1.6"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.1.6.tgz#02f8ac202b6dad2c0dd5e0913745b47a37998274"
+  integrity sha512-zaWCozRZ6DLEWAWFrVDz1H6FVXzUSfTy5FUMWsQlU8Ym5JP9eO4xkTIROFCQvhQf61z6O/G6ugw3SgAnvvm+HA==

package/examples/vue-vite-static/README.md

@@ -0,0 +1,29 @@
+# vue-vite-static
+
+This template should help get you started developing with Vue 3 in Vite.
+
+## Recommended IDE Setup
+
+[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
+
+## Customize configuration
+
+See [Vite Configuration Reference](https://vitejs.dev/config/).
+
+## Project Setup
+
+```sh
+npm install
+```
+
+### Compile and Hot-Reload for Development
+
+```sh
+npm run dev
+```
+
+### Compile and Minify for Production
+
+```sh
+npm run build
+```

package/examples/vue-vite-static/index.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <link rel="icon" href="/favicon.ico">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Vite App</title>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script type="module" src="/src/main.js"></script>
+  </body>
+</html>

package/examples/vue-vite-static/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "vue-vite-static",
+  "version": "0.0.0",
+  "private": true,
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "vue": "^3.3.4",
+    "vue-router": "^4.2.4"
+  },
+  "devDependencies": {
+    "@vitejs/plugin-vue": "^4.2.3",
+    "vite": "^4.4.6"
+  }
+}

package/examples/vue-vite-static/src/App.vue

@@ -0,0 +1,85 @@
+<script setup>
+import { RouterLink, RouterView } from 'vue-router'
+import HelloWorld from './components/HelloWorld.vue'
+</script>
+
+<template>
+  <header>
+    <img alt="Vue logo" class="logo" src="@/assets/logo.svg" width="125" height="125" />
+
+    <div class="wrapper">
+      <HelloWorld msg="You did it!" />
+
+      <nav>
+        <RouterLink to="/">Home</RouterLink>
+        <RouterLink to="/about">About</RouterLink>
+      </nav>
+    </div>
+  </header>
+
+  <RouterView />
+</template>
+
+<style scoped>
+header {
+  line-height: 1.5;
+  max-height: 100vh;
+}
+
+.logo {
+  display: block;
+  margin: 0 auto 2rem;
+}
+
+nav {
+  width: 100%;
+  font-size: 12px;
+  text-align: center;
+  margin-top: 2rem;
+}
+
+nav a.router-link-exact-active {
+  color: var(--color-text);
+}
+
+nav a.router-link-exact-active:hover {
+  background-color: transparent;
+}
+
+nav a {
+  display: inline-block;
+  padding: 0 1rem;
+  border-left: 1px solid var(--color-border);
+}
+
+nav a:first-of-type {
+  border: 0;
+}
+
+@media (min-width: 1024px) {
+  header {
+    display: flex;
+    place-items: center;
+    padding-right: calc(var(--section-gap) / 2);
+  }
+
+  .logo {
+    margin: 0 2rem 0 0;
+  }
+
+  header .wrapper {
+    display: flex;
+    place-items: flex-start;
+    flex-wrap: wrap;
+  }
+
+  nav {
+    text-align: left;
+    margin-left: -1rem;
+    font-size: 1rem;
+
+    padding: 1rem 0;
+    margin-top: 1rem;
+  }
+}
+</style>