xenoinc/toolshub

Desktop productivity with "not your average quick launcher" plus Pomodoro Timer! 🍅 by Xeno Innovations, built using Mono.Addins. Coming soon is the sidebar desktop dock similar to RocketDock or ObjectDock

toolshub's Issues

[core] Add ci, code coverage, and style with badges

As a developer, I'd like to have automatic features during check-in like continuous integration, code coverage, and apply the badges to the readme.md file so the public can see how the project is doing.

Acceptance

• Remove gitlab's ci because it doesn't work
• Sign-up for ci and add baddge
• Sign-up for code coverage and add badge
• Add badge for project license

Out of Scope

• Style checker & badge
• Up-to-date security checker & badge

See also:

• https://github.com/marketplace
• https://www.tygertec.com/add-badges-github-project/
• https://shields.io/
• https://medium.freecodecamp.org/how-to-use-badges-to-stop-feeling-like-a-noob-d4e6600d37d2

[addin][core] Detect system shutdown signal and inform add-ins

As an app, I want to detect when the system is shutting down and inform any add-ins that the event is occurring. This will help to safely deallocate objects/processes.

Acceptance

• Send shutdown signal to add-ins

Out of Scope

If there are any add-ins which need to perform actions based on this, a new backlog item will need to be created for it.

[SysTray] Launch shortcut link from SysTray

As a user, I would like for my saved Shortcut to launch its link whether it's an application, folder, or URL

Acceptance

• Launch link if it's an application, url, or folder

Out of Scope

• Application parameters
• Custom link addresses

[SysTray] Launch shortcut link from SysTray

As a user, I would like for my saved Shortcut to launch its link whether it's an application, folder, or URL

Acceptance

• Launch link if it's an application, url, or folder

Out of Scope

• Application parameters
• Custom link addresses

[addin][mgmt] Add-in list to display enabled-icon, name, and version

As a user, I want the add-in list to display 3 columns of info about the add-in. Data should include: (1) Icon, (2) name, and (3) version number

[sidebar] Allow custom sidebar background

As a user, I want to have a custom sidebar background which takes in PNG format for background transparency.

Acceptance

• Load background from settings
• Set background via preferences
• Allow background transparency if PNG

[sidebar][addin] Create basic sidebar add-in manager

As a user, I want to have a basic Sidebar add-in manager for extensibility.

This should extend similar to the SysTray

[addin][mgmt] Split TreeView nodes based upon Category

As a user, I would like for add-in's node in the TreeView to be listed under a Category. This will help the grouping an item's purpose.

Acceptance

• Display add-in's node under a supplied Category. If none provided, it goes under "Generic"

[veracrypt] Create VeraCrypt addin (first pass)

As a user, I want to be able to quickly mount VeraCrypt virtual drives via our Shortcuts launcher.

NOTE: This is the first pass, only apply and will not be as feature-rich as we'd like it to be.

References: https://www.veracrypt.fr/

Acceptance

• Create preference window
• Create VeraCrypt engine wrapper
• Mount VeraCrypt virtual drive using the stored password (if available)
• Store passwords in settings

Out of Scope

• Applying very, very strong encryption for storing passwords.
• Discovering if drives are pre-mounted
• Handling multiple drives
• SignOn/LogOff/Shutdown handlers
• Refreshing SysTray after mounting/dismounting

Fix MSBuild script

The MSBuild scripts in the build.proj file is incomplete and can cause issues if executed. Please remove erroneous code and fix missing targets.

[shortcuts][pref] Shortcuts gui viewer

As a user, I would like to have the Shortcuts editor display a GUI editor instead of JSON data for easier editing of items.

Acceptance

• View shortcuts data in a user control

Out of Scope

• Editing data

[addin][prefs] Show add-in's preferences in side panel

As a user, I want to be able to view an add-in's preferences in the add-in manager

Acceptance

• Manager must accept in Panel object (WinForms)

Out of Scope

• Saving and loading of add-in preference data

[core] Allow only one instance of the app

As a user, I only want to have only one instance of the app running.

