Files
openidea/plugins/official/harbor-night/README.md
1c5a92f952 feat(plugins): plugin system with extension points, consent, Wasm runtime and plugin API 1.0 (#971)
A plugin system built on WebAssembly components (wasmtime, WASI p2), with a
typed WIT API (`openidea:plugin@1.0.0`) and a Rust SDK, shipped as a preview.

- Extension points declared in `plugin.toml` (commands, languages, themes,
  icon themes, menus, key bindings, status items, settings, views, custom
  editors, file icons and templates, run detectors, editor providers),
  validated before anything takes effect and projected onto the workbench's
  own registries: plugin themes and file icon themes are chosen in
  Settings › Appearance and Quick Switch, plugin shortcuts are edited in
  Settings › Keymap, plugin problems are grouped in Settings › Inspections.
- Capabilities with risk levels and consent at install, pinned `process:`
  programs, secrets in the OS keychain.
- Runtime: one thread per active plugin, fuel/time/memory budgets, soft and
  hard deadlines on the editing path, cancellation, crash backoff, idle
  reclaim, a precompiled-component cache; remote projects run code plugins on
  `openidea-server`.
- Web views and custom editors with a sandboxed page, a document bridge
  joined to the text editor's undo history, and split or preview layouts.
- Distribution: signed `.oiplugin` packages, a static marketplace index with
  revocation, versioned installs with rollback, install from a `.zip` or a
  folder. The release workflow signs and publishes the official plugins and
  their index, which released builds use as the default marketplace.
- Official plugins: String Tools, Key Promoter, Git Toolbox, AI Completion,
  Checkstyle, MyBatis Navigator, CSV Editor, Solidity, Material Icons, Harbor
  Night, Excalidraw, Graphviz, Regex Tester, License Header.

Closes #732

Co-authored-by: Deng Liu <5108773+dengliu@users.noreply.github.com>
Co-authored-by: florentvdry <16673235+florentvdry@users.noreply.github.com>
2026-11-04 02:54:31 +08:00

2.5 KiB
Raw Permalink Blame History

Harbor Night

An OpenIDEA theme plugin, Harbor Night: a dark theme with slate surfaces, a teal accent and a warm syntax palette. It is also where new themes start: openidea-plugin new --template theme copies its theme files, or copy this folder. Full documentation, the token reference and porting guides are in docs/plugins/themes.md.

harbor-night/
├─ plugin.toml                          # manifest: id, name, version, the theme files
└─ themes/
   ├─ harbor-night.theme.json           # UI colours, every themeable token, grouped like tokens.css
   └─ harbor-night.scheme.json          # editor colour scheme: syntax, editor, ANSI colours

A theme plugin is data only: no code, no WebAssembly, no build step.

Make your own

  1. Run openidea-plugin new --template theme, or copy the folder, for example to ~/openidea-themes/my-theme.
  2. In plugin.toml, change id (lowercase, a-z 0-9 - _ .), name, description, authors and the two paths.
  3. Rename the theme files. In the theme file, set id, name and kind ("dark" or "light", the built-in base for anything you leave out).
  4. Edit the colours. Each key is a CSS variable from src/styles/tokens.css, and the reference in the docs gives the Islands Dark and Light values. Comments (//, /* */) are allowed. Delete a line to keep the built-in value.

Porting an IntelliJ theme? pnpm theme:import-intellij <file.theme.json> [file.icls] --out <dir> in the OpenIDEA repository generates a package in this layout.

Package and install

The folder is the package. To share it, publish the folder as a Git repository or a zip that users extract.

  1. In OpenIDEA open Settings › Plugins, click the gear menu and choose Install Plugin from Disk… (or run the Install Plugin from Disk… action), then pick the folder that contains plugin.toml.
  2. Select the plugin in the Installed tab and press Apply next to the theme.
  3. Use Default Theme in the same place goes back to the built-in theme.

Iterate

Put (or symlink) the folder in <project>/.openidea/plugins/ of an open project. It loads as a dev plugin, and Reload in Settings › Plugins (or the Reload Plugins action) re-reads your edits without reinstalling. Invalid JSON or values are reported in Settings › Plugins with the file and line.

Licence

Harbor Night is part of OpenIDEA (Apache-2.0). When you port someone else's theme, keep its licence and credit its authors.