Skip to content

Add support for adding custom examples to Examples view #436

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
Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Add support for adding custom examples to Examples view #436

wants to merge 11 commits into from

Conversation

SanjulaGanepola
Copy link
Member

@SanjulaGanepola SanjulaGanepola commented Aug 27, 2025 •
edited
Loading

Changes

This PR adds support for adding custom examples to the Examples view (similar to ACS).

  • Add Custom Example Directories setting
  • Auto refresh Examples view when setting change
  • Load all SQL files from custom directories and 1 subdirectory deeper into Examples view
  • Add watchers for custom example directories to refresh the view on additions, deletions, and changes
  • Set category name as parent folder or category tag from the comments
  • Set example name as file name or description tag from the comments
  • Add right-click Edit Example button for custom examples only
  • Added Refresh Examples button to Examples view
  • Add Custom Examples Directory submenu button to Examples view
    • Add Add... button
    • Add Remove... button
  • Add Save As New Example button
  • Update docs

Other:

  • Re-ordered actions in statement history view

@github-actions GitHub Actions
Copy link

github-actions bot commented Aug 27, 2025 •
edited
Loading

👋 A new build is available for this PR based on 970deb5.

@SanjulaGanepola SanjulaGanepola changed the title Add support for adding custom examples to Examples review Add support for adding custom examples to Examples view Aug 27, 2025
@worksofliam worksofliam linked an issue Aug 27, 2025 that may be closed by this pull request
Add custom examples #377
Open
@SanjulaGanepola
Add support for saving new examples
06c7868 
Signed-off-by: Sanjula Ganepola <[email protected]>
@SanjulaGanepola
Move submenu contribution
429f93f 
Signed-off-by: Sanjula Ganepola <[email protected]>
@SanjulaGanepola SanjulaGanepola marked this pull request as ready for review August 28, 2025 17:08
@SanjulaGanepola
Copy link
Member Author

@forstie This PR is ready for review now! A summary of all changes are listed in the PR body. I am also writing up some quick docs on this too.

VSIX downloadable from comment above.

@SanjulaGanepola
Add watchers for examples directory
a1b67e1 
Signed-off-by: Sanjula Ganepola <[email protected]>
@SanjulaGanepola
Copy link
Member Author

@worksofliam For a smoother user experience, I opted to go with what you originally suggested and added a FileSystemWatcher. Since we have Edit Example, I think it makes sense to have it.

forstie
forstie approved these changes Aug 29, 2025
View reviewed changes
Copy link
Collaborator

@forstie forstie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes are working great for me now, good going!

@SanjulaGanepola
Copy link
Member Author

Docs PR: codefori/docs#73

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@forstie forstie forstie approved these changes

@worksofliam worksofliam Awaiting requested review from worksofliam

@julesyan julesyan Awaiting requested review from julesyan

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add custom examples
2 participants
@SanjulaGanepola @forstie