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

VS Code plugin #5

Open
5 tasks
StevenClontz opened this issue Mar 6, 2023 · 11 comments
Open
5 tasks

VS Code plugin #5

StevenClontz opened this issue Mar 6, 2023 · 11 comments
Milestone

Comments

@StevenClontz
Copy link
Member

  • The plugin should be a web extension and made available as easily as possible when using [a fork of] https://github.dev/pi-base/data
    • It's possible we find another essential request below to be out of scope for this, in which case a pi-base/data Codespace configuration could be considered instead
  • Markdown files should open both source and a useful preview of that source (incorporating YAML frontmatter)
  • Hovering over IDs in source should reveal info like title on the relevant item, and offer links to those files in the editor or to the corresponding page at https://topology.pi-base.org
  • "type checking" and completion/suggestions for YAML frontmatter
  • GUI to create new objects/props/thms that come with approrpiate boilerplate and are named with a timestamp something like T20230306150539.wip.md to prevent collisions. (Of course, I'd like to automate converting those to permanent IDs upon acceptance somehow...)
@jamesdabbs jamesdabbs added this to the future milestone May 16, 2023
@jamesdabbs jamesdabbs changed the title Tracker for VS Code plugin potential features VS Code plugin May 16, 2023
@jamesdabbs
Copy link
Member

@StevenClontz – do you use VSCode locally at all, or just entirely through Codespaces? I've cut a revamped version of this, and would appreciate if you could try to install it and let me know:

  • Does it install, or do you get an error?
  • Does it work? (Right now it's just doing some basic ID and external reference linking)

@StevenClontz
Copy link
Member Author

I use the web version exclusively (eating the dogfood, don't want to only know how to do things that require others to install things). I'll check this out

@StevenClontz
Copy link
Member Author

Tried this first, but it's not available. (Would be really nice as VS Code for Web is quicker to spin up than a Codespace.)

image

Trying a codespace now.

@StevenClontz
Copy link
Member Author

Hey neat.

image

image

Trying to open files causes an error (note backslashes):

image

@jamesdabbs
Copy link
Member

Alright, I made a little bit of progress getting this working in github.dev with the new release. Feel free to give that a try. Next-up issues:

  • Understand why the hover / id references aren't working on the web
  • Figure out the right way to handle filesystem / path joining (per the \ issue above)

@StevenClontz
Copy link
Member Author

The extension can be installed, but doesn't seem to have any effect:

image

image

@jamesdabbs
Copy link
Member

@StevenClontz – try again? (I fixed a bug where the P3 lookups that were expecting P000003)

@StevenClontz
Copy link
Member Author

So cool.

image

Now I need to get this rigged up by default for everyone...

@jamesdabbs
Copy link
Member

I saw pi-base/data@dd40b6f ... I think pi-base/data#655 is also worth adding?

@jamesdabbs
Copy link
Member

jamesdabbs commented May 29, 2024

@StevenClontz – 😎 Live on https://github.dev/pi-base/data now

Screenshot 2024-05-29 at 3 30 35 PM

I still need to get the click-to-follow-reference working here. (All of these errors were related to Codespaces using a vscode-vfs:// uri scheme instead of file:// as it is locally.) Once that's done, I'm inclined to get this POC merged in to this repo as a new package and start iterating from there. Sound good?

@StevenClontz
Copy link
Member Author

I'm inclined to get this POC merged in to this repo as a new package and start iterating from there. Sound good?

All good with me.

BTW I think pi-base/data@dd40b6f was what got things working in github.dev and pi-base/data#655 was what was needed for Codespaces.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants