refactor: update GObject import handling and enhance build process for better compatibility

Author: leandromqrs

build/plugins/gobject-decorator.ts

@@ -8,8 +8,18 @@ export const gobjectDecorator: Plugin = {
   name: 'gobject-decorator',
   setup(ctx) {
     ctx.onLoad({ filter: /\.ts$/ }, (args) => {
-      const source = readFileSync(args.path, 'utf8');
-      if (!source.includes('@GObject.registerClass')) return undefined;
+      const original = readFileSync(args.path, 'utf8');
+      let source = original;
+
+      // GJS requires a default import for GObject, but Aurora often uses namespace import.
+      // Rewrite "import * as GObject" to "import GObject" to ensure clean output.
+      if (source.includes('@girs/gobject-2.0')) {
+        source = source.replace(/import\s+\*\s+as\s+GObject\s+from\s+['"]@girs\/gobject-2\.0['"];?/g, "import GObject from '@girs/gobject-2.0';");
+      }
+
+      if (!source.includes('@GObject.registerClass')) {
+        return source !== original ? { contents: source, loader: 'ts' } : undefined;
+      }
       return { contents: transformGObjectDecorators(source), loader: 'ts' };
     });
   },

esbuild.ts

@@ -1,108 +1,61 @@
 import { build } from 'esbuild';
-import {
-  copyFileSync,
-  readFileSync,
-  readdirSync,
-  writeFileSync,
-  existsSync,
-} from 'node:fs';
+import { copyFileSync, readFileSync, readdirSync, writeFileSync } from 'node:fs';
 import { dirname, join, resolve } from 'node:path';
 import { fileURLToPath } from 'node:url';
-import AdmZip from 'adm-zip';
-import { format } from 'prettier';
+import { format, resolveConfig } from 'prettier';
 
 import { localExternals } from './build/plugins/local-externals.ts';
 import { createGirsResolver } from './build/plugins/girs-resolver.ts';
 import { gobjectDecorator } from './build/plugins/gobject-decorator.ts';
 import { addBlankLinesBetweenMembers } from './build/formatting.ts';
 
-interface ExtensionMetadata {
-  name: string;
-  version: string;
-  uuid: string;
-}
-
 const currentDir = dirname(fileURLToPath(import.meta.url));
-const metadataPath = resolve(currentDir, 'metadata.json');
-const metadata = JSON.parse(readFileSync(metadataPath, 'utf8')) as ExtensionMetadata;
 
 const srcDir = resolve(currentDir, 'src');
 const entryPoints = (readdirSync(srcDir, { recursive: true }) as string[])
   .filter((file) => file.endsWith('.ts') && !file.endsWith('.d.ts'))
   .map((file) => join('src', file));
 
-console.debug(`Building ${metadata.name} v${metadata.version}...`);
-
-const sharedOptions = {
-  outdir: 'dist',
-  outbase: 'src',
-  bundle: true,
-  plugins: [gobjectDecorator, localExternals, createGirsResolver(currentDir)],
-  // Do not remove the functions `enable()`, `disable()` and `init()`
-  treeShaking: false,
-  // firefox60  // Since GJS 1.53.90
-  // firefox68  // Since GJS 1.63.90
-  // firefox78  // Since GJS 1.65.90
-  // firefox91  // Since GJS 1.71.1
-  // firefox102 // Since GJS 1.73.2
-  target: 'firefox102' as const,
-  format: 'esm' as const,
-  external: ['gi://*', 'resource://*', 'system', 'gettext', 'cairo'],
-};
-
-Promise.all(
-  entryPoints.map((entryPoint) =>
-    build({ ...sharedOptions, entryPoints: [entryPoint] }),
-  ),
-)
-  .then(async () => {
-    const distDir = resolve(currentDir, 'dist');
-    const metaDist = resolve(distDir, 'metadata.json');
-    const schemasSrc = resolve(currentDir, 'schemas');
-    const styleFiles = [
-      'stylesheet.css',
-      'stylesheet-light.css',
-      'stylesheet-dark.css',
-    ];
-    const zipFilename = `${metadata.uuid}.zip`;
-    const zipDist = resolve(distDir, zipFilename);
-
-    // Format output files with prettier
-    const jsFiles = (readdirSync(distDir, { recursive: true }) as string[])
-      .filter((file) => file.endsWith('.js'));
-
-    for (const file of jsFiles) {
-      const filePath = resolve(distDir, file);
-      const content = readFileSync(filePath, 'utf8');
-      const formatted = await format(content, { parser: 'babel', filepath: filePath });
-      writeFileSync(filePath, addBlankLinesBetweenMembers(formatted));
-    }
+console.debug('Building extension...');
+
+try {
+  await build({
+    entryPoints,
+    outdir: 'dist',
+    outbase: 'src',
+    bundle: true,
+    plugins: [gobjectDecorator, localExternals, createGirsResolver(currentDir)],
+    treeShaking: false,
+    target: 'firefox102',
+    format: 'esm',
+    external: ['gi://*', 'resource://*', 'system', 'gettext', 'cairo'],
+  });
 
-    copyFileSync(metadataPath, metaDist);
+  const distDir = resolve(currentDir, 'dist');
+  const jsFiles = (readdirSync(distDir, { recursive: true }) as string[])
+    .filter((file) => file.endsWith('.js'));
+
+  console.debug('Formatting output files...');
+  
+  for (const file of jsFiles) {
+    const filePath = resolve(distDir, file);
+    const content = readFileSync(filePath, 'utf8');
+    
+    const prettierConfig = await resolveConfig(filePath) || {};
+    
+    const formatted = await format(content, { 
+      ...prettierConfig, 
+      parser: 'babel', 
+      filepath: filePath 
+    });
 
-    const zip: AdmZip = new AdmZip();
+    writeFileSync(filePath, addBlankLinesBetweenMembers(formatted));
+  }
 
-    for (const file of jsFiles) {
-      const filePath = resolve(distDir, file);
-      const dir = dirname(file);
-      zip.addLocalFile(filePath, dir === '.' ? '' : dir);
-    }
+  copyFileSync(resolve(currentDir, 'metadata.json'), resolve(distDir, 'metadata.json'));
 
-    styleFiles.forEach((styleFile) => {
-      const stylePath = resolve(distDir, styleFile);
-      if (existsSync(stylePath)) {
-        zip.addLocalFile(stylePath);
-      }
-    });
-    zip.addLocalFile(metaDist);
-    if (existsSync(schemasSrc)) {
-      zip.addLocalFolder(schemasSrc, 'schemas');
-    }
-    zip.writeZip(zipDist);
-
-    console.debug(`Build complete. Zip file: ${zipFilename}`);
-  })
-  .catch((error: unknown) => {
-    console.error('Build failed:', error);
-    process.exit(1);
-  });
+  console.debug('Build complete.');
+} catch (error) {
+  console.error('Build failed:', error);
+  process.exit(1);
+}

eslint.config.ts

@@ -17,6 +17,7 @@ export default [
         process: 'readonly',
         imports: 'readonly',
         globalThis: 'readonly',
+        global: 'readonly',
       },
       parserOptions: {
         tsconfigRootDir: import.meta.dirname,

justfile

@@ -3,68 +3,62 @@ ext_dir := env("HOME") / ".local/share/gnome-shell/extensions" / uuid
 toolbox_name := "gnome-shell-devel"
 toolbox_image := "registry.fedoraproject.org/fedora-toolbox:42"
 
-# List available commands
 default:
     @just --list
 
-# Install dependencies
 deps:
     yarn install
 
-# Build everything (CSS + TypeScript + zip)
 build: deps
     yarn build
 
-# Type-check without emitting
+package:
+    mkdir -p dist/target
+    cp metadata.json dist/metadata.json
+    cd dist && \
+      zip -r "target/{{ uuid }}.zip" . \
+        -x "target/*" \
+        -x "*.zip"
+
 validate:
     yarn validate
 
-# Lint the codebase
 lint:
     yarn lint
 
-# Watch SCSS files for changes
 watch:
     yarn watch:css
 
-# Install extension to GNOME Shell
-install: build
+install: build package
     mkdir -p {{ ext_dir }}
     rsync -a --exclude='*.zip' dist/ {{ ext_dir }}/
     cp -r schemas {{ ext_dir }}/ 2>/dev/null || true
     glib-compile-schemas {{ ext_dir }}/schemas/ 2>/dev/null || true
     @echo "Installed at: {{ ext_dir }}"
 
-# Uninstall extension
 uninstall:
     gnome-extensions disable {{ uuid }} 2>/dev/null || true
     rm -rf {{ ext_dir }}
     @echo "Uninstalled."
 
-# Quick update (rebuild + copy files, no full install)
 quick: build
     rsync -a --exclude='*.zip' dist/ {{ ext_dir }}/
     cp -r schemas {{ ext_dir }}/ 2>/dev/null || true
     glib-compile-schemas {{ ext_dir }}/schemas/ 2>/dev/null || true
     @echo "Files updated. Log out and back in to apply."
 
-# Show recent extension logs
 logs:
-    journalctl -b 0 /usr/bin/gnome-shell | grep "Aurora Shell" | tail -n 20
+    journalctl -b 0 /usr/bin/gnome-shell | grep "aurora"
 
-# Clean build artifacts
 clean:
     rm -rf dist
 
-# Full clean (artifacts + dependencies)
 distclean: clean
     rm -rf node_modules
 
-# Clean build + install
 all: clean build install
     @echo "Complete installation finished."
 
-# Run GNOME Shell with the extension (auto-detects --devkit or --nested)
 run: install
     #!/usr/bin/env bash
     set -e
@@ -78,7 +72,6 @@ run: install
     fi
     env XDG_CURRENT_DESKTOP=GNOME dbus-run-session gnome-shell "$mode"
 
-# Run GNOME Shell with the extension inside a toolbox (auto-detects --devkit or --nested)
 toolbox-run: install
     #!/usr/bin/env bash
     set -e
@@ -93,7 +86,6 @@ toolbox-run: install
     toolbox --container {{ toolbox_name }} run \
         env XDG_CURRENT_DESKTOP=GNOME dbus-run-session gnome-shell "$mode"
 
-# Create development toolbox for testing
 create-toolbox:
     toolbox create --image {{ toolbox_image }} {{ toolbox_name }}
     toolbox run --container {{ toolbox_name }} sudo dnf install -y gnome-shell glib2-devel

metadata.json

@@ -1,7 +1,7 @@
 {
     "name": "Aurora Shell",
     "description": "A customizable GNOME Shell extension that enhances the user experience with various modules and features.",
-    "version": "49",
+    "version": "49.2",
     "uuid": "aurora-shell@luminusos.github.io",
     "url": "https://github.com/luminusOS/aurora-shell",
     "settings-schema": "org.gnome.shell.extensions.aurora-shell",

package.json

@@ -7,7 +7,7 @@
   "private": true,
   "scripts": {
     "clear": "rm -rf dist",
-    "build:ts": "tsx esbuild.ts",
+    "build:ts": "npx tsc --noEmit && npx eslint src/ && tsx esbuild.ts",
     "build:css": "tsx sass.config.ts",
     "build": "yarn clear && yarn build:css && yarn build:ts",
     "lint": "cross-env NODE_OPTIONS=--import=tsx/esm eslint .",

src/extension.ts

@@ -1,7 +1,7 @@
 
 import '@girs/gjs';
 
-import Gio from "@girs/gio-2.0";
+import type Gio from "@girs/gio-2.0";
 import { Extension } from "@girs/gnome-shell/extensions/extension";
 
 import type { Module } from "./module.ts";
@@ -41,6 +41,7 @@ export default class AuroraShellExtension extends Extension {
   private _initializeModules(): void {
     for (const def of MODULE_REGISTRY) {
       if (this._settings?.get_boolean(def.settingsKey)) {
+        // @ts-ignore
         this._modules.set(def.key, MODULE_FACTORIES[def.key]());
       }
     }
@@ -67,6 +68,7 @@ export default class AuroraShellExtension extends Extension {
     }
     args.push(this);
 
+    // @ts-ignore
     this._settings.connectObject(...args);
   }
 
@@ -77,6 +79,7 @@ export default class AuroraShellExtension extends Extension {
     if (enabled && !existing) {
       console.log(`Aurora Shell: Enabling module ${def.key}`);
       try {
+        // @ts-ignore
         const module = MODULE_FACTORIES[def.key]();
         module.enable();
         this._modules.set(def.key, module);
@@ -97,6 +100,7 @@ export default class AuroraShellExtension extends Extension {
   override disable(): void {
     console.log('Aurora Shell: Disabling extension');
 
+    // @ts-ignore
     this._settings?.disconnectObject(this);
 
     for (const [name, module] of this._modules) {