Global types about gnome-shell

[schnz]

Take this with a grain of salt, since I am also not very familiar with the build scripts. But from what I can tell, this should work:

Step 1

Create a file packages/gnome-shell/src/global.d.ts:

import Shell from "@girs/shell-13";

declare global {
  const global: Shell.Global;
}

interface Math {
  /**
   * Returns {@link x} clamped to the inclusive range of {@link min} and {@link max}.
   * @see https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/8a8539ee6766058b39d0a5c0961a08f76799f4da/js/ui/environment.js#L357
   *
   * @param x The value to be clamped.
   * @param min The lower bound of the result.
   * @param max The upper bound of the result.
   */
  clamp(x: number, min: number, max: number): number;
}

// [...] further declarations as you see fit

Step 2

In packages/gnome-shell/scripts/generate-exports.js, packages/gnome-shell/scripts/generate-files.js, and packages/gnome-shell/scripts/generate-index.js you can add global.d.ts to the IGNORE_FILENAMES array. This prevents the d.ts file from being exported as gnome resource module etc.

Run yarn run build. The global.d.ts file should be part of the dist folder now and can be imported/referenced from downstream projects.

---

I haven't gave this much thought. @JumpLink does know the architecture alot better than I do :)

[JumpLink]

Thank you very much, I will look at this in detail as soon as possible

[swsnr]

@JumpLink @schnz I've opened #13 for this 🙂

[Freed-Wu]

The global.d.ts file should be part of the dist folder now

However, the document still said import '@girs/gnome-shell/extensions/global'; not import '@girs/gnome-shell/dist/extensions/global';