Acceptance

• Only allow app to run once

Out of Scope

• Don't check for remote desktop instances

[Shortcuts] Use the new storage system to save settings

As a user, I want the Shortcuts add-in to use the new Settings manager.

Acceptance

• Initialize the Settings service/manager
• Save and load Shortcuts from its add-in PropertyBag
• Update Properties page to load/save

Out of Scope

• Additional enhancements to the Settings add-in

[addin][pomodoro] Create Pomodoro addin

As a user, I would like to begin migrating the Pomodoro project to an add-in driven by the ShortcutsAddin.

Pull Request: #69

Acceptance

• Start/pause/stop timer
• Short and Long breaks
• Update SysTray with a count-down to completion
• Reset SysTray icon back to default when done

Out of Scope

• Properties configuration to disable it
• Launch from SystemTray ExtensionPoint

Tasks

• Create add-in skeleton
• System test updating SysTray icon
• Update SysTray icon while running
• Start/stop/pause working timer
• Start/stop breaks
• Tests
  • Update SysTray icon while running
• Preferences for timer settings
  • Pomodoro times
  • Break times
  • Flash screen OnEvents
  • Send updates to NotificationIcon bubble

[addin][sample] Update Sample XML-based external add-in

As a developer, I would like to have a working external XML based add-in example

Acceptance

• Rename, SampleAddin to SampleXmlAddin
• Create SampleAssmAddin which doesn't use XML manifest files
• Have them use OnStart and Utility paths
• Prepare them to have a Preference page

[sidebar] Icon transparency based of mouse location

As a user, I want the option to display an icon transparency based on which icon we are over top of. For instance, the current icon is set to 90%, 2nd=50%, 3rd=25%, 4th=0%

Acceptance

• Setting to enable/disable this feature
• Setting: Transparency level of selected icon
• Setting: Transparency level of proximity icons
• Displaying icons using the set rules

[sidebar][addin] Drawer add-in

As a user, i would like to have a "drawer" plugin which acts as a (single) subdirectory and expands outward.

Acceptance

• Default style: linear (linear horizontal or vertical?)

Out of Scope

