@google/clasp
Version:
Develop Apps Script Projects locally
36 lines (35 loc) • 1.71 kB
JavaScript
// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// This file provides functionality for managing experimental features in clasp
// through environment variables, allowing features to be toggled on or off.
/**
* Checks if an experimental feature is enabled via environment variables.
* The environment variable is expected to be in the format `CLASP_EXPERIMENT_NAME_IN_UPPERCASE`.
* Truthy values are 'true' (case-insensitive) or '1'.
* @param {string} experimentName - The name of the experiment (e.g., "enable_user_hints").
* @param {boolean} [defaultValue=false] - The default value if the environment variable is not set.
* @returns {boolean} True if the experiment is enabled, false otherwise.
*/
export function isEnabled(experimentName, defaultValue = false) {
const envVarName = `CLASP_${experimentName.toUpperCase()}`;
const envVarValue = process.env[envVarName];
if (envVarValue === undefined || envVarValue === null) {
return defaultValue;
}
if (envVarValue.toLowerCase() === 'true' || envVarValue === '1') {
return true;
}
return false;
}
export const INCLUDE_USER_HINT_IN_URL = isEnabled('enable_user_hints');