Generate a clasp project

Usage no npm install needed!

<script type="module">
  import generatorClasp from '';


generator-clasp NPM version Build Status Dependency Status Coverage percentage

Generate a clasp project with a bunch of useful files for a google sheets addon


First, install Yeoman and generator-clasp using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-clasp

Then generate your new project:

yo clasp

To finish setting up your clasp project:

  • Ensure that you are logged in to clasp
  • run clasp create to start the clasp cli
  • run npm i -S @types/google-apps-script to add type definitions for vscode autocomplete
  • Revel in the awesomeness of life :sunglasses:

Files generated

  • .claspignore
  • .gitignore with a few entries
  • and LICENSE
  • jsconfig.json and tsconfig.json for vscode
  • keys.ts to store keys locally (I'm still trying to figure out a better way to do this as there is no .env for gas)
  • A main Code.ts file with the name of the app autogenerated via prompt - Also contains biolerplate for onOpen and getting a spreadsheet, sheet and data
  • utils.ts file to hold some useful functions that I normally use (This is the major motivation for this generator)

Updating Generator

  • Make changes (only good ones please)
  • git add . && git commit -m "A useful message" && git push
  • npm publish

Getting To Know Yeoman

  • Yeoman has a heart of gold.
  • Yeoman is a person with feelings and opinions, but is very easy to work with.
  • Yeoman can be too opinionated at times but is easily convinced not to be.
  • Feel free to learn more about Yeoman.

Special Thanks


MIT © Joe Sasson


If you happen to find this useful, or think you may find it useful with some modification, I would love to chat! You can open an issue, or send me an email (I'll leave that up to you to figure out)