@google/clasp 3.0.2-alpha → 3.0.3-alpha

package/README.md

@@ -81,7 +81,7 @@ clasp
 - [`clasp clone-script <scriptId | scriptURL> [versionNumber] [--rootDir <dir>]`](#clone)
 - [`clasp pull [--versionNumber]`](#pull)
 - [`clasp push [--watch] [--force]`](#push)
-- [`clasp status [--json]`](#status)
+- [`clasp show-file-status [--json]`](#status)
 - [`clasp open-script](#open)
 - [`clasp list-deployments`](#deployments)
 - [`clasp create-deployment [--versionNumber <version>] [--description <description>] [--deploymentId <id>]`](#deploy)
@@ -111,9 +111,10 @@ robust support for Typescript features along with ESM module and NPM package sup
 
 There are several template projects on GitHub that show how to transform Typescript code into Apps Script that are all excellent choices.
 
-* https://github.com/sqrrrl/apps-script-typescript-rollup-starter
 * https://github.com/WildH0g/apps-script-engine-template
 * https://github.com/tomoyanakano/clasp-typescript-template
+* https://github.com/google/aside
+* https://github.com/sqrrrl/apps-script-typescript-rollup-starter
 
 
 #### Command renames
@@ -182,6 +183,13 @@ https://www.googleapis.com/auth/userinfo.profile
 https://www.googleapis.com/auth/cloud-platform
 ```
 
+### Allow-list clasp
+
+If your organization restricts authorization for third-party apps, you may either:
+
+* Request your admin allow-list clasp's client id `1072944905499-vm2v2i5dvn0a0d2o4ca36i1vge8cvbn0.apps.googleusercontent.com`
+* Set up an internal-only GCP project for clasp as described in the previous section.
+
 ### Service accounts
 
 Use the `--adc` option on any command to read credentials from the environemtn using Google Cloud's [application default credentials](https://cloud.google.com/docs/authentication/application-default-credentials) mechanism.
@@ -315,7 +323,6 @@ Logs the user in. Saves the client credentials to a `.clasprc.json` file in the
 
 - `--no-localhost`: Do not run a local server, manually enter code instead.
 - `--creds <file>`: Use custom credentials used for `clasp run`. Saves a `.clasprc.json` file to current working directory. This file should be private!
-- `--status`: Print who you are currently logged in as, if anyone.
 - `--redirect-port <port>`: Specify a custom port for the local redirect server during the login process. Useful for environments where a specific port is required.
 
 #### Examples

package/build/src/auth/auth.js

@@ -1,15 +1,18 @@
 import { readFileSync } from 'fs';
 import os from 'os';
 import path from 'path';
+import Debug from 'debug';
 import { GoogleAuth, OAuth2Client } from 'google-auth-library';
 import { google } from 'googleapis';
 import { FileCredentialStore } from './file_credential_store.js';
 import { LocalServerAuthorizationCodeFlow } from './localhost_auth_code_flow.js';
 import { ServerlessAuthorizationCodeFlow } from './serverless_auth_code_flow.js';
+const debug = Debug('clasp:auth');
 export async function initAuth(options) {
     var _a, _b, _c;
     const authFilePath = (_a = options.authFilePath) !== null && _a !== void 0 ? _a : path.join(os.homedir(), '.clasprc.json');
     const credentialStore = new FileCredentialStore(authFilePath);
+    debug('Initializng auth from %s', options.authFilePath);
     if (options.useApplicationDefaultCredentials) {
         const credentials = await createApplicationDefaultCredentials();
         return {
@@ -26,15 +29,23 @@ export async function initAuth(options) {
     };
 }
 export async function getUserInfo(credentials) {
+    debug('Fetching user info');
     const api = google.oauth2('v2');
-    const res = await api.userinfo.get({ auth: credentials });
-    if (res.status !== 200) {
+    try {
+        const res = await api.userinfo.get({ auth: credentials });
+        if (!res.data) {
+            debug('No user info returned');
+            return undefined;
+        }
+        return {
+            email: res.data.email,
+            id: res.data.id,
+        };
+    }
+    catch (err) {
+        debug('Error while fetching userinfo: %O', err);
         return undefined;
     }
-    return {
-        email: res.data.email,
-        id: res.data.id,
-    };
 }
 /**
  * Creates an an unauthorized oauth2 client given the client secret file. If no path is provided,
@@ -57,13 +68,16 @@ export async function getAuthorizedOAuth2Client(store, userKey) {
     if (!userKey) {
         userKey = 'default';
     }
+    debug('Loading credentials for user %s', userKey);
     const savedCredentials = await store.load(userKey);
     if (!savedCredentials) {
+        debug('No saved credentials found.');
         return undefined;
     }
     const client = new GoogleAuth().fromJSON(savedCredentials);
     client.setCredentials(savedCredentials);
     client.on('tokens', async (tokens) => {
+        debug('Saving refreshed token for user %s', userKey);
         const refreshedCredentials = {
             ...savedCredentials,
             expiry_date: tokens.expiry_date,
@@ -85,13 +99,16 @@ export async function getAuthorizedOAuth2Client(store, userKey) {
 export async function authorize(options) {
     let flow;
     if (options.noLocalServer) {
+        debug('Starting auth with serverless flow');
         flow = new ServerlessAuthorizationCodeFlow(options.oauth2Client);
     }
     else {
+        debug('Starting auth with local server flow');
         flow = new LocalServerAuthorizationCodeFlow(options.oauth2Client);
     }
     const client = await flow.authorize(options.scopes);
     await saveOauthClientCredentials(options.store, options.userKey, client);
+    debug('Auth complete');
     return client;
 }
 async function saveOauthClientCredentials(store, userKey, oauth2Client) {
@@ -110,8 +127,10 @@ async function saveOauthClientCredentials(store, userKey, oauth2Client) {
             access_token: tokens.access_token,
             id_token: tokens.access_token,
         };
+        debug('Saving refreshed credentials for user %s', userKey);
         await store.save(userKey, refreshedCredentials);
     });
+    debug('Saving credentials for user %s', userKey);
     await store.save(userKey, savedCredentials);
 }
 /**
@@ -120,6 +139,7 @@ async function saveOauthClientCredentials(store, userKey, oauth2Client) {
  * @returns
  */
 function createOauthClient(clientSecretPath) {
+    debug('Creating new oauth client from %s', clientSecretPath);
     if (!clientSecretPath) {
         throw new Error('Invalid credentials');
     }
@@ -134,11 +154,13 @@ function createOauthClient(clientSecretPath) {
         throw new Error('No localhost redirect URL found');
     }
     // create an oAuth client to authorize the API call
-    return new OAuth2Client({
+    const client = new OAuth2Client({
         clientId: keys.client_id,
         clientSecret: keys.client_secret,
         redirectUri: redirectUrl,
     });
+    debug('Created built-in oauth client, id: %s', client._clientId);
+    return client;
 }
 /**
  * Creates an aunthorized oauth2 client using the default id & secret.
@@ -147,11 +169,13 @@ function createOauthClient(clientSecretPath) {
  */
 function createDefaultOAuthClient() {
     // Default client
-    return new OAuth2Client({
+    const client = new OAuth2Client({
         clientId: '1072944905499-vm2v2i5dvn0a0d2o4ca36i1vge8cvbn0.apps.googleusercontent.com',
         clientSecret: 'v6V3fKV_zWU7iw1DrpO1rknX',
         redirectUri: 'http://localhost',
     });
+    debug('Created built-in oauth client, id: %s', client._clientId);
+    return client;
 }
 export async function createApplicationDefaultCredentials() {
     const defaultCreds = await new GoogleAuth({
@@ -170,6 +194,7 @@ export async function createApplicationDefaultCredentials() {
     }).getClient();
     // Remove this check after https://github.com/googleapis/google-auth-library-nodejs/issues/1677 fixed
     if (defaultCreds instanceof OAuth2Client) {
+        debug('Created service account credentials, id: %s', defaultCreds._clientId);
         return defaultCreds;
     }
     return undefined;

package/build/src/commands/clone-script.js

@@ -56,7 +56,7 @@ export const command = new Command('clone-script')
             return files;
         });
         files.forEach(f => console.log(`└─ ${f.localPath}`));
-        const successMessage = intl.formatMessage({ id: "Hw9Gqn", defaultMessage: [{ type: 0, value: "Warning: files in subfolder are not accounted for unless you set a .claspignore file. Cloned " }, { type: 6, value: "count", options: { "=0": { value: [{ type: 0, value: "no files." }] }, one: { value: [{ type: 0, value: "one file." }] }, other: { value: [{ type: 7 }, { type: 0, value: " files" }] } }, offset: 0, pluralType: "cardinal" }, { type: 0, value: "." }] }, {
+        const successMessage = intl.formatMessage({ id: "XABSyD", defaultMessage: [{ type: 0, value: "Cloned " }, { type: 6, value: "count", options: { "=0": { value: [{ type: 0, value: "no files." }] }, one: { value: [{ type: 0, value: "one file." }] }, other: { value: [{ type: 7 }, { type: 0, value: " files" }] } }, offset: 0, pluralType: "cardinal" }, { type: 0, value: "." }] }, {
             count: files.length,
         });
         console.log(successMessage);

package/build/src/commands/create-script.js

@@ -37,19 +37,26 @@ export const command = new Command('create-script')
             this.error(msg);
         }
         const spinnerMsg = intl.formatMessage({ id: "TMfpGK", defaultMessage: [{ type: 0, value: "Creating script..." }] });
-        const { parentId } = await withSpinner(spinnerMsg, async () => await clasp.project.createWithContainer(name, mimeType));
-        const url = `https://drive.google.com/open?id=${parentId}`;
-        const successMessage = intl.formatMessage({ id: "11VZzp", defaultMessage: [{ type: 0, value: "Created new container: [url}" }] }, {
-            url,
+        const { parentId, scriptId } = await withSpinner(spinnerMsg, async () => await clasp.project.createWithContainer(name, mimeType));
+        const parentUrl = `https://drive.google.com/open?id=${parentId}`;
+        const scriptUrl = `https://script.google.com/d/${scriptId}/edit`;
+        const successMessage = intl.formatMessage({ id: "yf9wXJ", defaultMessage: [{ type: 0, value: "Created new document: " }, { type: 1, value: "parentUrl" }, { type: 1, value: "br" }, { type: 0, value: "Created new script: " }, { type: 1, value: "scriptUrl" }] }, {
+            parentUrl,
+            scriptUrl,
+            br: '\n',
         });
         console.log(successMessage);
     }
     else {
         const spinnerMsg = intl.formatMessage({ id: "TMfpGK", defaultMessage: [{ type: 0, value: "Creating script..." }] });
         const scriptId = await withSpinner(spinnerMsg, async () => await clasp.project.createScript(name, parentId));
-        const url = `https://script.google.com/d/${scriptId}/edit`;
-        const successMessage = intl.formatMessage({ id: "NUzw0t", defaultMessage: [{ type: 0, value: "Created new script: " }, { type: 1, value: "url" }] }, {
-            url,
+        const parentUrl = `https://drive.google.com/open?id=${parentId}`;
+        const scriptUrl = `https://script.google.com/d/${scriptId}/edit`;
+        const successMessage = intl.formatMessage({ id: "0a429S", defaultMessage: [{ type: 0, value: "Created new script: " }, { type: 1, value: "scriptUrl" }, { type: 5, value: "parentId", options: { undefined: { value: [] }, other: { value: [{ type: 1, value: "br" }, { type: 0, value: "Bound to document: " }, { type: 1, value: "parentUrl" }] } } }] }, {
+            parentId,
+            parentUrl,
+            scriptUrl,
+            br: '\n',
         });
         console.log(successMessage);
     }

package/build/src/commands/push.js

@@ -48,7 +48,7 @@ export const command = new Command('push')
         const msg = intl.formatMessage({ id: "m/C0lF", defaultMessage: [{ type: 0, value: "Waiting for changes..." }] });
         console.log(msg);
     };
-    const stopWatching = clasp.files.watchLocalFiles(onReady, async (paths) => {
+    const stopWatching = await clasp.files.watchLocalFiles(onReady, async (paths) => {
         if (!(await onChange(paths))) {
             stopWatching();
         }

package/build/src/core/clasp.js

@@ -108,7 +108,7 @@ export async function initClaspInstance(options) {
         project: {
             scriptId: config.scriptId,
             projectId: config.projectId,
-            parentId: config.parentId,
+            parentId: firstValue(config.parentId),
         },
     });
 }
@@ -216,3 +216,9 @@ async function hasReadAccess(path) {
     }
     return true;
 }
+function firstValue(values) {
+    if (Array.isArray(values) && values.length > 0) {
+        return values[0];
+    }
+    return values;
+}

package/build/src/core/files.js

@@ -28,8 +28,15 @@ async function getLocalFiles(rootDir, ignorePatterns, recursive) {
         fdirBuilder = fdirBuilder.withMaxDepth(0);
     }
     const files = await fdirBuilder.crawl(rootDir).withPromise();
-    const filteredFiles = micromatch.not(files, ignorePatterns, { dot: true });
-    debug('Filtered %d files from ignore rules', files.length - filteredFiles.length);
+    let filteredFiles;
+    if (ignorePatterns && ignorePatterns.length) {
+        filteredFiles = micromatch.not(files, ignorePatterns, { dot: true });
+        debug('Filtered %d files from ignore rules', files.length - filteredFiles.length);
+    }
+    else {
+        debug('Ignore rules are empty, using all files.');
+        filteredFiles = files;
+    }
     filteredFiles.sort((a, b) => a.localeCompare(b));
     return filteredFiles[Symbol.iterator]();
 }
@@ -104,11 +111,14 @@ function debounceFileChanges(callback, delayMs) {
     return function (path) {
         // Already tracked as changed, ignore
         if (collectedPaths.includes(path)) {
+            debug('Ignoring pending file change for path %s', path);
             return;
         }
+        debug('Debouncing change for path %s', path);
         collectedPaths.push(path);
         clearTimeout(timeoutId);
         timeoutId = setTimeout(() => {
+            debug('Firing debounced file');
             callback(collectedPaths);
             collectedPaths = [];
         }, delayMs);
@@ -188,21 +198,37 @@ export class Files {
         const ignorePatterns = (_a = this.options.files.ignorePatterns) !== null && _a !== void 0 ? _a : [];
         const collector = debounceFileChanges(onFilesChanged, 500);
         const onChange = async (path) => {
+            debug('Have file changes: %s', path);
             collector(path);
         };
+        let matcher;
+        if (ignorePatterns && ignorePatterns.length) {
+            matcher = (file, stats) => {
+                if (!(stats === null || stats === void 0 ? void 0 : stats.isFile())) {
+                    return false;
+                }
+                file = path.relative(this.options.files.projectRootDir, file);
+                const ignore = micromatch.not([file], ignorePatterns, { dot: true }).length === 0;
+                return ignore;
+            };
+        }
         const watcher = chokidar.watch(this.options.files.contentDir, {
             persistent: true,
             ignoreInitial: true,
             cwd: this.options.files.contentDir,
-            ignored: file => {
-                return micromatch.not([file], ignorePatterns, { dot: true }).length === 0;
-            },
+            ignored: matcher,
         });
         watcher.on('ready', onReady); // Push on start
         watcher.on('add', onChange);
         watcher.on('change', onChange);
         watcher.on('unlink', onChange);
-        return async () => await watcher.close();
+        watcher.on('error', err => {
+            debug('Unexpected error during watch: %O', err);
+        });
+        return async () => {
+            debug('Stopping watch');
+            await watcher.close();
+        };
     }
     async getChangedFiles() {
         const [localFiles, remoteFiles] = await Promise.all([this.collectLocalFiles(), this.fetchRemote()]);

package/build/src/core/project.js

@@ -285,6 +285,7 @@ export class Project {
         const settings = {
             scriptId: this.options.project.scriptId,
             rootDir: srcDir,
+            parentId: this.options.project.parentId,
             projectId: this.options.project.projectId,
             scriptExtensions: this.options.files.fileExtensions['SERVER_JS'],
             htmlExtensions: this.options.files.fileExtensions['HTML'],

package/build/src/experiments.js

@@ -7,10 +7,6 @@ export function isEnabled(experimentName, defaultValue = false) {
     if (envVarValue.toLowerCase() === 'true' || envVarValue === '1') {
         return true;
     }
-    if (envVarValue.toLowerCase() === 'false' || envVarValue === '0') {
-        return false;
-    }
-    // If it's not a boolean, return the raw string value (for string experiments)
-    return envVarValue;
+    return false;
 }
 export const INCLUDE_USER_HINT_IN_URL = isEnabled('enable_user_hints');

package/build/src/index.js

@@ -20,6 +20,7 @@
  */
 import Debug from 'debug';
 import loudRejection from 'loud-rejection';
+import { CommanderError } from 'commander';
 import { makeProgram } from './commands/program.js';
 const debug = Debug('clasp:cli');
 // Suppress warnings about punycode and other issues caused by dependencies
@@ -34,7 +35,10 @@ try {
 }
 catch (error) {
     debug('Error: %O', error);
-    if (error instanceof Error) {
+    if (error instanceof CommanderError) {
+        debug('Ignoring commander error, output already logged');
+    }
+    else if (error instanceof Error) {
         process.exitCode = 1;
         console.error(error.message);
     }

package/docs/run.md

@@ -8,7 +8,7 @@ To use `clasp run`, you need to complete 5 steps:
 
 - Set up the **Project ID** in your `.clasp.json` if missing.
 - Create an **OAuth Client ID** of type `Desktop Application`. Download as `client_secret.json`.
-- `clasp login --creds client_secret.json` with this downloaded file.
+- `clasp login --creds client_secret.json --user <key>` with this downloaded file.
 - Add the following to `appsscript.json`:
   ```json
   "executionApi": {
@@ -33,12 +33,13 @@ To use `clasp run`, you need to complete 5 steps:
     - If the `Project Number` is missing,
       - Click `Change Project`, paste the PROJECT_NUMBER, and click `Set project`
 1. Use your own OAuth 2 client. Create one by following these instructions:
-    - `clasp open --creds`
+    - `clasp open-credentials-setup`
     - Press **Create credentials** > **OAuth client ID**
     - Application type: **Desktop App**
     - **Create** > **OK**
-    - Download the file (⬇), move it to your directory, and name it `creds.json`. Please keep this file secret!
-1. Call `clasp login --user <name> --creds creds.json`
+    - Download the file (⬇), move it to your directory, and name it `client_secret.json`. Please keep this file secret!
+1. Ensure that the [scopes required to run the script are listed in `appsscript.json`](https://developers.google.com/apps-script/concepts/scopes#set-explicit).
+1. Call `clasp login --user <name> --use-project-scopes --creds client_secret.json`
 1. Add the following to `appsscript.json`:
       ```json
       "executionApi": {
@@ -74,6 +75,6 @@ To run functions that use these scopes, you must add the scopes to your Apps Scr
 
 - `clasp open`
 - `File > Project Properties > Scopes`
-- Add these scopes to your `appsscript.json`.
-- Log in again: `clasp login --creds creds.json`. This will add these scopes to your credentials.
+- Add these [scopes to your `appsscript.json`](https://developers.google.com/apps-script/concepts/scopes#set-explicit).
+- Log in again: `clasp login --user <name> --use-project-scopes --creds creds.json`. This will add these scopes to your credentials.
 - `clasp run --user <name> sendMail`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google/clasp",
-  "version": "3.0.2-alpha",
+  "version": "3.0.3-alpha",
   "description": "Develop Apps Script Projects locally",
   "type": "module",
   "exports": "./build/src/index.js",