joplin-plugin-inline-todo 1.0.0

package/README.md

@@ -0,0 +1,117 @@
+# Inline TODOs
+A plugin that allows you to manage your TODOs anywhere in your notes and view a summary in one place.
+
+This plugin was initially written before the plugin system and interacted with Joplin through the API. I've been using it like that for the last few years. I finally took the time to translate it into the official Plugin system. Its implementation is pretty specific to my workflow and I don't plan to update it much, as it works for me.
+
+# Installation
+- Go to `Tools -> Options -> Plugins`
+- Search for "Inline TODO" in the search box
+- Click Install and restart Joplin
+- Create a Todo Summary in your folder of choice (Tools -> Create TODO Summary Note)
+
+
+# Configuration
+## TODO Types
+### Confluence Style
+Inspired by [this post](https://discourse.joplinapp.org/t/create-a-task-report-plugin-for-a-joplin-note-taking-app/21177) on the Joplin forum. This is the preferred style because it uses the markdown checkbox format (making it trivial to check the box and hide the TODO from the summary). 
+This format does have the limitation that it only accepts dates of the form YYYY-MM-DD.
+
+The basic form is a checkbox, followed by @category (this can be anything, including an assignee), followed by an optional date (prefixed with //), and finally the TODO content.
+
+```
+I take a lot of notes about various things. It can be helpful to
+keep my TODOs together with the content they pertain to.
+
+- [ ] @TODO Think about how to make a plugin to solve this
+
+This way the TODO benefits from context.
+
+- [ ] @TODO //2022-04-04 Release the TODO plugin!
+
+I'd still like a way to view all these! See below.
+```
+
+
+### Link Style
+This is a simple TODO style that I've been using for the last few years. It intentionally uses the markdown link syntax which gives it highlighting in the editor and the viewer.
+This format can accept a [wider variety](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse#date_time_string_format) of date formats.
+
+The basic form is a link, where the name is "TODO" and the date replaces the URL section. The TODO content just follows after.
+
+```
+I take a lot of notes about various things. It can be helpful to
+keep my TODOs together with the content they pertain to.
+
+[TODO]() Think about how to make a plugin to solve this
+
+This way the TODO benefits from context.
+
+[TODO](2022-04-04) Release the TODO plugin!
+
+I'd still like a way to view all these! See below.
+```
+
+### List Style
+This style just uses markdown checklist items. What sets this apart from the Confluence style is the lack of support for categories and dates in this style. This style was created for users that are already happy using plain checklists for their tasks, but want an additional place to collect them. For most users, I recommend the Confluence style instead.
+
+```
+I take a lot of notes about various things. It can be helpful to
+keep my TODOs together with the content they pertain to.
+
+- [ ] Think about how to make a plugin to solve this
+
+This way the TODO benefits from context.
+
+- [ ] Release the TODO plugin!
+
+I'd still like a way to view all these! See below.
+```
+
+
+## Summary Types
+There are two supported summary styles.
+
+### Plain
+This is the basic style that I created for myself, and have been using for the last few years. 
+
+It starts by showing all the TODOs that have dates under the DUE section (sorted by date). After that, all the other TODOs are shown in no specific order under their respective category and parent notebook.
+
+This style is meant for personal use, the table method (below) is recommended for more complex use.
+
+```
+# DUE
+- [Note a](:/e710b7af31fc47c89ca5fc4d3c0ecb3a): 2022-01-13 Have some me time
+
+- [Note b](:/beef7ed6d91649149751cea8d14af02d): 2022-03-12 Meat delivery
+
+# Bob
+## Folder 2
+- [Note c](:/ef3aac56ffa246baa6a96cc94dd8f25e): Call Teddy
+
+# Linda
+## Folder 1
+- [Note b](:/beef7ed6d91649149751cea8d14af02d): I'll get to this eventually
+```
+
+### Table
+This is particularly powerful when combined with hieuthi's [table sorting plugin](https://discourse.joplinapp.org/t/plugin-markdown-table-sortable/21846).
+
+```
+| Task | Assignee | Due | Notebook | Note |
+| ---- | -------- | --- | -------- | ---- |
+| Have some me time | Linda | 2022-01-13 | Folder 3 | [Note a](:/e710b7af31fc47c89ca5fc4d3c0ecb3a)
+| Call Teddy | Bob |  | Folder 2 | [Note c](:/ef3aac56ffa246baa6a96cc94dd8f25e)
+| I'll get to this eventually | Linda |  | Folder 1 | [Note b](:/beef7ed6d91649149751cea8d14af02d)
+| Meat delivery | Bob | 2022-03-12 | Folder 1 | [Note b](:/beef7ed6d91649149751cea8d14af02d)
+```
+
+
+# Roadmap
+I consider this plugin to be finished (it meets my needs). But below are some ideas that I will implement in the future if I have some time.
+### Ideas
+- [ ] More robust date handling for List style TODO
+- [ ] Add in the fuzzy date handling (e.g. mid april)
+- [ ] Add a renderer component that adds html ids (so we can scroll to TODOs)
+- [ ] Add support for the [Metis plugin](https://github.com/hieuthi/joplin-plugin-metis) (todo.txt)
+- [ ] [xit format](https://xit.jotaen.net/)
+

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "joplin-plugin-inline-todo",
+  "version": "1.0.0",
+  "scripts": {
+    "dist": "webpack --joplin-plugin-config buildMain && webpack --joplin-plugin-config buildExtraScripts && webpack --joplin-plugin-config createArchive",
+    "prepare": "npm run dist",
+    "update": "npm install -g generator-joplin && yo joplin --update",
+    "updatetags": "LOGS=$(git log $(git describe --tags --abbrev=0 HEAD~1)..HEAD~1 --oneline) && git tag -fam \"v$npm_package_version\n\n$LOGS\" v$npm_package_version && git tag -fa v$npm_package_version",
+    "postversion": "npm run updatetags && git push origin master --tags",
+    "version": "sed -i '/\\\"version\\\": \\\"/s/[^\\\"]*\\\",/'\"$npm_package_version\\\",/\" src/manifest.json && git add src/manifest.json"
+  },
+  "license": "MIT",
+  "keywords": [
+    "joplin-plugin", "todo"
+  ],
+  "devDependencies": {
+    "@types/node": "^14.0.14",
+    "chalk": "^4.1.0",
+    "copy-webpack-plugin": "^6.1.0",
+    "fs-extra": "^9.0.1",
+    "glob": "^7.1.6",
+    "on-build-webpack": "^0.1.0",
+    "tar": "^6.0.5",
+    "ts-loader": "^7.0.5",
+    "typescript": "^3.9.3",
+    "webpack": "^4.43.0",
+    "webpack-cli": "^3.3.11",
+    "yargs": "^16.2.0"
+  }
+}

package/plugin.config.json

@@ -0,0 +1,10 @@
+{
+  "extraScripts": [
+    "types.ts",
+    "builder.ts",
+    "settings_tables.ts",
+    "summaryFormatters/table.ts",
+    "summaryFormatters/plain.ts",
+    "summary.ts"
+  ]
+}

package/publish/plugin.calebjohn.todo.json

@@ -0,0 +1,17 @@
+{
+	"manifest_version": 1,
+	"id": "plugin.calebjohn.todo",
+	"app_min_version": "2.7",
+	"version": "1.0.0",
+	"name": "Inline TODO",
+	"description": "Write TODOs *everywhere* and view them in one place.",
+	"author": "Caleb John",
+	"homepage_url": "https://github.com/CalebJohn/joplin-inline-todo#readme",
+	"repository_url": "https://github.com/CalebJohn/joplin-inline-todo",
+	"keywords": [
+		"todo",
+		"productivity"
+	],
+	"_publish_hash": "sha256:20c2e0a02fbc2a6a68b272f2e8dcc193d009f43ecc41294ef47f1fdc3c2e86f7",
+	"_publish_commit": "master:39922806ca28d86d8abb9bc94f52d9b2bebdb4ad"
+}