Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/google/aside
🚀 Apps Script development with formatting, linting, testing and more!
https://github.com/google/aside
apps-script typescript
Last synced: 6 days ago
JSON representation
🚀 Apps Script development with formatting, linting, testing and more!
- Host: GitHub
- URL: https://github.com/google/aside
- Owner: google
- License: apache-2.0
- Created: 2023-03-20T12:21:47.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-02T15:01:25.000Z (2 months ago)
- Last Synced: 2024-10-02T09:18:46.605Z (about 1 month ago)
- Topics: apps-script, typescript
- Language: TypeScript
- Homepage:
- Size: 636 KB
- Stars: 322
- Watchers: 5
- Forks: 5
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING
- License: LICENSE
Awesome Lists containing this project
README
# Apps Script in IDE (ASIDE)
[](https://www.npmjs.com/package/@google/aside)
[](https://github.com/google/aside/actions/workflows/ci.yml)
[](https://github.com/google/gts)
## Overview
Apps Script in IDE (ASIDE) supports modern, robust and scalable Apps Script development by providing a framework for a local coding environment capable of formatting, linting, testing and much more.
Here are the main features:
- **TypeScript**
Write your code in TypeScript. It will be automatically compiled and bundled when deploying
- **Formatting / Linting**
Leverage the power of ESLint and Prettier to enforce a unique coding style amongst collaborators
- **Testing**
Use Jest to test your code before deploying
- **Multiple Environments**
Seemlessly switch between `dev` and `prod` environments to push your code to
## Getting Started
The simplest way to get started is:
```
npx @google/aside init
```
## What it does
After running the `init` command above, ASIDE will go ahead and do the following:
- **Add configuration files**
E.g. for ESLint, Prettier, Jest, ...
- **Set convenience scripts in package.json**
Those scripts include: `lint`, `build` and `deploy`, among others
- **Install necessary dependencies**
Everything required for formatting, linting, testing, etc. will be installed automatically
- **Set up clasp**
ASIDE is using [clasp](https://github.com/google/clasp) to pull and push code from and to Apps Script
- **(Optionally) Create an Angular Material UI**
ASIDE will run the necessary commands to create an Angular application with Angular Material components, if the option is chosen
## Options
You can provide the `init` command with some convenience options:
- `--yes` / `-y`
Answer 'yes' to all prompts
- `--no` / `-n`
Answer 'no' to all prompts
- `--title`/ `-t`
Set project title without being asked for it
- `--script-dev`
Set Script ID for dev environment without being asked for it
- `--script-prod`
Set Script ID for production environment without being asked for it
## Troubleshooting
### Unknown token 'export'
While bundling generally resolves all `export`s and `import`s it keeps `export`s in the entrypoint causing `clasp` to fail pushing. This can be an issue for example if you're trying to export functions from `index.ts` for testing.
The recommended approach is to use the entrypoint (`index.ts`) only to expose global functions to Apps Script while importing all business logic from separate modules.
### Module not included in bundle
Bundling includes treeshaking of unused files to keep the bundle size as small as possible. If any of your modules contain only global functions with no import-path leading to the entrypoint (e.g. to be called from the menu), those would not be included in the bundle.
To avoid this, you can use a [side-effect import](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import#import_a_module_for_its_side_effects_only).
```ts
import './path/to/module';
```
This will ensure that Rollup will not remove it from the bundle.
## Disclaimer
This is not an officially supported Google product.