Skip to content

Commit c8630c6

Browse files
guilherssousaguilherssousa
committed
fix typos
1 parent 730d93b commit c8630c6

29 files changed

+46
-46
lines changed

Diff for: ‎API-Reference/Flow.Launcher.Plugin.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@
1414
| class [FlowLauncherQueryEventArgs](./Flow.Launcher.Plugin/FlowLauncherQueryEventArgs.md) | |
1515
| record [GlyphInfo](./Flow.Launcher.Plugin/GlyphInfo.md) | Text with FontFamily specified |
1616
| interface [IAsyncPlugin](./Flow.Launcher.Plugin/IAsyncPlugin.md) | Asynchronous Plugin Model for Flow Launcher |
17-
| interface [IAsyncReloadable](./Flow.Launcher.Plugin/IAsyncReloadable.md) | This interface is to indicate and allow plugins to asyncronously reload their in memory data cache or other mediums when user makes a new change that is not immediately captured. For example, for BrowserBookmark and Program plugin does not automatically detect when a user added a new bookmark or program, so this interface's function is exposed to allow user manually do the reloading after those new additions. The command that allows user to manual reload is exposed via Plugin.Sys, and it will call the plugins that have implemented this interface. |
17+
| interface [IAsyncReloadable](./Flow.Launcher.Plugin/IAsyncReloadable.md) | This interface is to indicate and allow plugins to asynchronously reload their in memory data cache or other mediums when user makes a new change that is not immediately captured. For example, for BrowserBookmark and Program plugin does not automatically detect when a user added a new bookmark or program, so this interface's function is exposed to allow user manually do the reloading after those new additions. The command that allows user to manual reload is exposed via Plugin.Sys, and it will call the plugins that have implemented this interface. |
1818
| interface [IContextMenu](./Flow.Launcher.Plugin/IContextMenu.md) | |
1919
| interface [IFeatures](./Flow.Launcher.Plugin/IFeatures.md) | Base Interface for Flow's special plugin feature interface |
2020
| interface [IPlugin](./Flow.Launcher.Plugin/IPlugin.md) | Synchronous Plugin Model for Flow Launcher |
2121
| interface [IPluginI18n](./Flow.Launcher.Plugin/IPluginI18n.md) | Represent plugins that support internationalization |
2222
| interface [IPublicAPI](./Flow.Launcher.Plugin/IPublicAPI.md) | Public APIs that plugin can use |
2323
| interface [IReloadable](./Flow.Launcher.Plugin/IReloadable.md) | This interface is to indicate and allow plugins to synchronously reload their in memory data cache or other mediums when user makes a new change that is not immediately captured. For example, for BrowserBookmark and Program plugin does not automatically detect when a user added a new bookmark or program, so this interface's function is exposed to allow user manually do the reloading after those new additions. The command that allows user to manual reload is exposed via Plugin.Sys, and it will call the plugins that have implemented this interface. |
2424
| interface [IResultUpdated](./Flow.Launcher.Plugin/IResultUpdated.md) | |
25-
| interface [ISavable](./Flow.Launcher.Plugin/ISavable.md) | Save addtional plugin data. Inherit this interface if additional data e.g. cache needs to be saved, Otherwise if LoadSettingJsonStorage or SaveSettingJsonStorage has been callded, plugin settings will be automatically saved (see Flow.Launcher/PublicAPIInstance.SavePluginSettings) by Flow |
25+
| interface [ISavable](./Flow.Launcher.Plugin/ISavable.md) | Save additional plugin data. Inherit this interface if additional data e.g. cache needs to be saved, Otherwise if LoadSettingJsonStorage or SaveSettingJsonStorage has been called, plugin settings will be automatically saved (see Flow.Launcher/PublicAPIInstance.SavePluginSettings) by Flow |
2626
| interface [ISettingProvider](./Flow.Launcher.Plugin/ISettingProvider.md) | |
2727
| class [PluginInitContext](./Flow.Launcher.Plugin/PluginInitContext.md) | |
2828
| class [PluginMetadata](./Flow.Launcher.Plugin/PluginMetadata.md) | |

Diff for: ‎API-Reference/Flow.Launcher.Plugin/IAsyncPlugin.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ public interface IAsyncPlugin
1010

1111
| name | description |
1212
| --- | --- |
13-
| [InitAsync](IAsyncPlugin/InitAsync.md)(…) | Initialize plugin asynchrously (will still wait finish to continue) |
13+
| [InitAsync](IAsyncPlugin/InitAsync.md)(…) | Initialize plugin asynchronously (will still wait finish to continue) |
1414
| [QueryAsync](IAsyncPlugin/QueryAsync.md)(…) | Asynchronous Querying |
1515

