Merge pull request #3 from cibere/v2.0.1

v2.0.1

Author: cibere

.github/workflows/Publish Release.yml

@@ -1,31 +1,32 @@
-name: Publish Release
+name: Publish and Release
 
 on:
-  push:
-    branches: [ main ]
-    paths:
-    - 'plugin.json'
   workflow_dispatch:
 
 jobs:
   publish:
     runs-on: ubuntu-latest
     env:
       python_ver: 3.11
+    permissions:
+      contents: write
 
     steps:
       - uses: actions/checkout@v2
-      
+
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
+    
+      - name: Run generator file
+        run: python generate_plugin_file.py
 
       - name: get version
         id: version
         uses: notiz-dev/github-action-json-property@release
         with: 
-          path: 'plugin.json'
+          path: 'data.json'
           prop_path: 'Version'
 
       - run: echo ${{steps.version.outputs.prop}} 
@@ -38,9 +39,8 @@ jobs:
 
       - name: Publish
         if: success()
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@v2
         with:
           files: 'Flow.Launcher.Plugin.WordNikDictionary.zip'
           tag_name: "v${{steps.version.outputs.prop}}"
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          body_path: 'CHANGELOG.txt'

.gitignore

@@ -2,4 +2,5 @@ __pycache__/*
 venv/*
 lib/*
 wordnik.logs
-*.pyc
+*.pyc
+WorknikDictionary/word_list.txt

CHANGELOG.txt

@@ -0,0 +1,12 @@
+# v2.1.0
+- Rewrite error handling
+- Update `change_query` function to get ActionKeyword from `plugin.json`
+- Add autocomplete/spellcheck for words that aren't found to check for possible misspellings (can be turned off in settings due to it being kind of slow).
+    - Make `word_list.txt` not automatically download incase of the use of a custom word list, or not using the feature at all to use less storage.
+    - Support for custom word lists.
+- Add search modifier selector
+    - Invalid search modifier error now points to this
+- Add parts of speech selector
+- Remove canonical option due to it not doing anything
+- Fix bug with some queries returning errors due to the plugin attempting to log unicode characters with the wrong encoding.
+- Add `scrable` search modifier to get the scrable score of a word.

Images/invalid_search_modifier_example.png

@@ -1,21 +1,80 @@
 # Flow.Launcher.Plugin.WordNikDictionary
-This is a plugin for [Flow Launcher](https://github.com/Flow-Launcher/Flow.Launcher) that lets you easily see the definitions of words using [wordnik](https://wordnik.com).
+This is an overcomplicated and feature-packed plugin for [Flow Launcher](https://github.com/Flow-Launcher/Flow.Launcher) that lets you easily see the definitions (among other things) of words using [wordnik](https://wordnik.com).
+
+## Table of Contents
+1. [Get an API Key](#get-an-api-key)
+2. Installation
+    - [Install via Package Manager](#install-via-package-manager)
+    - [Manual Installation](#manual-installation)
+        - [Install from a previous release](#install-from-a-previous-release)
+        - [Download and build development version](#download-and-build-development-version)
+3. [Features](#features)
+    - [Feature List](#feature-list)
+4. [Settings Menu](#settings-menu)
 
 ## Get an API Key
 To get an API key, head to [developer.wordnik.com](https://developer.wordnik.com/), and create an account. Once you've created your account, you'll be able to fill out a form to request an api key.
 
+## Install via Package Manager
+
+To Install Wordnik Dictionary through Flow's Plugin Manager, run the following command: `pm install wordnik dictionary`.
+
+## Manual Installation
+> [!WARNING]
+> This method is not recommended, only do this if you know what your doing.
+### Install from a previous release
+
+1. Download the zipped release file.
+
+To download a previously released version, head to the [releases page](https://github.com/cibere/Flow.Launcher.Plugin.WordNikDictionary/releases), find the version you want, and download the zip file.
+
+2. Extract the zip file into your plugins folder.
+
+You can access your userdata folder through the `Flow Launcher UserData Folder` command in the system commands plugin, from there go into the `Plugins` folder, and create a new folder for your release. Extract the contents of the zip folder into the new folder you've made.
+
+3. Restart Flow Launcher
+
+Finally you want to restart flow launcher. You can do this via the `Restart Flow Launcher` command in the system commands plugin.
+
+### Download and build development version
+
+1. Head to your plugins folder.
+
+You can access your userdata folder through the `Flow Launcher UserData Folder` command in the system commands plugin, from there go into the `Plugins` folder.
+
+2. Clone the repository.
+
+> [!NOTE]
+> [git](https://git-scm.com/) must be installed for this
+
+Now you must clone the repository, which can be done with the following command: `git clone https://github.com/cibere/Flow.Launcher.Plugin.WordNikDictionary`.
+
+3. Setup your environment
+
+Head into the newly created folder containing the plugin, and create and activate a venv. Then run the `install_packages.bat` file from that console. That file will update pip, install the runtime libraries, and install the development libraries.
+
+4. Restart Flow Launcher
+
+Finally you want to restart flow launcher. You can do this via the `Restart Flow Launcher` command in the system commands plugin.
+
+
 ## Features
 
 ### Feature List
 1. [Get the definition of a word](#get-the-definition-of-a-word)
 2. [Get information about definition of a word](#get-information-about-definition-of-a-word)
 3. [Search Modifiers](#search-modifiers)
     - [Filter by parts of speech](#filter-by-parts-of-speech)
+    - [Parts of Speech Selector](#parts-of-speech-selector)
     - [Get the syllables of a word](#get-the-syllables-of-a-word)
     - [Get similiar word by category](#get-similiar-word-by-category)
-4. [Advanced Error Handler](#advanced-error-handler)
+    - [Search Modifier Selection Menu](#search-modifier-selection-menu)
+    - [Get Scrabble Score](#get-scrabble-score)
+4. [Autocomplete Miss-spelled Words](#autocomplete-miss-spelled-words)
+5. [Advanced Error Handler](#advanced-error-handler)
     - [Expected Errors](#expected-errors)
     - [Unexpected Errors](#unexpected-errors)
+    - [Invalid Search Modifier](#invalid-search-modifier)
 
 ### Get the definition of a word
 Get a list of definitions for your word from various sources. Syntax: `def word`
@@ -33,15 +92,32 @@ List of acceptable parts of speech modifiers:
 noun, adjective, verb, adverb, interjection, pronoun, preposition, abbreviation, affix, article, auxiliary-verb, conjunction, definite-article, family-name, given-name, idiom, imperative, noun-plural, noun-posessive, past-participle, phrasal-prefix, proper-noun, proper-noun-plural, proper-noun-posessive, suffix, verb-intransitive, verb-transitive
 ```
 ![Example showing the useage of the parts of speech search modifier with the `def vague!noun` query](Images/filter_by_part_of_speech_example.png)
+#### Parts of Speech Selector
+To select a part of speech from the list of acceptable ones, you can use the `def word!select-pos` command.
+![](Images/select_pos_menu_example.png)
 #### Get the syllables of a word
 We can use the `syllables` search modifier to get the syllables of a word. Syntax: `def word!syllables`
 ![Example showing the result of the search `def developer!syllable`](Images/get_syllables_example.png)
 #### Get categories of similiar words
 To find the categories of avalible similiar words for a given word, use the following command: `def word!similiar`. To see all of the words in a given category, see the section below.
+
 ![](Images/find_similiar_word_categories_example.png)
 #### Get similiar word by category
 To find all of the words that are similiar to a word in a specific category, use the following command: `def word!rel-category`. For a list of avalible categories for a given word, see the above section.
 ![](Images/find_similiar_words_by_category_example.png)
+#### Search Modifier Selection Menu
+To see a list of available search modifiers available, use the `def word!select-modifier` command. From there you have quick access to the various modifiers, and the [Parts of Speech Selector Menu](#parts-of-speech-selector).
+![](Images/select_search_modifier_menu.png)
+#### Get Scrabble Score
+You can get the scrabble score of a word by using the `scrabble` modifier like so: `def word!scrabble`. If a word is invalid or not found, a score of `0` is shown.
+![](Images/scrabble_score_example.png)
+
+### Autocomplete Miss-spelled Words
+If you misspell a word, wordnik dictionary uses a list of over 370 thousand words to try and figure out what you were trying to spell, and ranks them by how certain it is. Though the source for the list of words and definitions are different! So there may be differences in the data.
+> [!NOTE]
+> When attempting to use this feature for the first time, you will be prompted to either open up the settings menu to choose the path of a custom word list file, or download one from [dwyl on github](https://github.com/dwyl/english-words).
+
+![](Images/unknown_word_spellcheck_example.png)
 
 ### Advanced Error Handler
 
@@ -52,4 +128,35 @@ Expected errors will return a short, simple, and stylish error message.
 #### Unexpected Errors
 When unexpected errors occur, our error handler redirects it to the logs and prompts you to notify us by creating a github issue or discord thread with the logfile.
 
-https://github.com/cibere/Flow.Launcher.Plugin.WordNikDictionary/raw/refs/heads/v2/Images/unexpected_error_handler_showcase.mp4
+https://github.com/cibere/Flow.Launcher.Plugin.WordNikDictionary/raw/refs/heads/main/Images/unexpected_error_handler_showcase.mp4
+
+### Invalid Search Modifier
+When an invalid advanced search modifier is given, a simple error message is shown, with quick access to the [Search Modifier Selection Menu](#search-modifier-selection-menu)
+![](Images/invalid_search_modifier_example.png)
+
+## Settings Menu
+1. Action Keyword
+
+The keyword that activates the plugin, defaults to `def` with the stable release, and `ddef` with the dev version.
+> [!WARNING]
+> Changing this is NOT recommended. Currently, many QOL features require these keywords to stay at the default, otherwise some query changing options will not work properly.
+
+2. Wordnik API Key
+
+Head to https://developer.wordnik.com to get your API key.
+
+3. Number of results to display.
+
+Number of results to display. Defaults to 20, you must give an integer.
+
+4. Autocomplete Miss-spelled Words
+
+If marked yes, wordnik dictionary will attempt to find which word you were trying to spell if a word was not found. This is toggleable because it can be really slow, and you may just want to know if a word was found or not.
+Defaults to checked.
+
+5. Location of word list file
+
+If you want to use a custom list of words for the autocomplete misspelling feature, you can. Just put the path to the file here, and reload plugin data. Make sure each word is on it's on line.
+Default is blank, and blank means the default file is used. This setting on does anything if the [Autocomplete miss-spelled words setting](#autocomplete-miss-spelled-words) is checked.
+
+![](Images/settings_menu.png)