Skip to content

Fix: Export the Console Interface as ConsoleLike #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 24, 2025
Merged

Fix: Export the Console Interface as ConsoleLike #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
598f1b4
Fix: Export the Console Interface as `ConsoleLike`, so that its type …
Totto16 Mar 23, 2025
1752816
feat: add example usage of the getLogger() API to the example extension
Totto16 Mar 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion examples/hello-world/src/extension.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@ import '@girs/gjs'; // For global types like `log()`
import St from '@girs/st-16';

import '@girs/gnome-shell/extensions/global'; // For global shell types
import { Extension, gettext as _ } from '@girs/gnome-shell/extensions/extension';
import { Extension, gettext as _, type ConsoleLike } from '@girs/gnome-shell/extensions/extension';
import PanelMenu from '@girs/gnome-shell/ui/panelMenu';
import * as Main from '@girs/gnome-shell/ui/main';

export default class ExampleExtension extends Extension {
private _indicator: PanelMenu.Button | null = null;
private _console: ConsoleLike | null = null;

override enable() {
if (this._indicator !== null) {
Expand All @@ -26,10 +27,14 @@ export default class ExampleExtension extends Extension {

// Add the indicator to the panel
Main.panel.addToStatusArea(this.uuid, this._indicator);

this._console = this.getLogger();
this._console?.log('Hello from the example extension');
}

override disable() {
this._indicator?.destroy();
this._indicator = null;
this._console = null;
}
}
2 changes: 2 additions & 0 deletions packages/gnome-shell/src/extensions/extension.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
export type { ExtensionMetadata } from '../types/extension-metadata.js';

export type { ConsoleLike } from './sharedInternals.js';
import type { ExtensionBase, TranslationFunctions } from './sharedInternals.js';
export class Extension extends ExtensionBase {
static defineTranslationFunctions(url: string): TranslationFunctions;
Expand Down
16 changes: 10 additions & 6 deletions packages/gnome-shell/src/extensions/sharedInternals.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,14 +151,10 @@ export class GettextWrapper {
}

/**
* @see https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/extensions/sharedInternals.js#L9
* @see https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/extensions/sharedInternals.js#L285
* @version 48
*/
declare class Console {
#extension: ExtensionBase;

constructor(ext: ExtensionBase);

export interface ConsoleLike {
log(...args: any[]): void;

warn(...args: any[]): void;
Expand All @@ -177,3 +173,11 @@ declare class Console {

groupEnd(): void;
}

declare interface Console extends ConsoleLike {}

declare class Console implements ConsoleLike {
#extension: ExtensionBase;

constructor(ext: ExtensionBase);
}