@google/clasp 2.5.0 → 3.0.0-alpha1

package/build/src/commands/pull.js

@@ -1,18 +1,19 @@
-import { fetchProject, writeProjectFiles } from '../files.js';
-import { LOG } from '../messages.js';
-import { getProjectSettings, spinner, stopSpinner } from '../utils.js';
-/**
- * Force downloads all Apps Script project files into the local filesystem.
- * @param options.versionNumber {number} The version number of the project to retrieve.
- *                              If not provided, the project's HEAD version is returned.
- */
-export default async (options) => {
-    const { scriptId, rootDir } = await getProjectSettings();
-    if (scriptId) {
-        spinner.start(LOG.PULLING);
-        const files = await fetchProject(scriptId, options.versionNumber);
-        await writeProjectFiles(files, rootDir);
-        stopSpinner();
-    }
-};
-//# sourceMappingURL=pull.js.map
+import { Command } from 'commander';
+import { intl } from '../intl.js';
+import { withSpinner } from './utils.js';
+export const command = new Command('pull')
+    .description('Fetch a remote project')
+    .option('--versionNumber <version>', 'The version number of the project to retrieve.')
+    .action(async function (options) {
+    const clasp = this.opts().clasp;
+    const versionNumber = options.versionNumber;
+    const spinnerMsg = intl.formatMessage({ id: "jilcJH", defaultMessage: [{ type: 0, value: "Pulling files..." }] });
+    const files = await withSpinner(spinnerMsg, async () => {
+        return await clasp.files.pull(versionNumber);
+    });
+    files.forEach(f => console.log(`└─ ${f.localPath}`));
+    const successMessage = intl.formatMessage({ id: "4mRAfN", defaultMessage: [{ type: 0, value: "Pulled " }, { 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/push.js

@@ -1,84 +1,74 @@
-import fs from 'fs-extra';
-import multimatch from 'multimatch';
-import normalizeNewline from 'normalize-newline';
 import path from 'path';
-import chokidar from 'chokidar';
-import debouncePkg from 'debounce';
-import { loadAPICredentials } from '../auth.js';
-import { ClaspError } from '../clasp-error.js';
-import { Conf } from '../conf.js';
-import { FS_OPTIONS, PROJECT_MANIFEST_BASENAME, PROJECT_MANIFEST_FILENAME } from '../constants.js';
-import { DOTFILE } from '../dotfile.js';
-import { fetchProject, pushFiles } from '../files.js';
-import { overwritePrompt } from '../inquirer.js';
-import { isValidManifest } from '../manifest.js';
-import { LOG } from '../messages.js';
-import { getProjectSettings, spinner } from '../utils.js';
-const { debounce } = debouncePkg;
-const { readFileSync } = fs;
-const WATCH_DEBOUNCE_MS = 1000;
-const config = Conf.get();
-/**
- * Uploads all files into the script.google.com filesystem.
- * TODO: Only push the specific files that changed (rather than all files).
- * @param options.watch {boolean} If true, runs `clasp push` when any local file changes. Exit with ^C.
- */
-export default async (options) => {
-    await loadAPICredentials();
-    await isValidManifest();
-    const projectSettings = await getProjectSettings();
-    const { rootDir = '.' } = projectSettings;
-    if (options.watch) {
-        console.log(LOG.PUSH_WATCH);
-        // Debounce calls to push to coalesce 'save all' actions from editors
-        const debouncedPushFiles = debounce(async () => {
-            if (!options.force && (await manifestHasChanges(projectSettings)) && !(await confirmManifestUpdate())) {
-                console.log('Stopping push…');
-                return;
+import { Command } from 'commander';
+import inquirer from 'inquirer';
+import { intl } from '../intl.js';
+import { isInteractive, withSpinner } from './utils.js';
+export const command = new Command('push')
+    .description('Update the remote project')
+    .option('-f, --force', 'Forcibly overwrites the remote manifest.')
+    .option('-w, --watch', 'Watches for local file changes. Pushes when a non-ignored file changes.')
+    .action(async function (options) {
+    const clasp = this.opts().clasp;
+    const watch = options.watch;
+    let force = options.force;
+    const onChange = async (paths) => {
+        const isManifestUpdated = paths.findIndex(p => path.basename(p) === 'appsscript.json') !== -1;
+        if (isManifestUpdated && !force) {
+            force = await confirmManifestUpdate();
+            if (!force) {
+                const msg = intl.formatMessage({ id: "TItFfu", defaultMessage: [{ type: 0, value: "Skipping push." }] });
+                console.log(msg);
             }
-            console.log(LOG.PUSHING);
-            return pushFiles();
-        }, WATCH_DEBOUNCE_MS);
-        const patterns = await DOTFILE.IGNORE();
-        const watchCallback = async (filePath) => {
-            if (multimatch([filePath], patterns, { dot: true }).length > 0) {
-                // The file matches the ignored files patterns so we do nothing
-                return;
-            }
-            console.log(`\n${LOG.PUSH_WATCH_UPDATED(filePath)}\n`);
-            return debouncedPushFiles();
-        };
-        const watcher = chokidar.watch(rootDir, { persistent: true, ignoreInitial: true });
-        watcher.on('ready', pushFiles); // Push on start
-        watcher.on('add', watchCallback);
-        watcher.on('change', watchCallback);
-        watcher.on('unlink', watchCallback);
-        return;
+        }
+        const spinnerMsg = intl.formatMessage({ id: "qUq++d", defaultMessage: [{ type: 0, value: "Pushing files..." }] });
+        const files = await withSpinner(spinnerMsg, async () => {
+            return await clasp.files.push();
+        });
+        const successMessage = intl.formatMessage({ id: "aD3XSt", defaultMessage: [{ type: 0, value: "Pushed " }, { 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);
+        files.forEach(f => console.log(`└─ ${f.localPath}`));
+        return true;
+    };
+    const pendingChanges = await clasp.files.getChangedFiles();
+    if (pendingChanges.length) {
+        const paths = pendingChanges.map(f => f.localPath);
+        await onChange(paths);
     }
-    if (!options.force && (await manifestHasChanges(projectSettings)) && !(await confirmManifestUpdate())) {
-        console.log('Stopping push…');
+    else {
+        const msg = intl.formatMessage({ id: "X/QgBZ", defaultMessage: [{ type: 0, value: "Script is already up to date." }] });
+        console.log(msg);
+    }
+    if (!watch) {
         return;
     }
-    spinner.start(LOG.PUSHING);
-    await pushFiles();
-};
+    const onReady = async () => {
+        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) => {
+        if (!(await onChange(paths))) {
+            stopWatching();
+        }
+    });
+});
 /**
  * Confirms that the manifest file has been updated.
  * @returns {Promise<boolean>}
  */
-const confirmManifestUpdate = async () => (await overwritePrompt()).overwrite;
-/**
- * Checks if the manifest has changes.
- * @returns {Promise<boolean>}
- */
-const manifestHasChanges = async (projectSettings) => {
-    const { scriptId, rootDir = config.projectRootDirectory } = projectSettings;
-    const localManifest = readFileSync(path.join(rootDir, PROJECT_MANIFEST_FILENAME), FS_OPTIONS);
-    const remoteFiles = await fetchProject(scriptId, undefined, true);
-    const remoteManifest = remoteFiles.find(file => file.name === PROJECT_MANIFEST_BASENAME);
-    if (remoteManifest) {
-        return normalizeNewline(localManifest) !== normalizeNewline(remoteManifest.source);
+async function confirmManifestUpdate() {
+    if (!isInteractive()) {
+        return false;
     }
-    throw new ClaspError('remote manifest no found');
-};
-//# sourceMappingURL=push.js.map
+    const prompt = intl.formatMessage({ id: "Dh7naZ", defaultMessage: [{ type: 0, value: "Manifest file has been updated. Do you want to push and overwrite?" }] });
+    const answer = await inquirer.prompt([
+        {
+            default: false,
+            message: prompt,
+            name: 'overwrite',
+            type: 'confirm',
+        },
+    ]);
+    return answer.overwrite;
+}

package/build/src/commands/run-function.js

@@ -0,0 +1,61 @@
+import chalk from 'chalk';
+import { Command } from 'commander';
+import fuzzy from 'fuzzy';
+import autocomplete from 'inquirer-autocomplete-standalone';
+import { intl } from '../intl.js';
+import { isInteractive, withSpinner } from './utils.js';
+export const command = new Command('run-function')
+    .alias('run')
+    .description('Run a function in your Apps Scripts project')
+    .argument('[functionName]', 'The name of the function to run')
+    .option('--nondev', 'Run script function in non-devMode')
+    .option('-p, --params <value>', 'Parameters to pass to the function, as a JSON-encoded array')
+    .action(async function (functionName, options) {
+    var _a, _b;
+    const clasp = this.opts().clasp;
+    const devMode = !options.nondev; // Defaults to true
+    let params = [];
+    if (options.params) {
+        params = JSON.parse(options.params);
+    }
+    if (!functionName && isInteractive()) {
+        const allFunctions = await clasp.functions.getFunctionNames();
+        const source = async (input = '') => fuzzy.filter(input, allFunctions).map(element => ({
+            value: element.original,
+        }));
+        const prompt = intl.formatMessage({ id: "Y8u3Vb", defaultMessage: [{ type: 0, value: "Selection a function name" }] });
+        functionName = await autocomplete({
+            message: prompt,
+            source,
+        });
+    }
+    try {
+        const { error, response } = await withSpinner(`Running function: ${functionName}`, async () => {
+            return await clasp.functions.runFunction(functionName, params, devMode);
+        });
+        if (error && error.details) {
+            const { errorMessage, scriptStackTraceElements } = error.details[0];
+            const msg = intl.formatMessage({ id: "1l462L", defaultMessage: [{ type: 0, value: "Exception:" }] });
+            console.error(`${chalk.red(msg)}`, errorMessage, scriptStackTraceElements || []);
+            return;
+        }
+        if (response && response.result) {
+            console.log(response.result);
+        }
+        else {
+            const msg = intl.formatMessage({ id: "S/0IKk", defaultMessage: [{ type: 0, value: "No response." }] });
+            console.log(chalk.red(msg));
+        }
+    }
+    catch (error) {
+        if (((_a = error.cause) === null || _a === void 0 ? void 0 : _a.code) === 'NOT_AUTHORIZED') {
+            const msg = intl.formatMessage({ id: "HZmND2", defaultMessage: [{ type: 0, value: "Unable to run script function. Please make sure you have permission to run the script function." }] });
+            this.error(msg);
+        }
+        if (((_b = error.cause) === null || _b === void 0 ? void 0 : _b.code) === 'NOT_FOUND') {
+            const msg = intl.formatMessage({ id: "4wxpit", defaultMessage: [{ type: 0, value: "Script function not found. Please make sure script is deployed as API executable." }] });
+            this.error(msg);
+        }
+        throw error;
+    }
+});

package/build/src/commands/setup-logs.js

@@ -0,0 +1,12 @@
+import { Command } from 'commander';
+import { intl } from '../intl.js';
+import { assertGcpProjectConfigured, isInteractive, maybePromptForProjectId } from './utils.js';
+export const command = new Command('setup-logs').description('Setup Cloud Logging').action(async function () {
+    const clasp = this.opts().clasp;
+    if (!clasp.project.projectId && isInteractive()) {
+        await maybePromptForProjectId(clasp);
+    }
+    assertGcpProjectConfigured(clasp);
+    const successMessage = intl.formatMessage({ id: "mrsf6I", defaultMessage: [{ type: 0, value: "Script logs are now available in Cloud Logging." }] });
+    console.log(successMessage);
+});

package/build/src/commands/show-authorized-user.js

@@ -0,0 +1,18 @@
+import { Command } from 'commander';
+import { getUserInfo } from '../auth/auth.js';
+import { intl } from '../intl.js';
+export const command = new Command('show-authorized-user')
+    .description('Show information about the current authorizations state.')
+    .action(async function () {
+    const auth = this.opts().auth;
+    if (!auth.credentials) {
+        const msg = intl.formatMessage({ id: "ZqMsgV", defaultMessage: [{ type: 0, value: "Not logged in." }] });
+        console.log(msg);
+        return;
+    }
+    const user = await getUserInfo(auth.credentials);
+    const msg = intl.formatMessage({ id: "sZ9k34", defaultMessage: [{ type: 5, value: "email", options: { undefined: { value: [{ type: 0, value: "You are logged in as an unknown user." }] }, other: { value: [{ type: 0, value: "You are logged in as " }, { type: 1, value: "email" }, { type: 0, value: "." }] } } }] }, {
+        email: user === null || user === void 0 ? void 0 : user.email,
+    });
+    console.log(msg);
+});

package/build/src/commands/show-file-status.js

@@ -0,0 +1,34 @@
+import { Command } from 'commander';
+import { intl } from '../intl.js';
+import { withSpinner } from './utils.js';
+export const command = new Command('show-file-status')
+    .alias('status')
+    .description('Lists files that will be pushed by clasp')
+    .option('--json', 'Show status in JSON form')
+    .action(async function (options) {
+    var _a;
+    const clasp = this.opts().clasp;
+    const outputAsJson = (_a = options === null || options === void 0 ? void 0 : options.json) !== null && _a !== void 0 ? _a : false;
+    const spinnerMsg = intl.formatMessage({ id: "3pOneN", defaultMessage: [{ type: 0, value: "Analyzing project files..." }] });
+    const [filesToPush, untrackedFiles] = await withSpinner(spinnerMsg, async () => {
+        return await Promise.all([clasp.files.collectLocalFiles(), clasp.files.getUntrackedFiles()]);
+    });
+    if (outputAsJson) {
+        const json = JSON.stringify({
+            filesToPush: filesToPush.map(f => f.localPath),
+            untrackedFiles,
+        });
+        console.log(json);
+        return;
+    }
+    const trackedMsg = intl.formatMessage({ id: "eSUzih", defaultMessage: [{ type: 0, value: "Tracked files:" }] });
+    console.log(trackedMsg);
+    for (const file of filesToPush) {
+        console.log(`└─ ${file.localPath}`);
+    }
+    const untrackedMsg = intl.formatMessage({ id: "G6KFcG", defaultMessage: [{ type: 0, value: "Untracked files:" }] });
+    console.log(untrackedMsg);
+    for (const file of untrackedFiles) {
+        console.log(`└─ ${file}`);
+    }
+});

package/build/src/commands/tail-logs.js

@@ -0,0 +1,92 @@
+import chalk from 'chalk';
+import { Command } from 'commander';
+import { intl } from '../intl.js';
+import { assertGcpProjectConfigured, isInteractive, maybePromptForProjectId, withSpinner } from './utils.js';
+export const command = new Command('tail-logs')
+    .alias('logs')
+    .description('Print the most recent log entries')
+    .option('--json', 'Show logs in JSON form')
+    .option('--watch', 'Watch and print new logs')
+    .option('--simplified', 'Hide timestamps with logs')
+    .action(async function (options) {
+    const clasp = this.opts().clasp;
+    const { json, simplified, watch } = options;
+    const seenEntries = new Set();
+    let since;
+    const fetchAndPrintLogs = async () => {
+        const spinnerMsg = intl.formatMessage({ id: "VtwoAE", defaultMessage: [{ type: 0, value: "Fetching logs..." }] });
+        const entries = await withSpinner(spinnerMsg, async () => await clasp.logs.getLogEntries(since));
+        entries.results.reverse().forEach(entry => {
+            if (entry.timestamp) {
+                since = new Date(entry.timestamp);
+            }
+            const id = entry.insertId;
+            if (!id) {
+                return;
+            }
+            if (seenEntries.has(id)) {
+                return;
+            }
+            seenEntries.add(id);
+            const msg = formatEntry(entry, {
+                json,
+                simplified,
+            });
+            if (msg) {
+                console.log(msg);
+            }
+        });
+    };
+    if (!clasp.project.projectId && isInteractive()) {
+        await maybePromptForProjectId(clasp);
+    }
+    assertGcpProjectConfigured(clasp);
+    await fetchAndPrintLogs();
+    if (watch) {
+        const POLL_INTERVAL = 6000; // 6s
+        setInterval(async () => {
+            await fetchAndPrintLogs();
+        }, POLL_INTERVAL);
+    }
+});
+const severityColor = {
+    ERROR: chalk.red,
+    INFO: chalk.cyan,
+    DEBUG: chalk.green, // Includes timeEnd
+    NOTICE: chalk.magenta,
+    WARNING: chalk.yellow,
+};
+function formatEntry(entry, options) {
+    var _a, _b;
+    const { severity = '', timestamp = '', resource } = entry;
+    if (!resource) {
+        return undefined;
+    }
+    let functionName = (_b = (_a = resource.labels) === null || _a === void 0 ? void 0 : _a['function_name']) !== null && _b !== void 0 ? _b : 'N/A';
+    let payloadData = '';
+    if (options.json) {
+        payloadData = JSON.stringify(entry, null, 2);
+    }
+    else {
+        const { jsonPayload, textPayload } = entry;
+        if (textPayload) {
+            payloadData = textPayload;
+        }
+        else if (jsonPayload && jsonPayload.message) {
+            payloadData = jsonPayload.message;
+        }
+        else if (jsonPayload) {
+            payloadData = JSON.stringify(jsonPayload);
+        }
+        else {
+            return undefined;
+        }
+    }
+    const coloredSeverity = `${severityColor[severity](severity) || severity}`.padEnd(20);
+    functionName = functionName.padEnd(15);
+    payloadData = payloadData.padEnd(20);
+    if (options.simplified) {
+        return `${coloredSeverity} ${functionName} ${payloadData}`;
+    }
+    return `${coloredSeverity} ${timestamp} ${functionName} ${payloadData}`;
+}

package/build/src/commands/utils.js

@@ -0,0 +1,82 @@
+import cliTruncate from 'cli-truncate';
+import inquirer from 'inquirer';
+import open from 'open';
+import ora from 'ora';
+import { intl } from '../intl.js';
+export async function assertScriptConfigured(clasp) {
+    if (clasp.project.scriptId) {
+        return;
+    }
+    const msg = intl.formatMessage({ id: "2IuvqO", defaultMessage: [{ type: 0, value: "Script ID is not set, unable to continue." }] });
+    throw new Error(msg);
+}
+export async function assertGcpProjectConfigured(clasp) {
+    if (clasp.project.projectId) {
+        return;
+    }
+    const msg = intl.formatMessage({ id: "aD3+By", defaultMessage: [{ type: 0, value: "GCP project ID is not set, unable to continue." }] });
+    throw new Error(msg);
+}
+export async function maybePromptForProjectId(clasp) {
+    let projectId = clasp.project.getProjectId();
+    if (!projectId && isInteractive()) {
+        assertScriptConfigured(clasp);
+        const url = `https://script.google.com/home/projects/${clasp.project.scriptId}/settings`;
+        const instructions = intl.formatMessage({ id: "9gtRgW", defaultMessage: [{ type: 0, value: "The script is not bound to a GCP project. To view or configure the GCP project for this script, open " }, { type: 1, value: "url" }, { type: 0, value: " in your browser and follow instructions for setting up a GCP project. If a project is already configured, open the GCP project to get the project ID value." }] }, {
+            url,
+        });
+        console.log(instructions);
+        await openUrl(url);
+        const prompt = intl.formatMessage({ id: "Zde2DB", defaultMessage: [{ type: 0, value: "What is your GCP projectId?" }] });
+        const answer = await inquirer.prompt([
+            {
+                message: prompt,
+                name: 'projectId',
+                type: 'input',
+            },
+        ]);
+        projectId = answer.projectId;
+        await clasp.project.setProjectId(projectId);
+    }
+    return projectId;
+}
+const spinner = ora();
+export async function withSpinner(message, fn) {
+    // If not interactive terminal, skip spinner
+    if (!isInteractive()) {
+        return await fn();
+    }
+    spinner.start(message);
+    try {
+        return await fn();
+    }
+    finally {
+        if (spinner.isSpinning) {
+            spinner.stop();
+        }
+    }
+}
+export function ellipsize(value, length) {
+    return cliTruncate(value, length, { preferTruncationOnSpace: true }).padEnd(length);
+}
+// Exporting and wrapping to allow it to be toggled in tests
+export const claspEnv = {
+    isInteractive: process.stdout.isTTY
+};
+export function isInteractive() {
+    return claspEnv.isInteractive;
+}
+export async function openUrl(url) {
+    if (!isInteractive()) {
+        const msg = intl.formatMessage({ id: "kvR0OI", defaultMessage: [{ type: 0, value: "Open " }, { type: 1, value: "url" }, { type: 0, value: " in your browser to continue." }] }, {
+            url,
+        });
+        console.log(msg);
+        return;
+    }
+    const msg = intl.formatMessage({ id: "IVffJ2", defaultMessage: [{ type: 0, value: "Opening " }, { type: 1, value: "url" }, { type: 0, value: " in your browser." }] }, {
+        url,
+    });
+    console.log(msg);
+    return await open(url, { wait: false });
+}

package/build/src/constants.js

@@ -1,7 +1,4 @@
-// @see https://nodejs.org/api/fs.html#fs_fs_readfilesync_path_options
-export const FS_OPTIONS = { encoding: 'utf8' };
 // Names / Paths
 export const PROJECT_NAME = 'clasp';
 export const PROJECT_MANIFEST_BASENAME = 'appsscript';
 export const PROJECT_MANIFEST_FILENAME = `${PROJECT_MANIFEST_BASENAME}.json`;
-//# sourceMappingURL=constants.js.map