Description

Natural language entry of alarm date/times

Additional Information

Links:
Maintainers: zargs
Version:1.0.8
Minimum app version:2.6
Downloads: This version:736
Last updated:2023-01-14T17:07:25Z

Joplin Plugin Auto Alarm

This plugin parses notes' titles during change events and enters that information as the Alarm Due Date.

  • /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.

Disclaimers

  • If a due date is already set, the plugin will skip entering a revised date
  • If the parsed title lacks a valid date, plugin will skip setting a due date
  • Plugin uses chrono for NL parsing, see repo for examples

Development

To cut a new release on Github, edit the version in src/manifest.json then commit the change.

Run:

make tag
git push --tags

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 npm run update.

In general this command tries to do the right thing - in particular it's going to merge the changes in package.json and .gitignore instead of overwriting. It will also leave "/src" as well as README.md untouched.

The file that may cause problem is "webpack.config.js" because it's going to be overwritten. For that reason, if you want to change it, consider creating a 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.