Auto-update notifications (#1110)

This commit is contained in:
Eddie Santos
2025-06-17 08:24:07 -07:00
committed by GitHub
parent bc3fa71234
commit c3971754bf
10 changed files with 715 additions and 9 deletions

View File

@@ -60,6 +60,8 @@ import {
import { useGitBranchName } from './hooks/useGitBranchName.js';
import { useTextBuffer } from './components/shared/text-buffer.js';
import * as fs from 'fs';
import { UpdateNotification } from './components/UpdateNotification.js';
import { checkForUpdates } from './utils/updateCheck.js';
const CTRL_EXIT_PROMPT_DURATION_MS = 1000;
@@ -76,6 +78,12 @@ export const AppWrapper = (props: AppProps) => (
);
const App = ({ config, settings, startupWarnings = [] }: AppProps) => {
const [updateMessage, setUpdateMessage] = useState<string | null>(null);
useEffect(() => {
checkForUpdates().then(setUpdateMessage);
}, []);
const { history, addItem, clearItems, loadHistory } = useHistory();
const {
consoleMessages,
@@ -467,6 +475,7 @@ const App = ({ config, settings, startupWarnings = [] }: AppProps) => {
<Box flexDirection="column" key="header">
<Header terminalWidth={terminalWidth} />
<Tips config={config} />
{updateMessage && <UpdateNotification message={updateMessage} />}
</Box>,
...history.map((h) => (
<HistoryItemDisplay

View File

@@ -0,0 +1,23 @@
/**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { Box, Text } from 'ink';
import { Colors } from '../colors.js';
interface UpdateNotificationProps {
message: string;
}
export const UpdateNotification = ({ message }: UpdateNotificationProps) => (
<Box
borderStyle="round"
borderColor={Colors.AccentYellow}
paddingX={1}
marginY={1}
>
<Text color={Colors.AccentYellow}>{message}</Text>
</Box>
);

View File

@@ -0,0 +1,35 @@
/**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import updateNotifier from 'update-notifier';
import { readPackageUp } from 'read-package-up';
import process from 'node:process';
export async function checkForUpdates(): Promise<string | null> {
// read-package-up looks for the closest package.json from cwd
const pkgResult = await readPackageUp({ cwd: process.cwd() });
if (!pkgResult) {
return null;
}
const { packageJson } = pkgResult;
const notifier = updateNotifier({
pkg: {
name: packageJson.name,
version: packageJson.version,
},
// check every time
updateCheckInterval: 0,
// allow notifier to run in scripts
shouldNotifyInNpmScript: true,
});
if (notifier.update) {
return `Gemini CLI update available! ${notifier.update.current}${notifier.update.latest}\nRun npm install -g ${packageJson.name} to update`;
}
return null;
}