Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vladimirmikulic/parcel-plugin-gas
🌀 Parcel plugin that enables Google App Script bundling.
https://github.com/vladimirmikulic/parcel-plugin-gas
bundle-adjustment google-apps-script javascript parcel parcel-plugin web
Last synced: about 2 months ago
JSON representation
🌀 Parcel plugin that enables Google App Script bundling.
- Host: GitHub
- URL: https://github.com/vladimirmikulic/parcel-plugin-gas
- Owner: VladimirMikulic
- License: mit
- Created: 2020-08-07T21:30:30.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-08-29T21:17:12.000Z (over 3 years ago)
- Last Synced: 2024-11-05T23:49:50.707Z (about 2 months ago)
- Topics: bundle-adjustment, google-apps-script, javascript, parcel, parcel-plugin, web
- Language: JavaScript
- Homepage:
- Size: 323 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# parcel-plugin-gas
[](#)
[](https://twitter.com/VladoDev)
> 🌀 Parcel plugin that enables Google App Script bundling.
_This is the plugin for Parcel v1. The plugin for the second version can be found [here](https://github.com/VladimirMikulic/parcel-optimizer-gas)._
## :package: Installation
```shell
# Installs the plugin and saves it as a development dependency
npm i parcel-plugin-gas -D
```
## :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 `GAS` entity 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**
```js
// Runs when user installs extension
GAS.onInstall = e => {
onOpen();
};
// Runs as soon as user opens a document
GAS.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**
```js
require('./my-module');
// Runs when user installs extension
GAS.onInstall = e => {
customFunction();
};
```
**my-module.js**
```js
GAS.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](https://developers.google.com/apps-script/guides/clasp).
## :sparkles: Run tests
The plugin uses [Jest](https://jestjs.io/) for running tests.
Jest will execute all `.test.js` files in the `test` folder.
```sh
npm test
```
## :man: Author
**Vladimir Mikulic**
- Twitter: [@VladoDev](https://twitter.com/VladoDev)
- Github: [@VladimirMikulic](https://github.com/VladimirMikulic)
- LinkedIn: [@vladimirmikulic](https://www.linkedin.com/in/vladimir-mikulic/)
## :handshake: Contributing
Contributions, issues and feature requests are welcome!
## :pencil: License
This project is licensed under [MIT](https://opensource.org/licenses/MIT) license.
## :man_astronaut: Show your support
Give a ⭐️ if this project helped you!