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.

Sign up for GitHub

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

Jump to bottom

fix: Tasks Auto-Suggest works again in the Kanban plugin #2908

Merged
merged 16 commits into from
Jun 22, 2024
Merged

fix: Tasks Auto-Suggest works again in the Kanban plugin #2908

merged 16 commits into from
Jun 22, 2024

Conversation

claremacrae
Copy link
Collaborator

Types of changes

Changes visible to users:

Internal changes:

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

Description

The majority of this work was done pairing with @ilandikov - thanks!

  • Refine the fix for Adding dependencies via Auto-Suggest can add multiple ID values #2872 so that it does not require the editor to be a MarkdownView.
    • But if it isn't a MarkdownView, Auto-Suggest won't offer id and dependsOn suggestions.
  • Test vault:
    • Install the Kanban plugin
    • Create a file for testing the integration: resources/sample_vaults/Tasks-Demo/Manual Testing/Smoke test Kanban Integration.md
  • Document the limitation for users

Motivation and Context

Fix #2896

How has this been tested?

  • New test added
  • Exploratory testing in built plugin
    • Check that suggestions in Kanban still work
    • Check that suggestions still work in Tasks

Screenshots (if appropriate)

Checklist

Terms

@claremacrae
vault: Install and enable Kanban plugin
1c56da9
@claremacrae
chore: Delete verify-on-windows.yml as builds are failing
033361c 
And it's not worth spending time on fixing it.

This required turning off markdown lint on the specific Kanban file,
as there is no level-1 heading.
@claremacrae
refactor: ! SuggestionBuilder now takes extra suggestDependencies par…
ca16d8f 
…ameter
@claremacrae
fix: Don't show dependsOn and id suggestions, if we can't save the file
1fbe7bb
@claremacrae
fix: Remove error message in Kanban plugin after suggestion accepted
0417d57 
Now that we are not offering dependency suggestions if we cannot save the file,
we do not need to tell the user we could not save the file.

Fixes #2896.
@claremacrae
refactor: ! Extract includeDependencySuggestions() to localise logic
72eed62
@claremacrae
refactor: . Rename suggestDependencies to canSaveEdits
d9d8848
@claremacrae
refactor: . Extract method getMarkdownFileInfo()
500046d
@claremacrae
refactor: . Extract method canSaveEdits()
d26fd2e
@claremacrae
test: - Extract constant CAN_SAVE_EDITS
c046685
@claremacrae
test: - Create new (failing) test, preparing to test canSaveEdits use
0405d04
@claremacrae
test: . Inline one call of shouldOnlyOfferDefaultSuggestions()
7732951
@claremacrae
test: . Inline one call of buildSuggestionsForEndOfLine()
dfe7076
@claremacrae
test: Finish setting up test of suggestions when cannot save file
033e817
@claremacrae
test: . Inline originalSettings and allTasks
02196e3
@claremacrae
docs: Document that Auto-Suggestion intergration works best with Mark…
4319283 
…downView editors

See #2896
@claremacrae claremacrae added scope: auto-suggest The pop-up menu that helps with editing tasks directly in markdown notes scope: for plugin developers Tools for use by plugin developers, including the Tasks API labels Jun 22, 2024
@claremacrae claremacrae merged commit 4720739 into main Jun 22, 2024
2 checks passed
@claremacrae claremacrae deleted the kanban-auto-suggest branch June 22, 2024 13:51
@claremacrae claremacrae changed the title fix: Tasks Auto Suggest works again in the Kanban plugin fix: Tasks Auto-Suggest works again in the Kanban plugin Jun 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
scope: auto-suggest The pop-up menu that helps with editing tasks directly in markdown notes scope: for plugin developers Tools for use by plugin developers, including the Tasks API
Projects
None yet
Milestone
No milestone
1 participant
@claremacrae