V3: Migrate to Vite (#221)

This is version 3 of the boilerplate, which makes significant changes to the build script and local development tooling. It replaces Webpack with Vite, which required some significant changes to how the local development setup works with Google Apps Script.

A new dev-server-wrapper.html file is used as the wrapper app in development, which is a standalone html + js file instead of a React app. This reduces the need for a complex build step for the wrapper app. Instead the file is just copied over for each entrypoing and the file location is changed with a "replace" step.

Due to the way Vite works, the html templates are changed a bit to support local development.

Vite doesn't easily allow completely separate multiple builds, so some Vite plugins and custom plugins are written to support multiple entrypoints (sidebars/dialogs). The externalization for large packages is now handled in the Vite config instead of a plugin, and by manually adding in the script tags into the index.html templates.

Additional changes here:
- yarn is now used instead of npm as package manager
- eslint configs are updated to support vite
- GitHub workflows for tests are updated to use yarn and other minor changes such as node versions and OS.
- A VS Code launch.json configuration is provided
- Dev wrapper setup has been updated (see above description)
- ES Modules (import/export) updated throughout
- Unneeded packages supporting webpack configurations are removed. Many packages have been upgraded. NPM scripts have been updated to use yarn.
- Removed `import React` due to Vite config.
- Added script tags to each template since webpack externalization plugin is no longer used
- Added <script type="module" src="./index.jsx"></script> to index.html templates to support Vite local development
- Changed src/server/sheets.js to .ts typescript as exemplar
- Updated tests to support yarn commands, Vite changes, and listening for Vite stdout triggers.
- Add Vite-style tsconfig.json
- README is updated

Author: enuchi

.eslintrc.json

@@ -1,19 +1,31 @@
 {
   "root": true,
-  "parser": "@babel/eslint-parser",
-  "extends": ["airbnb-base", "plugin:prettier/recommended"],
-  "plugins": ["prettier"],
+  "extends": [
+    "airbnb-base",
+    "plugin:prettier/recommended",
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:react-hooks/recommended"
+  ],
+  "plugins": ["react-refresh", "prettier"],
   "rules": {
     "prettier/prettier": "error",
     "camelcase": "warn",
     "import/prefer-default-export": "warn",
     "import/no-extraneous-dependencies": "warn",
     "prefer-object-spread": "warn",
-    "spaced-comment":"off"
+    "spaced-comment": "off",
+    "react-refresh/only-export-components": [
+      "warn",
+      { "allowConstantExport": true }
+    ]
   },
   "parserOptions": {
     "babelOptions": {
       "configFile": "./dev/.babelrc"
     }
-  }
+  },
+  "env": { "browser": true, "es2020": true },
+  "ignorePatterns": ["dist", ".eslintrc.json"],
+  "parser": "@typescript-eslint/parser"
 }

.github/workflows/integration-tests-basic.yaml

@@ -9,18 +9,18 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [macos-11, macos-latest, windows-latest]
+        os: [macos-12, macos-13, windows-2022]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
-        node-version: [14, 16, 18]
+        node-version: [18, 20]
     timeout-minutes: 8
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
-      - name: Install packages [npm ci]
-        run: npm ci
+      - name: Install packages
+        run: yarn install
       - name: Allow running mkcert on Mac
         run: sudo security authorizationdb write com.apple.trust-settings.admin allow
         if: runner.os == 'MacOS'
@@ -30,14 +30,14 @@ jobs:
       - name: Run mkcert setup [mkcert -install]
         run: mkcert -install
         if: runner.os == 'MacOS'
-      - name: Install https cert [npm setup:https]
-        run: npm run setup:https
+      - name: Install https cert [yarn setup:https]
+        run: yarn setup:https
         if: runner.os == 'MacOS'
       - run: | 
           mkdir certs
-          .\test\generate-cert.ps1
+          .\scripts\generate-cert.ps1
         shell: pwsh
         if: runner.os == 'Windows'
       - name: Run integration tests
-        run: npm run test:integration
+        run: yarn test:integration
         shell: bash

.github/workflows/integration-tests-extended.yaml

@@ -1,25 +1,26 @@
 name: Local integration tests - Extended Version
 
 on:
-  push:
+  pull_request:
+    branches: [main]
 
 jobs:
   extended-integration-test:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [macos-11, macos-latest, windows-latest]
+        os: [macos-12, macos-13, windows-2022]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
-        node-version: [14, 16, 18]
+        node-version: [18, 20]
     timeout-minutes: 11
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
-      - name: Install packages [npm ci]
-        run: npm ci
+      - name: Install packages
+        run: yarn install
       - name: Allow running mkcert on Mac
         run: sudo security authorizationdb write com.apple.trust-settings.admin allow
         if: runner.os == 'MacOS'
@@ -29,12 +30,12 @@ jobs:
       - name: Run mkcert setup [mkcert -install]
         run: mkcert -install
         if: runner.os == 'MacOS'
-      - name: Install https cert [npm setup:https]
-        run: npm run setup:https
+      - name: Install https cert [yarn setup:https]
+        run: yarn setup:https
         if: runner.os == 'MacOS'
       - run: |
           mkdir certs
-          .\test\generate-cert.ps1
+          .\scripts\generate-cert.ps1
         shell: pwsh
         if: runner.os == 'Windows'
       - name: Add .clasprc.json to home folder
@@ -65,10 +66,12 @@ jobs:
           S3_BUCKET_NAME: ${{ secrets.S3_BUCKET_NAME }}
           AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
           AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
-      - name: Build and deploy dev setup [npm run deploy:dev]
-        run: npm run deploy:dev
+      - name: Build and deploy dev setup [yarn deploy:dev]
+        run: yarn deploy:dev
         env:
           NODE_OPTIONS: '--max_old_space_size=4096'
       - name: Run integration tests
-        run: npm run test:integration:extended
+        # use ci-reporter to publish failing diff images to s3 bucket
+        # run: yarn test:integration:extended:ci-reporter
+        run: yarn test:integration:extended
         shell: bash

.npmrc

@@ -0,0 +1,21 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "chrome",
+      "request": "launch",
+      "name": "Launch spreadsheet with debugger",
+      "trace": true,
+      "sourceMaps": true,
+      "pauseForSourceMap": false,
+      "skipFiles": ["**/node_modules/**", "!${workspaceFolder}/**"],
+      "webRoot": "${workspaceFolder}/src/client",
+      // Need random open port for logging into spreadsheets:
+      // https://github.com/microsoft/vscode-js-debug/issues/918
+      "port": 12345,
+    }
+  ]
+}