GNOME Shell Extension Starter

A template for creating GNOME Shell extensions using TypeScript.

This template uses @girs/gnome-shell to provide the types, Rollup to transpile/bundle the extension, and Biomejs for linting and formatting.

All output files are human readable including node modules, no minification is done.

Getting Started

Clone repository and install dependencies:

git clone https://github.com/SamyzKhalil/gnome-shell-extension-ts-template
cd gnome-shell-extension-ts-template
pnpm install

Scripts

• pnpm run build: Bundle the src to out/dist directory.
• pnpm run pack: Zip out/dist using gnome-extension to out directory.
• pnpm run deploy: Build and pack the extension, then install it using gnome-extension.
• pnpm run format: Format code using Biomejs.
• pnpm run lint: Lint code using Biomejs.

Accreditation

This template is "inspired" by https://github.com/gTile/gTile