MAKS-IT/maksit-openfolderrecurs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
master
maksit-openfolderrecurs/README.md

5.4 KiB
Raw Permalink Blame History

local npx --package yo --package generator-code -- yo code

global npm install --global yo generator-code

yo code

? What type of extension do you want to create? New Extension (TypeScript)

? What's the name of your extension? HelloWorld

Press to choose default for all options below

? What's the identifier of your extension? helloworld

? What's the description of your extension? LEAVE BLANK

? Initialize a git repository? Yes

? Bundle the source code with webpack? No

? Which package manager to use? npm

? Do you want to open the new folder with Visual Studio Code? Open with code

If you'd like to publish your Visual Studio Code (VSCode) extension so everyone can access it, you can publish it to the Visual Studio Code Marketplace. Here's how:

1. Prepare Your Extension

Ensure your extension meets these requirements:

  • Manifest (package.json):
    • Make sure the name, displayName, description, and version fields are filled out.
    • Specify the correct publisher field (this should match your Visual Studio Marketplace publisher name).
  • README.md:
    • Include a detailed explanation of what your extension does.
  • LICENSE:
    • Add a license file to your project. Common options include MIT, Apache 2.0, etc.
  • Icon:
    • Add an icon field in your package.json to point to a 128x128 PNG file for the Marketplace.

2. Set Up a Publisher Account

  1. Go to the Visual Studio Code Marketplace.
  2. Sign in with your Microsoft account.
  3. Create a publisher account:
    • Go to the Manage Publishers page.
    • Click + New Publisher.
    • Enter the publisher name and description.
    • Verify your publisher account.

3. Install the vsce Tool

The vsce (Visual Studio Code Extension Manager) CLI is required for publishing:

npm install -g vsce

4. Login to Your Publisher

To authenticate with the Marketplace, use the Azure DevOps Personal Access Token (PAT):

  1. Go to Azure DevOps PAT.
  2. Create a new PAT with All accessible organizations and Marketplace (Publish) scopes.
  3. Save the generated token.

Login to vsce:

vsce login <your-publisher-name>

Paste the PAT token when prompted.

5. Package Your Extension

Run the following command in your extension's root directory:

vsce package

This will generate a .vsix file.

6. Publish the Extension

Run the following command to publish your extension:

vsce publish
  • This will publish the extension to the Visual Studio Code Marketplace under your publisher account.
  • If you are updating an existing extension, increment the version field in package.json before publishing.

7. Verify on the Marketplace

After publishing, go to the Marketplace and check your publisher page to confirm the extension is listed.

8. Promote Your Extension

  • Share the link to your extension's Marketplace page.
  • Use social media, forums, and blogs to reach a wider audience.
  • Gather feedback to improve future versions.

Let me know if you face any issues or need clarification!

maksit-openfolderrecurs README

This is the README for your extension "maksit-openfolderrecurs". After writing up a brief description, we recommend including the following sections.

Features

Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.

For example if there is an image subfolder under your extension project workspace:

![feature X]images/feature-x.png

Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.

Requirements

If you have any requirements or dependencies, add a section describing those and how to install and configure them.

Extension Settings

Include if your extension adds any VS Code settings through the contributes.configuration extension point.

For example:

This extension contributes the following settings:

  • myExtension.enable: Enable/disable this extension.
  • myExtension.thing: Set to blah to do something.

Known Issues

Calling out known issues can help limit users opening duplicate issues against your extension.

Release Notes

Users appreciate release notes as you update your extension.

1.0.0

Initial release of ...

1.0.1

Fixed issue #.

1.1.0

Added features X, Y, and Z.

Following extension guidelines

Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.

Working with Markdown

You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

  • Split the editor (Cmd+\ on macOS or Ctrl+\ on Windows and Linux).
  • Toggle preview (Shift+Cmd+V on macOS or Shift+Ctrl+V on Windows and Linux).
  • Press Ctrl+Space (Windows, Linux, macOS) to see a list of Markdown snippets.

For more information

Enjoy!