1616
## See Also

Diff for: ‎API-Reference/Flow.Launcher.Plugin/IAsyncPlugin/InitAsync.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# IAsyncPlugin.InitAsync method
22

3-
Initialize plugin asynchrously (will still wait finish to continue)
3+
Initialize plugin asynchronously (will still wait finish to continue)
44

55
```csharp
66
public Task InitAsync(PluginInitContext context)

Diff for: ‎API-Reference/Flow.Launcher.Plugin/IAsyncReloadable.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# IAsyncReloadable interface
22

3-
This interface is to indicate and allow plugins to asyncronously reload their in memory data cache or other mediums when user makes a new change that is not immediately captured. For example, for BrowserBookmark and Program plugin does not automatically detect when a user added a new bookmark or program, so this interface's function is exposed to allow user manually do the reloading after those new additions. The command that allows user to manual reload is exposed via Plugin.Sys, and it will call the plugins that have implemented this interface.
3+
This interface is to indicate and allow plugins to asynchronously reload their in memory data cache or other mediums when user makes a new change that is not immediately captured. For example, for BrowserBookmark and Program plugin does not automatically detect when a user added a new bookmark or program, so this interface's function is exposed to allow user manually do the reloading after those new additions. The command that allows user to manual reload is exposed via Plugin.Sys, and it will call the plugins that have implemented this interface.
44

55
```csharp
66
public interface IAsyncReloadable : IFeatures

Diff for: ‎API-Reference/Flow.Launcher.Plugin/IPlugin.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Synchronous Plugin Model for Flow Launcher
44

5-
If the Querying or Init method requires high IO transmission or performaing CPU intense jobs (performing better with cancellation), please try the IAsyncPlugin interface
5+
If the Querying or Init method requires high IO transmission or performing CPU intense jobs (performing better with cancellation), please try the IAsyncPlugin interface
66

77
```csharp
88
public interface IPlugin : IAsyncPlugin

Diff for: ‎API-Reference/Flow.Launcher.Plugin/IPlugin/Query.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Querying when user's search changes
44

5-
This method will be called within a Task.Run, so please avoid synchrously wait for long.
5+
This method will be called within a Task.Run, so please avoid synchronously wait for long.
66

77
```csharp
88
public List<Result> Query(Query query)

Diff for: ‎API-Reference/Flow.Launcher.Plugin/IPublicAPI.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,19 @@ public interface IPublicAPI
1717
| [FuzzySearch](IPublicAPI/FuzzySearch.md)(…) | Fuzzy Search the string with the given query. This is the core search mechanism Flow uses |
1818
| [GetAllPlugins](IPublicAPI/GetAllPlugins.md)() | Get all loaded plugins |
1919
| [GetTranslation](IPublicAPI/GetTranslation.md)(…) | Get translation of current language You need to implement IPluginI18n if you want to support multiple languages for your plugin |
20-
| [HttpDownloadAsync](IPublicAPI/HttpDownloadAsync.md)(…) | Download the specific url to a cretain file path |
21-
| [HttpGetStreamAsync](IPublicAPI/HttpGetStreamAsync.md)(…) | Http download the spefic url and return as stream |
22-
| [HttpGetStringAsync](IPublicAPI/HttpGetStringAsync.md)(…) | Http download the spefic url and return as string |
20+
| [HttpDownloadAsync](IPublicAPI/HttpDownloadAsync.md)(…) | Download the specific url to a certain file path |
21+
| [HttpGetStreamAsync](IPublicAPI/HttpGetStreamAsync.md)(…) | Http download the specific url and return as stream |
22+
| [HttpGetStringAsync](IPublicAPI/HttpGetStringAsync.md)(…) | Http download the specific url and return as string |
2323
| [LoadSettingJsonStorage&lt;T&gt;](IPublicAPI/LoadSettingJsonStorage.md)() | Load JsonStorage for current plugin's setting. This is the method used to load settings from json in Flow. When the file is not exist, it will create a new instance for the specific type. |
2424
| [LogDebug](IPublicAPI/LogDebug.md)(…) | Log debug message Message will only be logged in Debug mode |
25-
| [LogException](IPublicAPI/LogException.md)(…) | Log an Exception. Will throw if in debug mode so developer will be aware, otherwise logs the eror message. This is the primary logging method used for Flow |
25+
| [LogException](IPublicAPI/LogException.md)(…) | Log an Exception. Will throw if in debug mode so developer will be aware, otherwise logs the error message. This is the primary logging method used for Flow |
2626
| [LogInfo](IPublicAPI/LogInfo.md)(…) | Log info message |
2727
| [LogWarn](IPublicAPI/LogWarn.md)(…) | Log warning message |
2828
| [OpenDirectory](IPublicAPI/OpenDirectory.md)(…) | Open directory in an explorer configured by user via Flow's Settings. The default is Windows Explorer |
2929
| [OpenSettingDialog](IPublicAPI/OpenSettingDialog.md)() | Open setting dialog |
3030
| [OpenUrl](IPublicAPI/OpenUrl.md)(…) | Opens the url. The browser and mode used is based on what's configured in Flow's default browser settings. |
3131
| [RegisterGlobalKeyboardCallback](IPublicAPI/RegisterGlobalKeyboardCallback.md)(…) | Register a callback for Global Keyboard Event |
32-
| [ReloadAllPluginData](IPublicAPI/ReloadAllPluginData.md)() | Reloads any Plugins that have the IReloadable implemented. It refeshes Plugin's in memory data with new content added by user. |
32+
| [ReloadAllPluginData](IPublicAPI/ReloadAllPluginData.md)() | Reloads any Plugins that have the IReloadable implemented. It refreshes Plugin's in memory data with new content added by user. |
3333
| [RemoveActionKeyword](IPublicAPI/RemoveActionKeyword.md)(…) | Remove ActionKeyword for specific plugin |
3434
| [RemoveGlobalKeyboardCallback](IPublicAPI/RemoveGlobalKeyboardCallback.md)(…) | Remove a callback for Global Keyboard Event |
3535
| [RestartApp](IPublicAPI/RestartApp.md)() | Restart Flow Launcher |

