Skip to content

Latest commit

 

History

History
70 lines (48 loc) · 1.77 KB

DEVELOPING.md

File metadata and controls

70 lines (48 loc) · 1.77 KB
Raw

gSnap development

Installation from Source

Even an everyday user may wish to install the latest version from GitHub. It's easy:

  1. Clone the repository to a folder of your choice.
git clone https://github.com/GnomeSnapExtensions/gSnap.git

  1. Install dependencies.

    You will need to install NodeJS on your system to run the build tool. After installing Node, install the build dependencies:

    npm ci

  2. Build and install Then, you can run the installation script to install to $HOME/.local/share/gnome-shell/extensions/gSnap@micahosborne.

    npm run install-extension

  3. Log out and log back in. (If you don't want to log out, you can restart gnome shell, which keeps all your windows open. Type Alt+F2, then type r and hit enter.)

The build process involves two steps:

  1. The Typescript compiler transpiles .ts files into .js files
  2. Rollup bundles the compiled js files into "extension.js" and "prefs.js", which are the main required files for a Gnome Shell extension.

Both can be configured by editing tsconfig.json and rollup.config.js

Development cycle

Generally,

  1. Code
  2. Run npm run gen-schemas (if you modified the schema)
  3. Run the npm run install-extension command to build and install the extension.
  4. If 2 succeeded, hit Alt+F2, type r, and hit enter.

Dependency management

Every dependency is handled by npm. To add a new "dev" dependency:

npm add -D "<dependency>"

To view the logs

journalctl /usr/bin/gnome-shell -f -o cat

Submitting to review

To obtain the ZIP archive for review, simply run;

npm run pack