Amplication for Visual Studio Code

Easily create Amplication plugins from provided Amplication templates.

Features | Support and Community | Contributing | License

Installation

Install the Amplication VS Code Extension by clicking Install on the banner above, or open the Extensions view in VS Code, search for Amplication to filter results and select Amplication extension.

Features

The Amplication extension is here to help you bootstrap your Amplication plugin development. To do so, it adds a few actions to the VS Code Command Palette.

Download Templates

This command allows you to choose an Amplication template to download to your local environment. Currently you can choose between a blueprint template, Node.js template or .Net template. You can choose a name for the scaffolding and it will be stored in a /plugins directory locally.

Install Dependencies

This command will install the plugin's dependencies, specified in the package.json file within the plugin's directory.

Build

This command will build the plugin's code and assets, allowing you to publish it.

Build And Push

This command will build the plugin's code and assets, then it will commit and push the code to you pre-configured git repository.

Publish Version

This command will bump the plugin's version using Semantic Versioning Specification (SemVer) in package.json and will tag a git version as well.

Support and Community

Support documentation can be found on the Amplication Documentation.

Issue Reporting and Feature Requests

Bug Report: If you see an error message or encounter an issue while using Amplication, please create a bug report.
Feature Request: If you have an idea or if there is a capability that is missing and would make development easier and more robust, please submit a feature request.
Documentation Request: If you're reading the Amplication docs and feel like you're missing something, please submit a documentation request.

Contributing

The majority of Amplication code is open-source. We are committed to a transparent development process and highly appreciate any contributions. Whether you are helping us fix bugs, proposing new features, improving our documentation or spreading the word - we would love to have you as a part of the Amplication community. Please refer to our contribution guidelines and code of conduct.

License

Apache License 2.0

Development

Building and Publishing the Extension

This extension uses a streamlined process for building, versioning, and publishing to the VS Code Marketplace.

Prerequisites

Ensure you have the necessary permissions to publish to the VS Code Marketplace
Make sure you're logged in with vsce (run npx vsce login Amplication if needed)

Available Scripts

The following npm scripts are available for development and publishing:

npm run compile - Compiles the TypeScript code
npm run package - Creates a .vsix package file for manual installation
npm run publish - Publishes the extension to the VS Code Marketplace
npm run release - Interactive script that handles version bumping and publishing

Release Process

To release a new version of the extension:

Make sure all your changes are committed to git
Run npm run release
Follow the prompts to:
- Commit any pending changes (if needed)
- Select the version increment type (patch, minor, or major)
- The script will automatically:
  - Bump the version in package.json
  - Create a git tag for the new version
  - Build the extension
  - Package it as a .vsix file
  - Publish to the VS Code Marketplace

Manual Release

If you prefer to handle the process manually:

Ensure your git working directory is clean
Run npm version patch|minor|major to bump the version
Run npm run compile to build the extension
Run npm run package to create the .vsix file
Run npm run publish to publish to the marketplace

Troubleshooting

If you encounter a "Git working directory not clean" error, commit or stash your changes before running the release script
If you have authentication issues, run npx vsce login Amplication to refresh your credentials