Diff for: ‎API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpDownloadAsync.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# IPublicAPI.HttpDownloadAsync method
22

3-
Download the specific url to a cretain file path
3+
Download the specific url to a certain file path
44

55
```csharp
66
public Task HttpDownloadAsync(string url, string filePath, CancellationToken token = default)

Diff for: ‎API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpGetStreamAsync.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# IPublicAPI.HttpGetStreamAsync method
22

3-
Http download the spefic url and return as stream
3+
Http download the specific url and return as stream
44

55
```csharp
66
public Task<Stream> HttpGetStreamAsync(string url, CancellationToken token = default)

Diff for: ‎API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpGetStringAsync.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# IPublicAPI.HttpGetStringAsync method
22

3-
Http download the spefic url and return as string
3+
Http download the specific url and return as string
44

55
```csharp
66
public Task<string> HttpGetStringAsync(string url, CancellationToken token = default)

Diff for: ‎API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogException.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# IPublicAPI.LogException method
22

3-
Log an Exception. Will throw if in debug mode so developer will be aware, otherwise logs the eror message. This is the primary logging method used for Flow
3+
Log an Exception. Will throw if in debug mode so developer will be aware, otherwise logs the error message. This is the primary logging method used for Flow
44

55
```csharp
66
public void LogException(string className, string message, Exception e,

Diff for: ‎API-Reference/Flow.Launcher.Plugin/IPublicAPI/ReloadAllPluginData.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# IPublicAPI.ReloadAllPluginData method
22

3-
Reloads any Plugins that have the IReloadable implemented. It refeshes Plugin's in memory data with new content added by user.
3+
Reloads any Plugins that have the IReloadable implemented. It refreshes Plugin's in memory data with new content added by user.
44

55
```csharp
66
public Task ReloadAllPluginData()

Diff for: ‎API-Reference/Flow.Launcher.Plugin/ISavable.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ISavable interface
22

3-
Save addtional plugin data. Inherit this interface if additional data e.g. cache needs to be saved, Otherwise if LoadSettingJsonStorage or SaveSettingJsonStorage has been callded, plugin settings will be automatically saved (see Flow.Launcher/PublicAPIInstance.SavePluginSettings) by Flow
3+
Save additional plugin data. Inherit this interface if additional data e.g. cache needs to be saved, Otherwise if LoadSettingJsonStorage or SaveSettingJsonStorage has been called, plugin settings will be automatically saved (see Flow.Launcher/PublicAPIInstance.SavePluginSettings) by Flow
44

55
```csharp
66
public interface ISavable : IFeatures

Diff for: ‎API-Reference/Flow.Launcher.Plugin/Query.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ public class Query
1919
| [SecondToEndSearch](Query/SecondToEndSearch.md) { get; } | strings from second search (including) to last search |
2020
| [ThirdSearch](Query/ThirdSearch.md) { get; } | Return third search split by space if it has |
2121
| override [ToString](Query/ToString.md)() | |
22-
| const [ActionKeywordSeparator](Query/ActionKeywordSeparator.md) | User can set multiple action keywords seperated by ';' |
22+
| const [ActionKeywordSeparator](Query/ActionKeywordSeparator.md) | User can set multiple action keywords separated by ';' |
2323
| const [GlobalPluginWildcardSign](Query/GlobalPluginWildcardSign.md) | '*' is used for System Plugin |
24-
| const [TermSeparator](Query/TermSeparator.md) | Query can be splited into multiple terms by whitespace |
24+
| const [TermSeparator](Query/TermSeparator.md) | Query can be splitted into multiple terms by whitespace |
2525

2626
## See Also
2727

Diff for: ‎API-Reference/Flow.Launcher.Plugin/Query/ActionKeywordSeparator.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Query.ActionKeywordSeparator field
22

3-
User can set multiple action keywords seperated by ';'
3+
User can set multiple action keywords separated by ';'
44

55
```csharp
66
public const string ActionKeywordSeparator;

Diff for: ‎API-Reference/Flow.Launcher.Plugin/Query/TermSeparator.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Query.TermSeparator field
22

3-
Query can be splited into multiple terms by whitespace
3+
Query can be splitted into multiple terms by whitespace
44

55
```csharp
66
public const string TermSeparator;

Diff for: ‎_coverpage.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
> Fast and fluid productivity tool of choice that helps your workflow.
1212
1313
- Search Everything
14-
- Plugin Suppport
14+
- Plugin Support
1515
- Native Shell Support
1616

1717
[GitHub](https://github.com/Flow-Launcher/Flow.Launcher)

Diff for: ‎develop-dotnet-plugins.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@ Flow is written in C#, so plugins written in .Net platform can directly communic
22

33
## Initialization
44

5-
For C# Plugins, We recommand you use the [dotnet template](https://github.com/Flow-Launcher/dotnet-template) to generate a plugin template.
5+
For C# Plugins, We recommend you use the [dotnet template](https://github.com/Flow-Launcher/dotnet-template) to generate a plugin template.
66

7-
In order to be recongized as a Flow DotNet plugin, the directory needs to have at least two files
7+
In order to be recognized as a Flow DotNet plugin, the directory needs to have at least two files
88
1. [`plugin.json`](plugin.json.md)
9-
2. A Dotnet Assembly that implements **[IPlugin](API-Reference/Flow.Launcher.Plugin/iplugin.md)** or **[IAsyncPlugin](API-Reference/Flow.Launcher.Plugin/iasyncplugin.md)** (remember to refrence [Flow.Launcher.Plugin](https://www.nuget.org/packages/Flow.Launcher.Plugin/) by Nuget). The plugin template will add the reference and create a `Main.cs` that implements `IPlugin`.
9+
2. A Dotnet Assembly that implements **[IPlugin](API-Reference/Flow.Launcher.Plugin/iplugin.md)** or **[IAsyncPlugin](API-Reference/Flow.Launcher.Plugin/iasyncplugin.md)** (remember to reference [Flow.Launcher.Plugin](https://www.nuget.org/packages/Flow.Launcher.Plugin/) by Nuget). The plugin template will add the reference and create a `Main.cs` that implements `IPlugin`.
1010

1111
Find our API Reference [here](API-Reference/)
1212

@@ -21,13 +21,13 @@ The `Main`class that implements **[IPlugin](API-Reference/Flow.Launcher.Plugin/i
2121
1. `void Init(PluginInitContext context)`
2222
- [PluginInitContext](https://github.com/Flow-Launcher/Flow.Launcher/blob/master/API-Reference/Flow.Launcher.Plugin/PluginInitContext.cs) exposes some API from Flow and an metadata object for your plugin.
2323
- It will be invoked before the invocation of `Query`, so you can do some preparation here.
24-
- We recommand you do expensive operations in this method instead of Object Constructor because this method will be executed in parallel with other plugins.
24+
- We recommend you do expensive operations in this method instead of Object Constructor because this method will be executed in parallel with other plugins.
2525
2. `List<Result> Query(Query query)`
2626
- `Query` will be invoked when user activate this plugin with specific ActionKeyword.
2727
- A `List` of [Result](/API-Reference/Flow.Launcher.Plugin/result.md) object should be returned.
2828

2929
**[IAsyncPlugin](API-Reference/Flow.Launcher.Plugin/iasyncplugin.md)** is the async version of **[IPlugin](API-Reference/Flow.Launcher.Plugin/iplugin.md)**
30-
- Instead of implmenting `Init` and `Query`, you will need to implement `InitAsync`and `QueryAsync`, which use `Task`,`Task<List<Result>` as return value to allow using `async/await` strategy
30+
- Instead of implementing `Init` and `Query`, you will need to implement `InitAsync`and `QueryAsync`, which use `Task`,`Task<List<Result>` as return value to allow using `async/await` strategy
3131
- `QueryAsync` provides a `CancellationToken token` to allow you to check whether user has typed a new query.
3232

3333

@@ -48,8 +48,8 @@ The return value of `LoadContextMenus` is similar to Results from `Query/QueryAs
4848

4949
### [IPluginI18n](/API-Reference/Flow.Launcher.Plugin/iplugini18n.md)
5050

51-
**IPluginI18n** means the plugin has been internationalized. Therefore, Flow will load the additional lauguage resources from `/Languages` when loading the plugin.
52-
By implementing this interface with additional language files, Flow will be able to load plugin-sepcified localized language resources. You will be able to get the translated text with `IPublicAPI.GetTranslation(string key)`.
51+
**IPluginI18n** means the plugin has been internationalized. Therefore, Flow will load the additional language resources from `/Languages` when loading the plugin.
52+
By implementing this interface with additional language files, Flow will be able to load plugin-specific localized language resources. You will be able to get the translated text with `IPublicAPI.GetTranslation(string key)`.
5353

5454
#### Language Resource
5555

Diff for: ‎json-rpc.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ API is located [here](https://github.com/Flow-Launcher/Flow.Launcher/blob/master
4040
- `Flow.Launcher.StopLoadingBar`: stop loading animation in flow launcher
4141
- `Flow.Launcher.ReloadAllPluginData`: reload all flow launcher plugins
4242

43-
### JSON RPC Formating
43+
### JSON RPC Formatting
4444

4545
```json
4646
{

Diff for: ‎nodejs-develop-plugins.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ Although not a hard requirement, this guide will use Node.js to run the TypeScri
77
When building a Node.js plugins there are several things to be mindful of:
88

99
* The most important thing is we do not expect users to have to manually install the dependencies via npm because we aim to provide a seamless experience for them. This can be achieved by adding the following three things to your project:
10-
1. Add a GitHub workflow- use a GitHub workflow that will install all your plugin's depedencies including the modules inside a folder called 'node_modules'.
10+
1. Add a GitHub workflow- use a GitHub workflow that will install all your plugin's dependencies including the modules inside a folder called 'node_modules'.
1111
2. Publish all as a zip- zip up your project including a lib directory that contains the modules and publish it to GitHub Releases page.
1212
3. Point your module path to the node_modules directory- reference all the modules to that directory.
1313

1414
* Users can use their system-installed Node.js with Flow Launcher, but in most circumstances, they will most likely be using Flow Launcher's download of [Node.js](https://nodejs.org/dist/v16.18.0/node-v16.18.0-win-x64.zip)). This download of portable Node.js version is isolated from the user's system and can be simply removed.
1515

1616
### Simple Example
17-
Have a look at this simple example plugin [here](https://github.com/Flow-Launcher/Flow.Launcher.Plugin.HelloWorldNodeJS), notice it has a folder called '.github/workflows' and a file called 'Publish Release.yml'. This is the workflow file that GitHub Workflow uses to run the CICD for the project. Moving out of that folder you can go into the [main.js](https://github.com/Flow-Launcher/Flow.Launcher.Plugin.HelloWorldNodeJS/blob/main/main.js) file, this is the entry file for your plugin.
17+
Have a look at this simple example plugin [here](https://github.com/Flow-Launcher/Flow.Launcher.Plugin.HelloWorldNodeJS), notice it has a folder called '.github/workflows' and a file called 'Publish Release.yml'. This is the workflow file that GitHub Workflow uses to run the CI/CD for the project. Moving out of that folder you can go into the [main.js](https://github.com/Flow-Launcher/Flow.Launcher.Plugin.HelloWorldNodeJS/blob/main/main.js) file, this is the entry file for your plugin.

0 commit comments

Comments
 (0)