• Changing Expansion styles (curved, linear

[pomodoro] Load Pomodoro as utility add-in

As a user, I would like to load the project Pomodoro project as a utility add-in.

This add-in will serve as a Utility loader example

Related to pull request: #69

Acceptance

• Migrate from standalone EXE to DLL
• Launch as an external add-in
• Load on startup as Utility

Out of Scope

• Properties configuration to disable it
• Launch from SystemTray ExtensionPoint

Tasks

• Create utility add-in handler
• Strip-down Pomodoro.exe project
  • Replace existing settings engine with ToolsHub's
  • Remove Squirel packager
• Preference
  • Load utility from SysTray
  • Load utility OnStart

[core][addin] Load add-ins into memory

As a developer, I want the system to discover a basic add-in to ensure that the Mono.Addin system is functioning correctly.

Acceptance

• Use the path, ToolsHub/AppInitialize for addins
• Create a simple test add-in

[shortcuts][mngr] Create Shortcut add-in manager for SystemTray

As a developer, I would like for the System Tray to have an add-in extension point. This would allow for quicker access to add-in features

Acceptance

• Create systray extension point
• Allow add-ins to add menu item

Out of Scope

• Sub-menu item

[core][util] Load ext-point /ToolsHub/Utility for application add-ins

As a user, I want to be able to launch utilities. Replace the ApplicationAddon ext point with /ToolsHub/Utility.

Acceptance

• Execute after all other components application have been loaded.

[sidebar][addin] Sidebar should startup from add-in listener

As a user, I want to the Sidebar to startup via the add-in extension point.

Acceptance

• Use ExtensionPath to be loaded on startup

[shortcuts][prefs] Edit Shortcuts items in Preference page via drag-and-drop

As a user, I want to be able to move Shortcut items around using a drag-n-drop method

Acceptance

• Move items up/down using drag-and-drop with the mouse pointer
• Move item up/down using on-screen buttons (optional)

[sidebar] Hide sidebar into left side of screen when not active

As a user, I want to sidebar to disappear into the left side of the screen when the mouse is no-longer over it (5sec) and reappear when mouse is on the left side for 1sec.

Acceptance

• Auto-hide based on specified duration

Out of Scope

• Setting which side of the screen to hide/show on
• Setting the duration

[pomodoro] Make sound from generated code

As a user, I want the Pomodoro timer to make sounds OnStart, OnComplete, and OnPause. However, I don't want to carry along heavy WAV or MP3 files; let's generate the sounds!

Reference:

• https://github.com/naudio/NAudio
  • https://www.nuget.org/packages/NAudio/
• https://stackoverflow.com/questions/203890/creating-sine-or-square-wave-in-c-sharp
• https://stackoverflow.com/questions/14042630/how-to-generate-sounds-according-to-frequency

[addin][pref] List add-ins with Preference page in TreeView

As a user, I want to see all add-ins with a Preference page to be listed in the side TreeView.

Branch: feature/pref-page-init

Acceptance

• Fix ExtensionPoint for /ToolsHub/PerferencePage if needed
• List add-ins discovered preference pages into the left side TreeView

Out of Scope

• Displaying the node as sub-item of a category in the TreeView
• Displaying graphical icon for enabled/disabled status

[shortcuts][pref] Edit Shortcut item info using GUI editor

As a user, I want to be able to update a Shortcut's item info using the Preference page's editor

Acceptance

• Selecting an item from GUI editor to display editing options
• Save edited data
• Cancel current item edit but not previous edit item(s) changes before selecting the main OK button.

Out of Scope

• Moving items via drag-drop

[addin][mgmt] List add-ins in a multicolumn treeview (icon, title)

As a user, I want the add-in manager do display an enabled icon and title of the add-in.

Acceptance

• Display icon (enabled/disabled)
• Display title of add-in

Out of Scope

• Changing status of icon. See story, #10
• Displaying add-ins under a category
• Custom loading of add-in's own icon

[addin][mgmt] Change add-in icon depending on enabled/disabled status

As a user, I want to visibly know if the add-in is enabled or disabled based upon the icon's status in the add-in manager.

Acceptance

• List of add-in's icons should change depending on enabled/disabled status

Out of Scope

• Custom icons supplied by add-in

[sidebar] Load shortcut icons from portable settings file.

As a user, I want my sidebar shortcuts to be loaded from the portable settings.

Acceptance

• Use INI file to load shortcut icons
• Use INI file to set shortcut's path
• Display icon in the sidebar

Out of Scope

• Global settings file for multiple users

[sidebar] Show icon's native icon

As a user, i want the shortcut icons to display their own icon. If one is not found then use generic

Acceptance

• Display shortcut's icon

Out of Scope

• Overriding with a custom icon

[systray] Create ext-point for SystemTray ICommands

As a user, I want to be able to add commands to the SystemTray via Mono.Addins using the ICommand interface.

[addin][core] Send initialize signal to add-ins from Core on startup

As an app, I'd like for the core system to handle and initialization extension point for add-ins.

Acceptance

• Create an extension point for initialization and execute

[sidebar] Reorganize icons via drag-drop

As a user, I want to be able to reorganize icon order by performing drag and drop along the sidebar

[addin][prefs] Create basic Shortcut manager panel

As a user, I want to be able to add/remove items from my Shortcuts add-in

Branch: feature/pref-shortcuts

Acceptance

• Create simple Shortcuts editor preference page
• Edit json file in text editor for first pass

Out of Scope

• Pretty editor

[Settings] Load settings from App.Settings not singleton

As a developer, I want to prepare ourselves for IoC, so stop using our settings as a static class which is almost a singleton. Use Application.Settings property to keep the settings in-memory.

Acceptance

• Convert Settings class from static class to regular class
• Control settings from the Application.Settings property

Out of Scope

• Implementing IoC if possible

[test][msgsender] Create a simple MessageSender test

As a developer, I would like to be able to loosely communicate between add-in host and extensions via a Message Sender. This allows us the ability to send a signal out to parts of our code and only listening parties can act upon it if they choose to do so.

For example, we want to refresh the System Tray after editing it. We wouldn't need IoC, just simply send a message to inform SystemTrayManager to refresh its menu cache and display it.

Acceptance

• Implement a MessageSender
• Create simple system tests
• Use a sample external add-in

Out of Scope

• Fully implementing it across all extension points

[sidebar] Create basic sidebar for launching applications

As a user, I want a simple sidebar for launching applications

Acceptance

• Display generic icon and text
• Launch link
• Read list of links from config file

Out of Scope

• Customizations

[shortcuts][addin] Create dummy shortcut data to populate SysTray submenu with

As a developer, I would like to test the Shortcut add-in's ability to load (dummy) data and display it as a sub-menu in the SystemTray.

[addin][pref] List all add-ins so we can enable/disable them

As a user, I want to see all add-ins loaded into the system

Acceptance

• List add-ins discovered by the system into the left side TreeView
• Ability to enable/disable a selected add-in

Out of Scope

• Displaying the node as sub-item of a category in the TreeView
• Displaying graphical icon for enabled/disabled status

[shortcuts][pref] Create ability to Add or Remove Shortcuts using Preferences window

As a user, I want to be able to easily add/remove shortcut add-in items using the TreeView editor in the Preferences dialog.

Acceptance

• Add items to GUI editor
• Remove items from GUI editor
• Save editor results to JSON

Out of Scope

• Editing JSON data (text and targets)
• Moving items via drag-drop

[setting] Create Preference page for app start-up methods

As a user, I want to have the ability to start ToolsHub when the system starts. Also, provide options for which method of auto-startup we should perform.

Acceptance

• Create "General" settings page
• Create a checkbox to start the app with Windows
• Create a dropdown for startup method
  • Start menu (current / all users)
  • RegEdit (current / all users)
• Save settings

Out of Scope

• Getting too fancy

[core][addin][prefs] Internal preference database for core and add-ins

As a user, I want to be able to store application preferences for core and add-ins into a simple db system (sqlite?). This preference data manager will be used to save/load/reset settings. Consider the storage datatypes needed for storage. Perhaps, everything is a string?

Acceptance

• Research options for data storage (sqlite, ini, xml, etc)
• At the very least implement a string-based storage system

[addin][shortcuts] Load Shortcuts to SysTray via add-in

As a user, we should not be loading Shortcuts directly from SysTray class. Instead, we should be initializing it via Mono.Addins.

Acceptance

• Fix SysTray ExtensionPoint class and attributes
• Create Shortcuts Extension for SysTray, only providing target path

Tasks:

• Create ExtensionPoint for /ToolsHub/SystemTray (SysTrayAddin)
• Create extension using ShortcutsAddin class which is of IDisposable
• [ ]

[sidebar] Setting transparency level of sidebar

As a user, I want to be able to set the transparency level of the sidebar

Acceptance

• Set alpha transparency of sidebar

[shortcuts][systray] Create basic system tray launcher

As a user, I want to be able to access the application via the Windows' SystemTray icon.

Acceptance

• Menu item: Preferences
• Menu item: About
• Menu item: Exit

Out of Scope

• Add-in expandability
• Pretty icon

[design] Document and design SystemTray integration for Mono.Addins

As a developer, I would like to see the design document for how the app plans to implement the ExtensionPoint for SystemTray via Mono.Addins.

Acceptance

• Create wiki document for integration plans
• Create additional stories if need be

Out of Scope

• Implementing code for changes

[sidebar] Drag and drop to add or remove icons

Allow user to add shortcuts by drag/drop onto sidebar
Allow user to remove shortcut by dragging it off the sidebar

[stylecop] Follow XI's StyleCop rules

As a developer, we must follow the rules set forth by Xeno Innovations' StyleCop ruleset

Acceptance

• Publish the rules file to our public gist
• Modify all files to reduce warnings in accordance to the rules