Skip to content

tbergeron/joplin-statusbar

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Joplin Statusbar

Very simple plugin that adds a view to use as a statusbar.

For now it only displays the last sync time.

Its initial purpose is to display last sync time without needed any sidebars enabled.

The main two files you will want to look at are:

  • /src/index.ts, which contains the entry point for the plugin source code.
  • /src/manifest.json, which is the plugin manifest. It contains information such as the plugin a name, version, etc.

TODO

  • Display when sync is in progress
    • Needs API support (is it implemented yet?)
  • Display when sync has failed
    • Needs API support (is it implemented yet?)
  • Fix issues when vertically resizing Joplin's window
    • See if possible to keep a fixed height for that panel
  • Find a way to merge tags bar with statusbar to save vertical space
    • Current panels imeplementation could prevent this

Building the plugin

The plugin is built using Webpack, which creates the compiled code in /dist. A JPL archive will also be created at the root, which can use to distribute the plugin.

To build the plugin, simply run npm run dist.

The project is setup to use TypeScript, although you can change the configuration to use plain JavaScript.

Updating the plugin framework

To update the plugin framework, run yo joplin --update

Keep in mind that doing so will overwrite all the framework-related files outside of the "src/" directory (your source code will not be touched). So if you have modified any of the framework-related files, such as package.json or .gitignore, make sure your code is under version control so that you can check the diff and re-apply your changes.

For that reason, it's generally best not to change any of the framework files or to do so in a way that minimises the number of changes. For example, if you want to modify the Webpack config, create a new separate JavaScript file and include it in webpack.config.js. That way, when you update, you only have to restore the line that include your file.