parcel-optimizer-gas v1.0.6

parcel-optimizer-gas

🌀 Parcel plugin that enables Google App Script bundling.

This is the plugin for Parcel v2. The plugin for the first version can be found here.

:package: Installation

# Installs the plugin and saves it as a development dependency
npm i parcel-optimizer-gas -D

🔌 Configuration

We need to create .parcelrc configuration file and add the plugin to optimizers like this:

Syntax "..." instructs Parcel to apply the plugin on top of existing JS optimizations

{
  "extends": "@parcel/config-default",
  "optimizers": {
    "*.js": ["...", "parcel-optimizer-gas"]
  }
}

:cloud: Usage

This plugin modifies the Parcel bundle to be Google App Script compatible. Parcel uses process called uglifying when generating your production build. Uglifying is the process of converting long function/variable names into shorter versions i.e. onInstall becomes j. This is a problem since Google's runtime expects explicit onInstall method to be available in global scope. This applies to other methods as well. That's why default Parcel bundle doesn't work on Google's runtime environment.

By attaching methods to the globalThis in source code, you prevent uglifying and with a bit of the plugin's magic your code works on Google's runtime environment.

🏠 Single file

index.js

// Runs when user installs extension
globalThis.onInstall = e => {
  onOpen();
};

// Runs as soon as user opens a document
globalThis.onOpen = e => {
  DocumentApp.getUi() // Or SlidesApp or FormApp.
    .createMenu('My Add-on')
    .addItem('Open', 'showSidebar')
    .addToUi();
};

💫 Multiple files

Google App Script runtime environment differs from normal JS environment that you are used to in your Browser or Node.js. There are simply no modules. Everything is loaded in one global scope/namespace.

index.js

require('./my-module');

// Runs when user installs extension
globalThis.onInstall = e => {
  customFunction();
};

my-module.js

globalThis.customFunction = () => {
  console.log('Hello from Google App Script!');
};

🚀 Build

parcel build index.js -> produces bundle which you can manually upload to your Google App Script project or push it from CLI with clasp.

:man: Author

Vladimir Mikulic

• Twitter: @VladoDev
• Github: @VladimirMikulic
• LinkedIn: @vladimirmikulic

:handshake: Contributing

Contributions, issues and feature requests are welcome!

:pencil: License

This project is licensed under MIT license.

:man_astronaut: Show your support

Give a ⭐️ if this project helped you!