Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 1.86 KB

README.md

File metadata and controls

60 lines (41 loc) · 1.86 KB
Raw

Google Apps Script Template powered by esbuild

Starter template for Google App Script development in local.

image

How to use

GitHub Template Create a repo from this template on GitHub

  1. Fix the project_id in .clasp.json to your GAS project.
{
  "scriptId": "<YOUR_SCRIPT_ID>",
  "rootDir": "./dist"
}
  1. Write your code with TypeScript and any npm libraries with ESM styles.
  • Google Apps Script requires executable function to be registered globally.
  • In this template, the main function of index.ts is registered globally, so if you need a single function, you can write the process you want to execute from GAS here(Functions, not registered globally, are treated as private).
  • If you want to register multiple executable functions, do not forget to register them in global!
import { sum } from "./utils"

const main = (): void => {
  Logger.log(sum(12, 20))
}

const sub = (): void => {
  Logger.log(sum(32, 28))
}

declare let global: any;
global.main = main;
global.sub = sub;  // Can be called directly from Google Apps Script as `sub`
  1. Compile & transpile your scripts with esbuild.
# `bundle.js` are output to the `dist` directory
npm run build

  1. (First time only) Copy src/appsscript.json to the dist directory. See the Known Issues

  2. Push your scripts to Google Apps Script with clasp.

# Upload and open your scripts.
npm run deploy

Known Issues (PR Welcome)

  • The clasp requires appsscript.json(manifest of Google Apps Script) to be included in the dist, but it is not automated (I haven't figured out how to do it automatically with esbuild).