Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marcinorlowski/plasmoid-tools
Helper tools and scripts I wrote to help me while working on KDE QML Plasmoids.
https://github.com/marcinorlowski/plasmoid-tools
bash developer-tools kde plasma plasmoid qml tools
Last synced: 14 days ago
JSON representation
Helper tools and scripts I wrote to help me while working on KDE QML Plasmoids.
- Host: GitHub
- URL: https://github.com/marcinorlowski/plasmoid-tools
- Owner: MarcinOrlowski
- Created: 2021-01-05T20:21:11.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-21T08:21:48.000Z (almost 2 years ago)
- Last Synced: 2024-10-27T05:05:31.859Z (about 2 months ago)
- Topics: bash, developer-tools, kde, plasma, plasmoid, qml, tools
- Language: Shell
- Homepage:
- Size: 43.9 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
Awesome Lists containing this project
README
# KDE QML/Plasma Applet Developer Tools #
Helper tools and scripts I wrote to help me while working on KDE QML Plasmoids (widgets).
# Tools #
By design all the tools are "location agnostic" and can be invoked from any directory.
they will try to determine proper root directory of QML plasmoid if needed, based on
your current working directory (traversing up if needed). This means that your working
directory **must** be one of plasmoid's directories. You currently cannot manually
specify where plasmoid is manually, but that's mostly because I do not work that way
and it was not needed by my workflow (adding support for that is trivial though).
# Determinig plasmoid root directory #
When you invoke i.e. `test.sh` script, it will try to determine root folder of the plasmoid.
This is done by looking for `metadata.desktop` file in current directory. If file is not
present, the parent dir is checked and so on.
# Tools #
Available tools:
* `test.sh`: runs your plasmoid in `plasmaviewer`. When invoked without arguments,
will try to use `CompactRepresentation` by enforcing smaller widget area, which
mimics docking plasmoid in the Panel. When invoked with any argument (literaly
any will work, i.e. `test.sh foo`), will run you plasmoid as it is installed as
desktop widget (so `FullRepresentation` should kick in).
* `meta.sh`: This is my work around for Plasma API not exposing metadata file content
in any other way. It parses project's `metadata.desktop` and creates `/contents/js/meta.js`
containing extracted information, that can be later imported and used in your JavaScript
code. Currently exposes metadata's `X-KDE-PluginInfo-Version` as `version`,
`Name` as `name`, `X-KDE-PluginInfo-Website` as `url`, `X-KDE-PluginInfo-Author` as `authorName`.
It also looks for additional, non-standard fields: `X-KDE-PluginInfo-Author-Url` (exported
as `authorUrl`), `X-KDE-PluginInfo-UpdateChecker-Url` (exported as `updateCheckerUrl`) and
`X-KDE-PluginInfo-FirstReleaseYear` exported as `firstReleaseYear`.
* `install.sh`: installs/upgrades your plasmoid in `~/.local/share/plasma/plasmoids/`
folderm then restarts plasmashell. Please note it will upgrade existing installation
without any confirmation. Note: it automatically updates `meta.js` file.
* `release.sh`: packs plasmoid sources and creates release file. Target file name is
going to be `PACKAGE-VERSION.plasmoid` and constructed using `metadata.desktop` information.
Note: it automatically updates `meta.js` file.
# Installation #
As mentioned, scripts are "location agnostic" and can be invoked from any directory.
You can add it to your `$PATH`. I personally use [Fish shell](https://fishshell.com/)
and added following aliases to my `~/.config/fish/config.fish`:
```
alias otest "/bin/test.sh"
alias oinstall "/bin/install.sh"
alias orelease "/bin/release.sh"
alias ometa "/bin/meta.sh"
```
# Tips #
* If your plasmoid misbehave, you may want to run it using "desktop" mode (`test.sh foo`).
That will make any syntax error related messages nicely visible in plasmaviewer window.
* You can easily customize QT log entries (thrown by `console.xxx()` calls) and i.e.
add file name or line number to it by setting `QT_MESSAGE_PATTERN`. See `test.sh` souces
for details and additional links.
## License ##
* Written and copyrighted ©2020-2023 by Marcin Orlowski
* Plasmoid Tools is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).