Cloudinary VS Code Extension

Overview

The Cloudinary VS Code extension provides developers with integrated tooling for working with Cloudinary assets directly within their development environment. This page covers the extension's purpose, development workflow, and publishing process.

Key Features

• Asset browsing and management
• Quick upload functionality
• Transformation preview
• Code snippet generation
• Integration with Cloudinary accounts

Development

See the repository documentation for Cloudinary VS Code Extension for full details on development and contributing to the extension.

Publishing

This section covers the process of releasing new versions of the extension.

Version Management

Follow semantic versioning (semver):

• Major: Breaking changes
• Minor: New features, backward compatible
• Patch: Bug fixes, backward compatible

Update the version:

1. Update version in package.json
2. Update CHANGELOG.md with release notes
3. Commit changes with a descriptive message

Pre-Publishing Checklist

Before publishing a new version:

• [ ] All tests pass
• [ ] Linting passes with no errors
• [ ] CHANGELOG.md is updated
• [ ] Version number is updated
• [ ] Packaged Extension installed and works
• [ ] README.md is current

Publishing to VS Code Marketplace

1. Install vsce (VS Code Extension manager)

2. Login with your publisher credentials

3. Package the extension

This creates a .vsix file.

4. Publish the extension

Publish the extension to both the VS Code Marketplace and the Open VSX Registry.

VS Code Marketplace

1. Go to the Visual Studio Marketplace publisher management page
2. Select your publisher from the left pane
3. Hover over the extension you want to update, click the ... menu, and select Edit
4. Click the pencil icon next to the VSIX filename to upload a new version
5. Select your updated .vsix file and click Open
6. Review the extension details (version auto-populates from package.json)
7. Click Save & Upload

For detailed instructions, see Publishing Extensions.

Open VSX Registry

Publish using the ovsx CLI tool with your access token:

For example:

After publishing, the extension appears in a "Deactivated" state while processing. Once complete (usually 5-10 seconds), it becomes active and visible on the registry.

For detailed instructions, see Publishing Extensions to Open VSX.

Manual Installation (for testing)

To install a packaged extension locally:

1. Run vsce package to create the .vsix file
2. In your IDE, open the Extensions view
3. Click the ... menu and select "Install from VSIX..."
4. Select the generated .vsix file

Resources

• VS Code Extension API
• Publishing to VS Code Marketplace
• Publishing to Open VSX
• Extension Guidelines