Romp Documentation

Romp for Visual Studio

Romp Documentation Note - This documentation is incomplete.

As we continue working on Romp, the documentation will be updated.

Romp for Visual Studio is a plugin that makes it even easier to build Romp packages for your application components.

Just like the ProGet Visual Studio Plugin, this plugin adds an item to the project context menu. It’s a flyout menu named "Romp", with the following options:

Configure

This command will open the Configure Project for Romp dialog, and displays a UI for the options available in rompPackage.json. If the file exists, the options will be pre-populated with those values.

When you click the Configure button, the configuration window appears, and a .upack folder will be created if it doesn't exist, while also updating the rompPackage.json.

As you tab through the configuration window, you'll be able to see where the edits made in the visual editor translate to the text files on disk.

Metadata

Package

Variables

Credentials

Validate

This wraps the romp validate method, and outputs any errors in the build output window.

Package

This wraps the romp pack method, outputting the package to the package root folder.

Test

This runs the romp install method, but specifies an option, which means it does not add the package to the local registry.

Push

Similar to the ProGet Visual Studio Plugin.

Other Notes

Romp for Visual Studio uses a .upack/ folder, located at a project's root, that is laid out exactly like a regular romp package, exception without a package/ subfolder. Instead, MSBuild's output folder is used to create the contents at packing time.

The plugin uses an embedded version of Romp (the version is indicated in the notes), but you can configure it to point to another installation on your machine if desired.