Joehoel / flow-launcher-plugin-template-deno

Template for creating a Flow Launcher plugin using the Deno runtime

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Flow Launcher Plugin Template for Deno

This repository contains a template for creating a Flow Launcher plugin using the Deno runtime.

Warning

  • Since this compiles to an executable, npm modules are not yet supported. See this thread for more information.
  • All packages should directly be imported from the url and not via an import_map.

Development

To be able to test this easily, you need to create a symlink between this directory and the plugin directory from Flow Launcher. This can be done by searching Flow Launcher UserData Folder in the launcher and pressing enter. The plugins are found in the Plugins folder.

You can create a symlink by opening command prompt (CMD) in Windows and typing:

mklink /J [flow-launcher-plugin-folder]/[folder-name] [project-root]

An example would look like this:

mklink /J C:\Users\Joel\AppData\Roaming\FlowLauncher\Plugins\flow-plugin C:\Users\Joel\code\flow-plugin

After this is set up. You can run:

deno task build

To compile the code to and executable. Now restart Flow Launcher and the plugin should be loaded.

Note

  • You don't need to restart Flow Launcher every time you make a change.
  • However, you do need to run the build command everytime you make a change. I hope this is not needed in the future but the deno compile command does't have a watch mode (yet).

Publishing

When you want to release and publish a new version, just push to the main branch and it wil automatically create a new release and tag with the correct versions.

To add the plugin to the official Flow Launcher plugin manifest, follow this guide.

About

Template for creating a Flow Launcher plugin using the Deno runtime

License:MIT License


Languages

Language:TypeScript 100.0%