mirror of
https://github.com/bitwarden/browser
synced 2025-12-15 07:43:35 +00:00
9c1e2ebd67
* Use typescript-strict-plugin to iteratively turn on strict * Add strict testing to pipeline Can be executed locally through either `npm run test:types` for full type checking including spec files, or `npx tsc-strict` for only tsconfig.json included files. * turn on strict for scripts directory * Use plugin for all tsconfigs in monorepo vscode is capable of executing tsc with plugins, but uses the most relevant tsconfig to do so. If the plugin is not a part of that config, it is skipped and developers get no feedback of strict compile time issues. These updates remedy that at the cost of slightly more complex removal of the plugin when the time comes. * remove plugin from configs that extend one that already has it * Update workspace settings to honor strict plugin * Apply strict-plugin to native message test runner * Update vscode workspace to use root tsc version * `./node_modules/.bin/update-strict-comments` 🤖 This is a one-time operation. All future files should adhere to strict type checking. * Add fixme to `ts-strict-ignore` comments * `update-strict-comments` 🤖 repeated for new merge files
71 lines
2.3 KiB
TypeScript
71 lines
2.3 KiB
TypeScript
// FIXME: Update this file to be type safe and remove this and next line
|
|
// @ts-strict-ignore
|
|
// required to avoid linting errors when there are no flags
|
|
// eslint-disable-next-line @typescript-eslint/ban-types
|
|
export type SharedFlags = {
|
|
sdk?: boolean;
|
|
prereleaseBuild?: boolean;
|
|
};
|
|
|
|
// required to avoid linting errors when there are no flags
|
|
// eslint-disable-next-line @typescript-eslint/ban-types
|
|
export type SharedDevFlags = {
|
|
noopNotifications: boolean;
|
|
skipWelcomeOnInstall: boolean;
|
|
configRetrievalIntervalMs: number;
|
|
};
|
|
|
|
function getFlags<T>(envFlags: string | T): T {
|
|
if (typeof envFlags === "string") {
|
|
return JSON.parse(envFlags) as T;
|
|
} else {
|
|
return envFlags as T;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Gets the value of a feature flag from environment.
|
|
* All flags default to "on" (true).
|
|
* Only use for shared code in `libs`, otherwise use the client-specific function.
|
|
* @param flag The name of the feature flag to check
|
|
* @returns The value of the flag
|
|
*/
|
|
export function flagEnabled<Flags extends SharedFlags>(flag: keyof Flags): boolean {
|
|
const flags = getFlags<Flags>(process.env.FLAGS) ?? ({} as Flags);
|
|
return flags[flag] == null || !!flags[flag];
|
|
}
|
|
|
|
/**
|
|
* Gets the value of a dev flag from environment.
|
|
* Will always return false unless in development.
|
|
* Only use for shared code in `libs`, otherwise use the client-specific function.
|
|
* @param flag The name of the dev flag to check
|
|
* @returns The value of the flag
|
|
*/
|
|
export function devFlagEnabled<DevFlags extends SharedDevFlags>(flag: keyof DevFlags): boolean {
|
|
if (process.env.ENV !== "development") {
|
|
return false;
|
|
}
|
|
|
|
const devFlags = getFlags<DevFlags>(process.env.DEV_FLAGS);
|
|
return devFlags?.[flag] == null ? false : !!devFlags[flag];
|
|
}
|
|
|
|
/**
|
|
* Gets the value of a dev flag from environment.
|
|
* Will always return false unless in development.
|
|
* @param flag The name of the dev flag to check
|
|
* @returns The value of the flag
|
|
* @throws Error if the flag is not enabled
|
|
*/
|
|
export function devFlagValue<DevFlags extends SharedDevFlags>(
|
|
flag: keyof DevFlags,
|
|
): DevFlags[keyof DevFlags] {
|
|
if (!devFlagEnabled(flag)) {
|
|
throw new Error(`This method should not be called, it is protected by a disabled dev flag.`);
|
|
}
|
|
|
|
const devFlags = getFlags<DevFlags>(process.env.DEV_FLAGS);
|
|
return devFlags[flag];
|
|
}
|