Skip to content

Rename the extension from sswg.swift-lang to swiftlang.vscode-swift #1137

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

Merged
merged 1 commit into from
Jan 23, 2025
Merged

Rename the extension from sswg.swift-lang to swiftlang.vscode-swift #1137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,10 @@ If you haven't already, follow the instructions in [Development](#development) t
npm run dev-package
```

This builds a file that looks like `swift-lang-[version]-dev.vsix`. Now install the extension with:
This builds a file that looks like `vscode-swift-[version]-dev.vsix`. Now install the extension with:

```sh
code --install-extension swift-lang-[version]-dev.vsix
code --install-extension vscode-swift-[version]-dev.vsix
```

Alternatively you can install the extension from the Extensions panel by clicking the `...` button at the top of the panel and choosing `Install from VSIX...`.
Expand Down
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,19 @@ This extension adds language support for Swift to Visual Studio Code. It support

Swift support uses [SourceKit LSP](https://github.com/apple/sourcekit-lsp) for the [language server](https://microsoft.github.io/language-server-protocol/overviews/lsp/overview/) to power code completion and [LLDB](https://github.com/vadimcn/vscode-lldb) to enable debugging.

The extension is developed by members of the Swift Community and maintained by the [SSWG](https://www.swift.org/sswg/). The aim is to provide a first-class, feature complete extension to make developing Swift applications on all platforms a seamless experience.
The aim is to provide a first-class, feature complete extension to make developing Swift applications on all platforms a seamless experience.

If you experience any issues or want to propose new features please [create an issue](https://github.com/swiftlang/vscode-swift/issues/new) or post on the [swift.org forums](https://forums.swift.org) in the [VS Code Swift Extension category](https://forums.swift.org/c/related-projects/vscode-swift-extension/).

## Contributing

The Swift for Visual Studio Code extension is a community driven project, developed by the amazing Swift community. Any kind of contribution is appreciated, including code, tests and documentation. For more details see [CONTRIBUTING.md](CONTRIBUTING.md).
The Swift for Visual Studio Code extension is a community driven project originally created by the [Swift Server Working Group](https://www.swift.org/sswg/) and now maintained as part of the [swiftlang organization](https://github.com/swiftlang/). Contributions are appreciated, including code, tests and documentation. For more details see [CONTRIBUTING.md](CONTRIBUTING.md).

To give clarity of what is expected of our members, Swift has adopted the code of conduct defined by the Contributor Covenant. This document is used across many open source communities, and we think it articulates our values well. For more, see the [Code of Conduct](https://swift.org/code-of-conduct/).

## Installation

For the extension to work, you must have Swift installed on your system. Please see the [Getting Started Guide on Swift.org](https://www.swift.org/getting-started/) for details on how to install Swift on your system. Install the extension from [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=sswg.swift-lang) and open a Swift package! You'll be prompted to install and configure the CodeLLDB extension, which you should do so.
For the extension to work, you must have Swift installed on your system. Please see the [Getting Started Guide on Swift.org](https://www.swift.org/getting-started/) for details on how to install Swift on your system. Install the extension from [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=swiftlang.vscode-swift) and open a Swift package! You'll be prompted to install and configure the CodeLLDB extension, which you should do so.
Copy link
Member

Choose a reason for hiding this comment

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

Is the name fixed? vscode-swift both seems redundant and would suggest it excludes other IDEs that the extension should work in (e.g. #90 )

FWIW all the other 1st class language extensions just use the language name, like golang.Go and rust-lang.rust

Copy link
Contributor

Choose a reason for hiding this comment

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

I've seen Microsoft do this eg Microsoft.vscode-python but yeah the vscode- still does seem kind of redundant.

Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure what the convention is, but I think it would be nice to spell it out as: swiftlang.extension (can be read as "Swift Language Extension"). It feels natural to me, would like to know what you guys think?

Copy link
Contributor

Choose a reason for hiding this comment

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

I don't find swiftlang.swift ("Swift Language Swift") and swiftlang.vscode-swift ("Swift Language VS Code Swift") to read out well and it feels redundant

Copy link
Contributor

@lokesh-tr lokesh-tr Oct 12, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Checking with the extension's marketplace page, it describes the extension as "Swift Language Support for Visual Studio Code". So, It feels natural for me to name the extension ID as swiftlang.support or swiftlang.extension.

These will go well with tutorials or environment setup guides:
"Install the swiftlang.support extension in your editor" or
"Install the swiftlang.extension in your editor".

If not for these two, going with swiftlang.swift will be better than going with swiftlang.vscode-swift. :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@0xTim I like your point about not being specifically for VS Code; compatible forks are gaining popularity (VS Codium, Cursor). It may be worth doing a pass on the language in the documentation in a follow on PR to refine the language so it's more generic.

Copy link
Contributor

Choose a reason for hiding this comment

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

@0xTim, totally get your point about other forks that support VSCode extensions. If there were a consistent generic term that was well understood, that might be an alternative. VSIX is the extension name, but it's a little overloaded with connotations from "full" Visual Studio; there's also VSX (as in, the Open VSX repository).

That said, even in the open repository, they describe it as "extensions for VS Code-compatible editors", which suggests that no other term has yet reached the desired level of general understanding.

The other considerations that went into proposing swiftlang.vscode-swift were:

  1. It matches the repository name, so anyone encountering this extension already has an inkling of where to find its home.
  2. It is confusion-free both in the Swift context and the Visual Studio context. A user who encounters this on their system will understand what it is and where it comes from.
  3. This name is purely used as a unique identifier. We wouldn't / shouldn't use it in user-facing documentation.

@plemarquand Good call on making the language more generic (although we'd need to test the extension in a few other places to really feel comfortable that it doesn't have any hidden dependencies on VSCode: I don't think we test it anywhere else, do we?)

Copy link
Contributor Author

@plemarquand plemarquand Oct 12, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

@timsneath there aren't any formalized tests with other forks but I've used Cursor casually and the extension has worked great.

VS Codium is basically identical to VS Code but with telemetry disabled so I've got high confidence the extension will work, but I haven't tried loading the .vsix in to it yet. Will make a note that needs to be tested there if we choose to publish to their marketplace.

Copy link
Contributor

Choose a reason for hiding this comment

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

@plemarquand Good call on making the language more generic (although we'd need to test the extension in a few other places to really feel comfortable that it doesn't have any hidden dependencies on VSCode: I don't think we test it anywhere else, do we?)

I think Apple legal still have to review the terms and conditions to publish on OpenVSX. So we never really treated it as an alternative platform as we weren't publishing to it (although OpenVSX have an unofficial copy up https://open-vsx.org/extension/sswg/swift-lang). Maybe now everything is moving to swiftlang we can organise an OpenVSX version.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, once we've wrapped up the work to get the newly identified extension up on the VSCode Marketplace, we'll be working with Apple legal to move forward with the OpenVSX work.


## Features

Expand Down
4 changes: 2 additions & 2 deletions docs/remote-dev.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ First create the directory. Next, create `devcontainer.json` and insert the foll
"name": "Swift 5.5",
"image": "swift:5.5",
"extensions": [
"sswg.swift-lang"
"swiftlang.vscode-swift"
],
"settings": {
"lldb.library": "/usr/lib/liblldb.so"
Expand Down Expand Up @@ -73,7 +73,7 @@ Your `devcontainer.json` should look something like this
"service": "app",
"workspaceFolder": "/workspace",
"extensions": [
"sswg.swift-lang",
"swiftlang.vscode-swift",
],
"settings": {
"lldb.library": "/usr/lib/liblldb.so"
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"name": "swift-lang",
"name": "vscode-swift",
"displayName": "Swift",
"description": "Swift Language Support for Visual Studio Code.",
"version": "1.11.4",
"publisher": "sswg",
"publisher": "swiftlang",
"icon": "icon.png",
"repository": {
"type": "git",
Expand All @@ -20,6 +20,7 @@
],
"keywords": [
"swift",
"swiftlang",
"sswg"
],
"activationEvents": [
Expand Down
4 changes: 2 additions & 2 deletions test/integration-tests/ExtensionActivation.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ suite("Extension Activation/Deactivation Tests", () => {

async function activate(currentTest?: Mocha.Test) {
assert.ok(await activateExtension(currentTest), "Extension did not return its API");
const ext = vscode.extensions.getExtension("sswg.swift-lang");
const ext = vscode.extensions.getExtension("swiftlang.vscode-swift");
assert.ok(ext, "Extension is not found");
assert.strictEqual(ext.isActive, true);
}
Expand All @@ -57,7 +57,7 @@ suite("Extension Activation/Deactivation Tests", () => {
test("Deactivation", async function () {
const workspaceContext = await activateExtension(this.test as Mocha.Test);
await deactivateExtension();
const ext = vscode.extensions.getExtension("sswg.swift-lang");
const ext = vscode.extensions.getExtension("swiftlang.vscode-swift");
assert(ext);
assert.equal(workspaceContext.subscriptions.length, 0);
});
Expand Down
4 changes: 2 additions & 2 deletions test/integration-tests/utilities/testutilities.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ const extensionBootstrapper = (() => {
`Extension is already activated. Last test that activated the extension: ${lastTestName}`
);
}
const extensionId = "sswg.swift-lang";
const extensionId = "swiftlang.vscode-swift";
const ext = vscode.extensions.getExtension<Api>(extensionId);
if (!ext) {
throw new Error(`Unable to find extension "${extensionId}"`);
Expand All @@ -138,7 +138,7 @@ const extensionBootstrapper = (() => {
let workspaceContext: WorkspaceContext | undefined;

// We can only _really_ call activate through
// `vscode.extensions.getExtension<Api>("sswg.swift-lang")` once.
// `vscode.extensions.getExtension<Api>("swiftlang.vscode-swift")` once.
// Subsequent activations must be done through the returned API object.
if (!activator) {
activatedAPI = await ext.activate();
Expand Down
Loading