================================================
FILE: biome.json
================================================
{
"$schema": "https://biomejs.dev/schemas/2.0.4/schema.json",
"vcs": {
"enabled": false,
"clientKind": "git",
"useIgnoreFile": true
},
"files": {
"ignoreUnknown": false,
"includes": ["src/**", "test/**", "!test/mocks/**"]
},
"formatter": {
"enabled": true,
"indentWidth": 4,
"useEditorconfig": true
},
"assist": {
"actions": {
"source": {
"organizeImports": "on"
}
}
},
"linter": {
"enabled": true,
"rules": {
"recommended": true,
"style": {
"noParameterAssign": "error",
"useAsConstAssertion": "error",
"useDefaultParameterLast": "error",
"useEnumInitializers": "error",
"useSelfClosingElements": "error",
"useSingleVarDeclarator": "error",
"noUnusedTemplateLiteral": "error",
"useNumberNamespace": "error",
"noInferrableTypes": "error",
"noUselessElse": "error"
}
}
},
"javascript": {
"formatter": {
"quoteStyle": "double"
}
}
}
================================================
FILE: docs/AppendingText.md
================================================
# Append text anywhere
You can define a [task group](README.md#task-groups) named `text` to create a string you can append to any line of text (not just tasks).
This can be useful if you want to configure a quick append string that matches the date format you use for your tasks.
Appending a date and removing matching text work in the same way for both tasks and general text, however, the appended date text is not removed if that line of text is later converted into a task.
================================================
FILE: docs/README.md
================================================
# Task Collector Configuration
This doc will give a high level overview of how Task Collector works, and its core configuration elements.
- [General Options](#general-options)
- [Task Groups](#task-groups)
- [Menus and modals](#menus-and-modals)
For readability, we've broken some things into their own docs:
- [Task Collection](TaskCollection.md)
- [Appending text to lines (not tasks)](AppendingText.md)
Other references:
- [Why marks?](../README.md#why-mark)
- [Task mark selection](../README.md#task-mark-selection)
- [Marking tasks](../README.md#marking-tasks)
---
## General options
- **Toggle: Task collection**
This option enables [Task collection](TaskCollection.md). Additional settings will be available if this is enabled.
- *default*: disabled
- **Define task mark cycle** _(optional)_
Use this option to specify a string of marks that can be iterated sequentially using `(TC) Mark previous` and `(TC) Mark next` commands.
- *default*: (empty string, disabled)
- **Notes**:
- `(TC) Mark previous` and `(TC) Mark next` are not registered unless or until a task mark cycle is defined.
- **Toggle: Convert non-list lines** (✨ 1.0.4)
Convert lines that are not tasks into tasks when you mark them.
- *default*: disabled
- **Skip matching sections** _(optional)_ (✨ 1.0.13)
When collecting tasks, skip any sections that match the specified pattern.
- *default*: (empty string, disabled)
- **Notes**:
- *Be careful!* Test your expression before using it. There are several [online](https://www.regextester.com/) [tools](https://regex.observepoint.com/) that can help.
---
## Task groups
One or more task marks can be configured together in a group.
- `default` is a special group that can not be deleted. Any mark that is not included in any other group uses the default group settings.
- `text` is a special name used for [appending text](AppendingText.md).
### Task group configuration
- **Group name** _(required)_
Each group should have a unique name. The names are significant only as an identifier.
- **Toggle: Complete**
Enable this toggle if this group of marks indicate [completed tasks](../README.md#completed-tasks).
- **Task marks** _(required)_
Tasks are specified as a contiguous string: ` !/?r`
- **Notes**:
- A mark can only belong to one group.
- A `space` is a valid character. If a space is present, `⎵` is drawn (CSS) as an eye-catcher.
- The string will sort itself as you add characters to it.
- **Append date to selected task(s)** _(optional)_
- *default*: (empty string, disabled)
- *example*: `[(]YYYY-MM-DD[)]`, results in `(2021-09-27)`
- **Notes**:
- When a [moment.js date format](https://momentjs.com/docs/#/displaying/format/) is specified, the current date/time will be appended to the task text.
- Use square brackets to surround content that is not part of the format string.
- When working with dataview-friendly annotations, for example, your format string should look something like this: `[[completion::]YYYY-MM-DD[]]`.
- See [marking tasks](../README.md#marking-tasks)
- **Remove text matching pattern**
Remove text matching this [regular expression](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions) from the task text.
- *default*: (empty string, disabled)
- *example*: `#(task|todo)` (remove #task or #todo tags)
- **Notes**:
- *Be careful!* Test your expression before using it. There are several [online](https://www.regextester.com/) [tools](https://regex.observepoint.com/) that can help.
- Aside from an immediate "undo", this is not a reversible operation.
- See [marking tasks](../README.md#marking-tasks)
- **Toggle: Register '(TC) Mark with... ' command**
Register a command _for each mark in the group_.
- *default*: `false`
- **Notes**:
- Commands can be bound to hot-keys...
- **Toggle: Add '(TC) Mark with... ' menu item**
Register a right-click context menu item _for each mark in the group_.
- *default*: `false`
- **Area heading** _(if [task collection](TaskCollection.md) is enabled)_
Matching marked items will be inserted under the specified heading (most recent at the top).
- *default*: (empty string, disabled)
- **Notes**:
- The area heading must be defined to enable collection for the group.
- See [task collection](TaskCollection.md) for details.
- **Toggle: Remove checkbox** _(if [task collection](TaskCollection.md) is enabled)_
Remove the checkbox marked tasks during the move to the configured area.
- *default*: false
---
## Menus and modals
- **Toggle: Prompt on checkbox click in Reading or Live preview**:
When true, the [Task mark selection dialog](../README.md#task-mark-selection) will be opened when you click on a checkbox in Reading or Live Preview mode.
- *default*: `false`
- **Notes**:
- This may conflict with a similar handler from the [Tasks](https://obsidian-tasks-group.github.io/obsidian-tasks/) plugin. Use one or the other, not both.
- **Toggle: Add '(TC) Mark task' menu item** (✨ 0.6.4)
Add an item to the right-click menu in edit mode to mark the task _on the current line (or within the current selection)_. It will open the [Task mark selection dialog](../README.md#task-mark-selection).
- *default*: `false`
- **Toggle: Add '(TC) Collect tasks' menu item** _(if [task collection](docs/../TaskCollection.md) is enabled)_
Add an item to the right-click menu to collect tasks in the current note.
- *default*: `false`
================================================
FILE: docs/TaskCollection.md
================================================
# Task collection
Task collection works on the tasks within a note.
Tasks that match a mark configured for collection will be gathered into the designated area of the note.
The `(TC) Collect Tasks` command or menu item triggers the following process:
1. Any missing Area headings will be added to the end of the document.
2. The document will be scanned from top to bottom to isolate discovered Area headings and their target sections.
3. General note content is scanned from top to bottom for tasks that should be collected. Each discovered task is moved to a block of pending tasks associated with the closest matching Area header ([where do tasks go](#where-do-tasks-go)?).
4. Collection target sections are then scanned (in order of appearance in the doc) for tasks that belong in a different section. Those are then added to the block of pending tasks for the closest matching Area header.
5. Finally, the document is reassembled. Area headings and their target sections are placed back into the document, with the pending block for each appearing immediately under the section header (most recent will be first).
If you walk through the above with the following example, you should end up with the tasks in the same order:
| Before | After |
|---|---|
| |