edge-functions
v4.3.0
Published
Tool to launch and build JavaScript/Frameworks. This tool automates polyfills for Edge Computing and assists in creating Workers, notably for the Azion platform.
Downloads
1,471
Readme
Azion Bundler - Building Applications for Azion Runtime
Azion Bundler is a powerful tool designed to streamline the development and deployment of JavaScript applications and frameworks. This powerful utility automates polyfills for Azion Runtime, significantly simplifying the process of creating Workers.
One of the key highlights of Azion Bundler is its ability to establish an intuitive and efficient protocol for facilitating the creation of presets. This makes customization and adaptation to specific project needs even more accessible, providing developers with the necessary flexibility to optimize their applications effectively and efficiently.
Supported
E2E tests run daily in the Bundler Examples to ensure that the presets and frameworks continue to work correctly.
Table: | Test | Status | | ------------------------------------ | ------ | | Next 14 2 15 Middleware | ✅ | | Next 13 5 6 I18n | ✅ | | Next 12 3 4 I18n | ✅ | | Hexo Static | ✅ | | Next 13 5 6 Middleware | ✅ | | Next 12 3 4 Middleware | ✅ | | Next Node Pages 12 3 1 | ✅ | | Next 13 5 6 Config | ✅ | | Next 12 3 4 Config | ✅ | | Next Static | ✅ | | Gatsby Static | ✅ | | Next Node Pages 12 3 1 Fs | ✅ | | Vue Vite Static | ✅ | | Next 12 Static | ✅ | | Astro Static | ✅ | | Simple Js Env Vars | ✅ | | Eleventy Static | ✅ | | React Static | ✅ | | Angular Static | ✅ | | Simple Js Network List | ✅ | | Svelte Static | ✅ | | Vitepress Static | ✅ | | Nuxt Static | ✅ | | Docusaurus Static | ✅ | | Simple Js Firewall Event | ✅ | | Simple Js Network List With Firewall | ✅ | | Jekyll Static | ✅ | | Simple Js Esm Worker | ✅ | | Simple Js Esm Node | ✅ | | Simple Ts Esm | ⚠️ | | Simple Js Esm | ✅ |
Last test run date: 10/30/24 03:38:51 AM
Quick Installation
For those who just want to use Azion Bundler in their project without contributing to the development, you can install it directly from npm.
npm install edge-functions
or if you prefer yarn:
yarn add edge-functions
Getting Started for Development
Follow these steps to start using Azion Bundler:
Clone the repository: Clone the Azion Bundler repository from GitHub to your local machine.
git clone https://github.com/aziontech/bundler.git
Installation: Navigate to the cloned Azion Bundler directory and install the required dependencies.
cd bundler npm yarn install
Install the Azion Bundler CLI globally, which allows you to use it as a command-line tool from anywhere in your system.
npm install -g
This command sets up the necessary project structure and configuration files for Azion Bundler.
Start developing: Once the project is set up, you can start developing your JavaScript applications or frameworks using the power of Bundler. Leverage the automated polyfills, Worker creation assistance, and other features provided by Bundler to enhance your development workflow.
Using Azion Bundler
See some examples below:
Build a JavaScript/Node project (back-end)
azbundler build
Build a TypeScript/Node (back-end)
azbundler build --preset typescript
Build a Next.js project
azbundler build --preset next
Build Astro.js project
azbundler build --preset astro
Test your project locally (after build)
azbundler dev
Azion.config.js
The azion.config.js
file offers a robust configuration system for Bundler. This file is not mandatory but acts as an override mechanism. If you define properties in this file, they will supersede the preset configurations. Properties not defined will rely on the preset.
Here's a detailed breakdown of the configuration properties available in azion.config.js
:
Entry
Type: String
Description: This represents the primary entry point for your application, where the building process begins.
Note: Entry
will be ignored for jamstack solutions.
Builder
Type: String ('esbuild' or 'webpack')
Description:
Defines which build tool to use. The available options are esbuild
and webpack
.
Polyfills
Type: Boolean
Description: Determines whether Node.js polyfills should be applied. This is useful for projects that leverage specific Node.js functionality but target environments without these built-in features.
Worker
Type: Boolean
Description:
This flag indicates that the constructed code inserts its own worker expression, such as addEventListener("fetch")
.
Preset
Type: Object
Description: Provides preset-specific configurations.
- Name (Type: String): Refers to the preset name, e.g., "vue" or "next"..
MemoryFS
Type: Object
Description: Configurations related to the in-memory filesystem.
InjectionDirs (Type: Array of Strings): Directories to be injected into memory for runtime access via the fs API.
RemovePathPrefix (Type: String): A prefix path to be removed from files before injecting into memory.
Custom
Type: Object
Description:
Allows you to extend the capabilities of the chosen bundler (either webpack
or esbuild
) with custom plugins or configurations.
- Plugins (Type: Object): Add your custom plugins for your chosen bundler here.
Example Configuration
For a Next/Faststore-based project:
module.exports = {
build: {
entry: 'src/index.js',
builder: 'webpack',
polyfills: true,
worker: false,
preset: { name: 'next' },
memoryFS: {
injectionDirs: ['.faststore/@generated/graphql'],
removePathPrefix: '.faststore/',
},
custom: {
plugins: {},
},
}
};
Note: Adapting azion.config.js
to your setup allows a personalized development experience, catering to the specific needs of your JavaScript applications and frameworks.
Docs
- Overview
- Presets
- Nextjs
- Rust/Wasm example
- Emscripten/Wasm example
- Env vars example
- Storage example
- Firewall example
Wasm Notes
To use wasm presets you need to install the necessary tools to build your code:
- Emscripten: emsdk;
- Rust/Wasm: wasm-bindgen-cli
Node.js Support and Report
The compatibility between Azion Runtime and Node.js is an ongoing task, but a set of Node Runtime APIs are listed and compatible with Azion Runtime.
Contributing
Check the Contributing doc.
Code of Conduct
Check the Code of Conduct.