https://github.com/jmanuel1/todoer
Automatically add an email to your local todo.txt when you star it.
https://github.com/jmanuel1/todoer
email mailspring mailspring-plugin react todoer
Last synced: 5 months ago
JSON representation
Automatically add an email to your local todo.txt when you star it.
- Host: GitHub
- URL: https://github.com/jmanuel1/todoer
- Owner: jmanuel1
- License: mit
- Created: 2019-08-05T03:12:43.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-12-30T22:50:13.000Z (over 2 years ago)
- Last Synced: 2023-12-31T22:27:57.254Z (over 2 years ago)
- Topics: email, mailspring, mailspring-plugin, react, todoer
- Language: JavaScript
- Size: 981 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# **todoer**: A [Mailspring](https://getmailspring.com) plugin
Automatically add an email to your local
[todo.txt](https://github.com/todotxt/todo.txt) when you star or label it.
## What is it?
todoer is a Mailspring plugin that adds emails to your todo.txt whenever you
star them. The path to the todo file is configurable in a todoer tab under
Preferences (Ctrl+Comma on Windows). The plugin acts
completely locally--there's no sign-in to worry about! It even works with
todo.txt files that are synced over a cloud service.
## Features
* Puts your actionable email threads into your to-do list for you!
* Works with a `todo.txt` anywhere in your file system (as long as it has a
valid path).
* Each to-do item created from the subject and date of the thread.
## Installation
Download a release from [the releases
page](https://github.com/jmanuel1/todoer/releases) or clone the repository using
`git clone https://github.com/jmanuel1/todoer.git`. If you downloaded a release,
unzip into a folder.
In the folder containing the release, run `yarn build`. Next, open Mailspring.
In the menu, choose `Developer > Install a Plugin...`. Then choose the folder
containing the plugin. Note that installation might freeze Mailspring for a
while.
## [Usage (how to use todoer)](docs/USAGE.md)
## Development
Development should be done under Node **10.10+**.
This project uses Yarn as the package manager and npm scripts for build scripts.
Make sure to run `yarn` before you start development.
To build the plugin, use `yarn build`. You should get a `lib/main.js` file. To
test the build, use `yarn test`.
[Mailspring's API documentation](https://foundry376.github.io/Mailspring/) is
currently quite lacking, so there are [additional
notes](https://github.com/jmanuel1/todoer/wiki/Unofficial-Mailspring-API-Docs)
to supplement Mailspring's docs.
### Directory structure
Plugin code goes in `lib/`, tests/specs go in `spec/`.
`lib/` subfolders:
* `email-to-todo/`: code that converts email objects to todo.txt objects
* `settings/`: code that manages the plugin user preferences
* `changed-thread/`: code that grabs email threads upon any state change (like
a star or labels) and fires events when the change is relevant to the plugin
* `todo-txt/`: handles the creation of todo objects, reading and writing of
`todo.txt`
* `ui/`: user interface components
### Tests
Please add tests with your changes. Tests are written with
[Jasmine](https://jasmine.github.io).
## Roadmap
* Stability improvements
* See issue #1 (partially fixed)
* Offer installable builds
* This may be difficult since, as far as I know, Mailspring doesn't have a
user-friendly way of installing plugins yet