Add the Expansion of Swift Macros in VS Code Blog Post of Google Summer of Code 2024 #824
Conversation
lokesh-tr
force-pushed
the
gsoc24-expansion-of-swift-macros-in-vscode
branch
from
381d0ac to
5be9b00
Compare
|
@ahoppen I have addressed your review comments and made some minor changes. Let me know if you get any suggestions |
|
|
||
| Over the summer, we worked on adding support for expansion of Swift Macros in Visual Studio Code. Our project's main goal is to implement a code action in VS Code that allows users to view the generated contents of a Swift Macro. | ||
|
|
||
| Here's what it looks like to show the generated contents of a Swift Macro in a peeked editor when the "Expand Macro" Code Action is invoked by the user: |
There was a problem hiding this comment.
"peeked editor?" Maybe change to more common terminology
|  | ||
|  | ||
|
|
||
| There were also some stretch goals which include: |
| There were also some stretch goals which include: | ||
|
|
||
| 1. Bringing Semantic Functionality (such as jump-to-defintion, quick help on hover, Syntax Highlighting, etc.) to the macro expansion being previewed. | ||
| 2. Allowing to perform the "Expand Macro" Code Action on a macro that is present in the generated macro expansion to support the expansion of nested macros. |
There was a problem hiding this comment.
Perhaps better as "Allowing the "Expand Macro" Code Action on a nested macro that is present in the generated macro expansion"
|
|
||
| ### When can you start using this feature? | ||
|
|
||
| This will be available with SourceKit-LSP bundled with **Swift 6.1 and the corresponding VS Code Swift Extension Release**. For the curious minds, This feature is available in the `main` branch of `sourcekit-lsp` and `vscode-swift` repositories, right now. |
There was a problem hiding this comment.
the curious minds, This feature -> the curious, this feature
branch of -> branch of the
|
|
||
| ### Main Goal | ||
|
|
||
| In order to achieve the main goal, we introduced two new LSP extensions and new custom URL scheme as follows: |
There was a problem hiding this comment.
extensions and new -> extensions and a new
|
|
||
| #### Working of the "Expand Macro" Code Action | ||
|
|
||
| 1. The `"workspace/peekDocuments"` request is sent from SourceKit-LSP to the editor and prompts it to show the the contents of `locations` inside the source file `uri` as a peek window at `position`. In VS Code, this executes the `"editor.action.peekLocations"` command to present a peeked editor. |
There was a problem hiding this comment.
show the the contents -> show the contents
Maybe define the term "peeked editor" at the beginning if you want to use the term in this post.
There was a problem hiding this comment.
Thank you very much for preparing the post @lokesh-tr!
I'm discussing with relevant folks about schedule of publishing those. We may need a moment to figure it out, but I'm sure we'll get it published soon enough - thank you! We may need to prepare the other posts and then do a week of GSoC posts of something like that...
I proposed some minor things and we'd add a section about "what is GSoC" etc. But you don't have to immediately address those, let's give me a moment to figure out the schedule.
|
|
||
| `/* DUMMY DATE TO BE CHANGED BEFORE PR MERGE */` We're excited to announce that, with Swift 6.1, you can finally view the generated contents of a Swift Macro in Visual Studio Code and other LSP-based editors such as Neovim using the all-new "Expand Macro" Code Action. | ||
|
|
||
| I'm Lokesh T. R. from India. I'm a sophomore currently pursuing my bachelor's degree in Computer Science and Engineering at Vel Tech University in Chennai. I'm thrilled to share with you, my Google Summer of Code 2024 Project which I worked on with my mentors, Alex Hoppen and Adam Fowler. |
There was a problem hiding this comment.
The "about the author" is already taken from the authors.yml so this is a bit repeating the same 🤔
| author: [lokeshtr, ahoppen, adam-fowler] | ||
| --- | ||
|
|
||
| `/* DUMMY DATE TO BE CHANGED BEFORE PR MERGE */` We're excited to announce that, with Swift 6.1, you can finally view the generated contents of a Swift Macro in Visual Studio Code and other LSP-based editors such as Neovim using the all-new "Expand Macro" Code Action. |
There was a problem hiding this comment.
| `/* DUMMY DATE TO BE CHANGED BEFORE PR MERGE */` We're excited to announce that, with Swift 6.1, you can finally view the generated contents of a Swift Macro in Visual Studio Code and other LSP-based editors such as Neovim using the all-new "Expand Macro" Code Action. | |
| ## Swift Google Summer of Code Projects | |
| Sift regularly participates in [Google Summer of Code](https://summerofcode.withgoogle.com/) in order to help people new to the open source ecosystem dip their toes in contributing to Swift and its growing ecosystem. | |
| During the 2024 edition of the program, we ran four projects, all of which completed their assigned projects successfully. This year's projects were: | |
| - Expansion of Swift Macros in Visual Studio Code | |
| - Lexical scopes for swift-syntax | |
| - Swift-etcd: A Native Client for Seamless Integration with etcd Servers | |
| - Swift code generator to support the creation of SAM deployment descriptor | |
| We’d like to extend our sincere thanks to the participants and mentors who poured their time and passion into these projects, and use this post to highlight their work to the wider community. | |
| In this small series of blog posts we'd like to highlight some of the projects. | |
| ## Expansion of Swift Macros in Visual Studio Code | |
| `/* DUMMY DATE TO BE CHANGED BEFORE PR MERGE */` We're excited to announce that, with Swift 6.1, you can finally view the generated contents of a Swift Macro in Visual Studio Code and other LSP-based editors such as Neovim using the all-new "Expand Macro" Code Action. |
|
|
||
| I'm Lokesh T. R. from India. I'm a sophomore currently pursuing my bachelor's degree in Computer Science and Engineering at Vel Tech University in Chennai. I'm thrilled to share with you, my Google Summer of Code 2024 Project which I worked on with my mentors, Alex Hoppen and Adam Fowler. | ||
|
|
||
| ## Overview |
There was a problem hiding this comment.
| ## Overview | |
| ### Overview |
|  | ||
|  | ||
|
|
||
| ### When can you start using this feature? |
There was a problem hiding this comment.
| ### When can you start using this feature? | |
| #### When can you start using this feature? |
|
|
||
| This will be available with SourceKit-LSP bundled with **Swift 6.1 and the corresponding VS Code Swift Extension Release**. For the curious minds, This feature is available in the `main` branch of `sourcekit-lsp` and `vscode-swift` repositories, right now. | ||
|
|
||
| ## Implementation Details |
There was a problem hiding this comment.
| ## Implementation Details | |
| ### Implementation Details |
|
|
||
| ## Implementation Details | ||
|
|
||
| ### How Swift Language Features work in LSP-based editors |
There was a problem hiding this comment.
| ### How Swift Language Features work in LSP-based editors | |
| #### How Swift Language Features work in LSP-based editors |
| - provides the raw data and operations to SourceKit-LSP | ||
| - shares implementation details with the Swift compiler | ||
|
|
||
| ### Main Goal |
There was a problem hiding this comment.
| ### Main Goal | |
| #### Main Goal |
Thank you so much for having detailed blog posts unlike the previous years!
Sure, Please do take your time for organising the schedule.
That makes, sense.
Please do take your time and once things are sorted out, just wave me a green flag, then I will address all of your comments. Alright? |
|
Thanks for the review @finagolfin , I will address your comments in my next commit along with Konrad's comments. |
This PR adds my Google Summer of Code 2024 work "Expansion of Swift Macros in Visual Studio Code" as a blog post.
(NOTE: I'm aware of the fact that there's a separate governance process for blog posts in swift.org website, and I believe this is something that my mentor and GSoC org admin will take care of, please read further to learn more)
Motivation:
Over the summer, I worked with my mentors, Alex Hoppen and Adam Fowler, on my Google Summer of Code 2024 Project known as "Expansion of Swift Macros in Visual Studio Code" and it was a success.
The time for having the annual Google Summer of Code summary blog post is coming soon. As per my mentor, @ahoppen , based on some internal discussions (which I believe happened between him, the GSoC Organisation Admin @ktoso and the other GSoC mentors), it seems like we are likely to have separate blog posts for each GSoC project this year instead of a summary blog post. (I'm not very certain of the specifics)
And as suggested by my mentor @ahoppen , here I made this PR that adds my GSoC work as a blog post to the swift.org website.
Modifications:
_postsfolder.assets/images/expansion-of-swift-macros-in-vscode-blogfolder.authors.ymlfile to have details about me (the author of this blog post).Result:
A new blog post will appear in the blog page. Clicking
Read More...will lead to the full blog post. This blog post will talk about my work which I did over the summer with my mentors which is "Expansion of Swift Macros in Visual Studio Code"cc @ahoppen @adam-fowler
Please let me know if you have any suggestions to this blog post (I did very few minor changes from the swift forums post). Also, let me know if I overlooked any details or the coding standards / conventions of this repository.