Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Enable visualisation of the Status settings #2383

Merged
merged 16 commits into from
Oct 29, 2023
Merged

Conversation

claremacrae
Copy link
Collaborator

Description

From replying to Tasks Issues and Features, it would be really useful to have a way to visualise a user's status settings, and even have a report of any issues in the settings.

This is what I've done so far:

  • Add a button called Review and check your Statuses to the Tasks Custom Status settings.
  • When clicked, it creates and opens a new markdown file, in the root of the vault.
  • For simplicity, the file has a time-stamp in the name, so repeated running generates different files.
  • The markdown file shows a Mermaid diagram of the Tasks Statuses actually loaded in the vault.

I plan to add some error checking info in a later PR.

Note: I'm planning on changing this some more, so am holding off writing the documentation for now.

Motivation and Context

Fixes #2354 - good enough for a first implementation I feel.

How has this been tested?

  • Added new tests
  • Ran existing ones
  • Lots of manual testing in the demo vault, with a variety of different Status combinations.

Screenshots (if appropriate)

The new button, with its current tooltip text shown:

image

An example output file, opened automatically and viewed in Obsidian's Liew Preview mode:

image

Types of changes

Changes visible to users:

  • New feature (prefix: feat - non-breaking change which adds functionality)

Internal changes:

  • Tests (prefix: test - additions and improvements to unit tests and the smoke tests)

Checklist

Terms

@claremacrae claremacrae added the scope: task states Requests relating to custom task states, like 'in-progress', for example, and state transitions label Oct 29, 2023
@claremacrae claremacrae merged commit 0ca7650 into main Oct 29, 2023
2 checks passed
@claremacrae claremacrae deleted the add-statuses-report branch October 29, 2023 20:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope: task states Requests relating to custom task states, like 'in-progress', for example, and state transitions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enable users to visualise the Status settings, and see any problems
1 participant