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

Add VS Code swift extension post #95

Merged
merged 15 commits into from
Jul 14, 2022

Conversation

adam-fowler
Copy link
Contributor

@adam-fowler adam-fowler commented Jun 30, 2022

Motivation:

Contribute a blog post about the SSWG developed Visual Studio Code Swift extension

Modifications:

Add VSCode extension blog post markdown

@adam-fowler
Copy link
Contributor Author

@cthielen


### Test Explorer

The Test Explorer provides a UI similar to the Xcode Tests UI. The UI contains a tree view, including all the test targets, with each XCTestCase class embedded within those targets and each individual test embedded within those classes. Tests can be run outside of a debugger or in the debugger. You can run individual tests, or filter the tests being run by class or test target, or just run all tests. The UI updates as tests succeed or fail.
Copy link
Contributor Author

@adam-fowler adam-fowler Jun 30, 2022

Choose a reason for hiding this comment

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

Not sure about the use of the word embedded in the TestExplorer section, but can't think of a better alternative. Was thinking of rewriting this section it doesn't really make total sense. There is no discrimination between the actual tests and the tree view elements that represent them.

The Test Explorer provides a UI similar to the Xcode Tests UI. The UI contains a tree view with top level elements representing each test target in your package. These top level elements then contain child elements that represent each XCTestCase class in the test targets and each XCTestCase element contain leaf elements that represent each individual test. Tests can be run outside of a debugger or in the debugger. You can run individual tests, or filter the tests being run by class, name or test target, or just run all tests. The UI updates as tests succeed or fail.

What do you think?

Copy link
Member

Choose a reason for hiding this comment

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

Yeah makes sense, or replace embedded with contained

Copy link
Member

@0xTim 0xTim left a comment

Choose a reason for hiding this comment

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

I'm guessing we're leaving out package editing until it stabilises in 5.7?

I also think we should call out Steven for the initial work on the extension.

Otherwise LGTM other than a few nits

_posts/2022-06-30-vscode-extension.md Outdated Show resolved Hide resolved

### Test Explorer

The Test Explorer provides a UI similar to the Xcode Tests UI. The UI contains a tree view, including all the test targets, with each XCTestCase class embedded within those targets and each individual test embedded within those classes. Tests can be run outside of a debugger or in the debugger. You can run individual tests, or filter the tests being run by class or test target, or just run all tests. The UI updates as tests succeed or fail.
Copy link
Member

Choose a reason for hiding this comment

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

Yeah makes sense, or replace embedded with contained

_posts/2022-06-30-vscode-extension.md Outdated Show resolved Hide resolved
@0xTim
Copy link
Member

0xTim commented Jun 30, 2022

@swift-ci test

@@ -0,0 +1,51 @@
# Swift Extension for Visual Studio Code
Copy link
Member

Choose a reason for hiding this comment

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

We should add post header

Example:

---
layout: post
published: true
date: 2022-06-15 09:20:00
title: Announcing the Language Workgroup
author: tkremenek
about: Ted Kremenek is a member of the Swift Core Team and serves as the voice of the Project Lead.  Ted manages the Languages and Runtimes group at Apple.
---

Copy link
Member

Choose a reason for hiding this comment

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

FYI, about the author does not have to be included in the post header. This information is fetched from authors.yml.

I see @adam-fowler is not in the author list though. Might be a good idea to add yourself. 🙂

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is the author link the swift forum username?

Copy link
Member

Choose a reason for hiding this comment

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

@adam-fowler The identifier is only used internally and can be anything, but preferably one of your usernames. You can also add twitter and github properties which will link to your profiles.

@tkremenek
Copy link
Member

tkremenek commented Jun 30, 2022

Do we want a screenshot or anything in the post? Right now the post is mostly a bunch of (good) text. I wonder if visually this could be more interesting, and we can show the plugin.

@adam-fowler
Copy link
Contributor Author

Do we want a screenshot or anything in the post? Right now the post is mostly a bunch of (good) text. I wonder if visually this could be more interesting, and we can show the plugin.

Screenshots would be good. Maybe of the dependency view and the test explorer. There are examples in the README for the GitHub project https://github.com/swift-server/vscode-swift/blob/main/README.md

@tkremenek
Copy link
Member

We don't need to be shy with screenshots, even small ones. Many Swift.org posts are a bit dry with being mostly text. Given that this is talking about specific tool work where we have the opportunity to show the extension in action, there is an opportunity to show all the key pieces that are working.

@adam-fowler
Copy link
Contributor Author

@tkremenek where should I put the images?

@shahmishal
Copy link
Member

shahmishal commented Jul 1, 2022

@tkremenek where should I put the images?

You can place them here:
https://github.com/apple/swift-org-website/tree/main/assets/images

@adam-fowler
Copy link
Contributor Author

We don't need to be shy with screenshots, even small ones. Many Swift.org posts are a bit dry with being mostly text. Given that this is talking about specific tool work where we have the opportunity to show the extension in action, there is an opportunity to show all the key pieces that are working.

How about a movie? I've just added a symbol completion movie.

@tkremenek
Copy link
Member

We don't need to be shy with screenshots, even small ones. Many Swift.org posts are a bit dry with being mostly text. Given that this is talking about specific tool work where we have the opportunity to show the extension in action, there is an opportunity to show all the key pieces that are working.

How about a movie? I've just added a symbol completion movie.

The video looks great!

@tkremenek
Copy link
Member

tkremenek commented Jul 3, 2022

A fragment of the page with the images:

vscode-lsp-screenshot

@tkremenek
Copy link
Member

@swift-ci test

@0xTim
Copy link
Member

0xTim commented Jul 6, 2022

@adam-fowler csn you fix the merge conflicts and set the date to tomorrow? We'll publish it tomorrow to give the other post a bit of space

@adam-fowler
Copy link
Contributor Author

@adam-fowler csn you fix the merge conflicts and set the date to tomorrow? We'll publish it tomorrow to give the other post a bit of space

done

@tkremenek
Copy link
Member

I believe that @cthielen, who manages the swiftlang Twitter handle, is out on vacation for a couple days. I think we should hold the post until we can be sure we can tweet at the time the post goes out. I'll check on timing.

@alexandersandberg
Copy link
Member

@swift-ci test

@0xTim
Copy link
Member

0xTim commented Jul 8, 2022

@tkremenek are we good to merge?

@tomerd
Copy link
Contributor

tomerd commented Jul 11, 2022

@0xTim we should let @cthielen merge - we should discuss more on the next workgroup meeting

@cthielen cthielen merged commit e3a9ae8 into swiftlang:main Jul 14, 2022
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

Successfully merging this pull request may close these issues.

None yet

7 participants