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

Update built-ins for Open VSX publish #20

Merged
merged 1 commit into from
Mar 20, 2020
Merged

Conversation

marcdumais-work
Copy link
Contributor

@marcdumais-work marcdumais-work commented Mar 17, 2020

The built-ins package.json are missing many fields that are
desirable to have so that the extension's page on Open VSX
will be populated correctly.

Fixes #19

How to test:

  1. build this repo and obtain the .vsix from the dist folder
  2. open Open VSX in Gitpod
  3. create a builtins folder at the root
  4. use a file manager for your OS and drag-and-drop the generated builtins to the GitPod file navigator, over the builtins folder
  5. use the openvsx client to create the vscode namespace:
    $> cli/lib/ovsx create-namespace vscode -r http://localhost:8080 -p super_token
  6. use the openvsx client to publish a built-in extension to the (test) registry. e.g.:
    $> cli/lib/ovsx publish -r http://localhost:8080 -p super_token builtins/grunt-1.40.0-prel.vsix
  7. Open the web page for the registry (the one on port 3000) and search for the extension you published. Look at the first page and detailed page for the extension.

@marcdumais-work marcdumais-work force-pushed the update-for-openvsx branch 2 times, most recently from b473a6d to f26427b Compare March 17, 2020 22:59
@marcdumais-work
Copy link
Contributor Author

Already starting to be better:

image

image

Note: Grunt and Git are among the rare built-ins that provide an icon

@akosyakov
Copy link
Member

akosyakov commented Mar 18, 2020

I am fine with it, but we should also make sure that it looks good in the registry by default to. We won't be able to fix all VS Code extensions in such way.

@marcdumais-work marcdumais-work changed the title [WIP] Update built-ins for Open VSX publish Update built-ins for Open VSX publish Mar 19, 2020
@marcdumais-work
Copy link
Contributor Author

I have refined a bit:

  • take displayName and description from package.nls.json if available there, else fall-back to a sane default for these important fields.
  • let Open VSX provide a default icon if missing (most are)
  • add a basic README, overriding existing one if present (rare)

@marcdumais-work
Copy link
Contributor Author

What it looks like now using Open VSX master on Gitpod:

image

image

@marcdumais-work
Copy link
Contributor Author

@akosyakov are you fine with merging this PR? Here is the plan after:

Any objections?

cc: @spoenemann

The built-ins package.json are missing many fields that are
desirable to have so that the extension's page on Open VSX
will be populated correctly.

Fixes #19

Signed-off-by: Marc Dumais <[email protected]>
@spoenemann
Copy link

What is Code OSS? VSCodium?

@marcdumais-work
Copy link
Contributor Author

What is Code OSS? VSCodium?

That's what Microsoft apparently calls what one can build from the vscode GH repo:

https://github.com/microsoft/vscode/wiki/Differences-between-the-repository-and-Visual-Studio-Code#the-code---oss-repository

@marcdumais-work
Copy link
Contributor Author

i.e. VS Code without the proprietary components and configs

@spoenemann
Copy link

Ok, so VSCodium is an example of Code OSS.

👍 ok to merge from my side.

@marcdumais-work
Copy link
Contributor Author

Ok, so VSCodium is an example of Code OSS.

Yes, or we could say a derivative of it. BTW, they took the decision to still include the MS Marketplace config as part of VSCodium, but I read somewhere they'll be willing to switch when something open is created. So I think they will be a good candidate to use Open VSX once it's compatible with Code OSS-based editors.

@marcdumais-work
Copy link
Contributor Author

@akosyakov are you fine with merging this PR? Here is the plan after:

Any objections?

cc: @spoenemann

Merging, based on #20 (comment) and #20 (comment)

@marcdumais-work marcdumais-work merged commit e29788a into master Mar 20, 2020
@marcdumais-work marcdumais-work deleted the update-for-openvsx branch March 20, 2020 18:38
@marcdumais-work
Copy link
Contributor Author

Ok all done.

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.

Add info required for registry's extension page
3 participants