Skip to content

Commit

Permalink
Updated marketplace overview
Browse files Browse the repository at this point in the history
  • Loading branch information
Irame committed May 9, 2023
1 parent 0fb9ae2 commit 4c805a4
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 9 deletions.
33 changes: 24 additions & 9 deletions MarketplaceOverview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ For VS 2017 go to [Smart Command Line Arguments VS2017](https://marketplace.visu

For VS 2015 the last supported version is [v2.3.2](https://github.com/MBulli/SmartCommandlineArgs/releases/download/v2.3.2/SmartCmdArgs-v2.3.2.vsix)

A Visual Studio Extension which aims to provide a better UI to manage your command line arguments.
A Visual Studio Extension which aims to provide a better UI to manage your command line arguments and environment variables.

![Main Window](https://raw.githubusercontent.com/MBulli/SmartCommandlineArgs/master/Doc/Images/MainWindow.png "Command Line Arguments window, showning all projects")
![Main Window](vsix_preview_image.png "Command Line Arguments window, showning all projects")

Visual Studio 2017, 2019 and 2022 and the following project types are supported:

Expand All @@ -33,14 +33,26 @@ View → Other Windows → Commandline Arguments

If the window is open or minimized the commandline arguments should not be edited via the project properties.
Changes which are made in the window are applied to all project configurations (Release/Debug etc.) of the current startup project.

### Interface (Toolwindow Buttons)
- **Add**: Add new line (Command Line Argument or Environment Variable)
- **Remove**: Remove selected lines
- **Add group**: Add new group
- **Up/Down**: Move selected lines
- **Copy Cmd**: Copy command line to clipboard. (Command Line Arguments or Environment Variables for Powershell or the Command Prompt)
- **Show all projects**: Toggle to also display non-startup projects
- **Settings**: Open the [Settings](#user-content-settings) dialog

### Settings
If the checkboxes are filled with a square the default value is used.
The default value for these settings can be configured under `Tools → Options → Smart Commandline Arguments → Settings Defaults`.

- **Save Settings to JSON**: If true then the these settings are stored in a JSON file next to the solution file.
- **Enable version control support**: If enabled the extension will store the command line arguments into an json file at the same loctation as the related project file. That way the command line arguments might be version controlled by a VCS. If disabled the extension will store everything inside the solutions `.suo-file` which is usally ignored by version control. The default value for this setting is True.
- **Manage Command Line Arguments**: If enabled the arguments are set automatically when a project is started/debugged.
- **Manage Environment Variables**: If enabled the environment variables are set automatically when a project is started/debugged.
- **Enable version control support**: If enabled the extension will store the command line arguments into an json file at the same loctation as the related project file. That way the command line arguments might be version controlled by a VCS. If disabled the extension will store everything inside the solutions `.suo-file` which is usally ignored by version control.
- **Use Solution Directory**: If enabled all arguments of every project will be stored in a single file next to the *.sln file. (Only if version control support is enabled)
- **Use Custom JSON Path**: If enabled the *.args.json file is saved at a custom location. Relative paths are based on the solution directory. (Only if 'Use Solution Directory' is enabled)
- **Enable Macro evaluation**: If enabled Macros like '$(ProjectDir)' will be evaluated and replaced by the corresponding string.

### Hotkeys
Expand All @@ -61,18 +73,21 @@ There are also three different types of data which can be pasted:

### Context Menu

![Context Menu](https://raw.githubusercontent.com/MBulli/SmartCommandlineArgs/master/Doc/Images/ContextMenuGroup.png "Context Menu with a single group selected")
![Group Context Menu](https://raw.githubusercontent.com/MBulli/SmartCommandlineArgs/master/Doc/Images/ContextMenuGroup.png "Context Menu with a single group selected")
![Item Context Menu](https://raw.githubusercontent.com/MBulli/SmartCommandlineArgs/master/Doc/Images/ContextMenuItem.png "Context Menu with a single item selected")

- **Cut** / **Copy** / **Delete**: Cuts/Copies/Deletes the selected items.
- **Paste**: Pastes the previously copied/cut items, text, or files
- **Space Delimiter** (only available while ONE group or project is selected): If this is checked then each argument in the group is seperated by a space when passed to the application.
- **Exclusive Mode** (only available while ONE group or project is selected): If this is checked then the group switches to a radio button mode where only one argument can be checked at any given time.
- **Paste**: Pastes the previously copied/cut items, text, or files (see [Paste](#user-content-paste)).
- **CLA Delimiter** (only available while ONE group or project is selected): Options to set the string that each argument in the group is separated by. It can be set to a single space which is the default, none or something custom. If custom is selected you can also set a pre- and postfix that is prepend/append if the group is not empty.
- **Exclusive Mode** (only available while ONE group or project is selected): If this is checked then the group switches to a radio button mode where only one item can be checked at any given time.
- **New Group from Selection**: Creates a new Group and moves the selected items into it.
- **Reset to default checked**: Resets every selected arguemnt to the checked state given by the _Default Dhecked_ option.
- **Default Checked**: If this is checked then the argument sould be chekd by default e.g. if someone opens up the project for the first time.
- **Split Argument** (only available while ONE argument is selected): Splits the argument with the typical cmd line parsing rules (e.g. `-o "C:\Test Folder\Output.png"` is split into two arguments `-o` and `"C:\Test Folder\Output.png"`).
- **Open/Reveal File/Folder** (only available while ONE item with a valid path is selected): If there is a file of folder name in the item then it can be opend or revealed with this option. (Base path for relative paths can be configured to project- or target path in the options)
- **Project Configuration** / **Launch Profile** / **Project Platform** (only available while ONE group is selected): Shows a sub menu to select a Project Configuration/Launch Profile/Project Platform. If this is set for a group, it is only evaluated if the right Project Configuration/Launch Profile/Project Platform is active.
- **Item Type** (only available while ONE item is selected): Switch the type of the item from command line argument to environment variable or back.
- **Set as single Startup Project** (only available while ONE project is selected): Sets the selected project as the startup project.
- **Reset to default checked**: Resets every selected arguemnt to the checked state given by the _Default Dhecked_ option.
- **Default Checked**: If this is checked then the argument sould be chekd by default e.g. if someone opens up the project for the first time.


### Donation
Expand Down
Binary file modified SmartCmdArgs/SharedResources/Resources/vsix_preview_image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4c805a4

Please sign in to comment.