JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 550
  • Score
    100M100P100Q92147F
  • License MIT

Execute and test your google apps scripts projects locally in node.js runtime

Package Exports

  • gas-local

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (gas-local) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Description

Execute and test your google apps scripts projects locally in node.js runtime Companion for gas tools

How to use

  1. Download your apps script project via gas tools. //all .gs files of your project will appear as javascript file in 'src' subfolder
  2. "Require" your library as usual module in your local tests
var gas = require('gas-local');
//require your downloaded google apps script library from src subfolder as normal module   
var glib = gas.require('./src');
//call some function from your app script library 
glib.somefunction();
  1. Develop and test your google apps script project locally
  2. Upload changes back to google via gas-tools.

How to mock google services

gas-local already mocks parts of Logger and Utilities by default (see globalmock-default.js). But you also can provide mocks for other google services for your tests. Below is example how to mock MailApp.getRemainingDailyQuota function. 

var gas = require('gas-local');
//pick default mock object
var defMock = gas.globalMockDefault;
//Mock MailApp by extending default mock object
var customMock = { 
    MailApp: { getRemainingDailyQuota: function () { return 50; } },
     __proto__: defMock 
  };
//pass it to require
var glib = gas.require('./src', customMock);

//call some function from your app script library working with MailApp 
glib.sendMails();

Explanation

There is a difference what is module in google apps script and what is module in node. Google apps script module (or library) consist of several javascript files which shares common context in runtime.
All content of these files (functions and variable) is public. This incompatible with node.js approach where module is strictly single file and content is private by default. You need to use module.exports construct to make something visible.

gas-local allows to use google apps script project "as is" without any rewriting to use in node. All scripts from google apps script project are loaded to separate single context and doesn't mix with global context.

Installation

TODO

npm install gas-local --save

Testing

npm test

Test files located in test folder. Tests build around sample google app script module and ensure that this app script library is loaded correctly by gas-local. Sample library downloaded by gas-tools, but default download path has changed from src to test/src (in gapps.config.json).

Useful links