/vscode-plasticscm

Enable Plastic SCM interoperability in your favourite code editor!

Primary LanguageTypeScriptMIT LicenseMIT

Plastic SCM

Plastic SCM integration with VS Code's SCM features

Intro

plastic-scm is a Visual Studio Code extension that integrates Plastic SCM. With this plugin, you can use Plastic SCM as your SCM tool. It is powered by Codice Software.

This plugin contains a subset of Plastic SCM commands and features. We will extend it in the future, and we hope it will be useful and convenient to use.

Requirements

  • Visual Studio Code v1.64
  • Plastic SCM

Features

  1. Lists your pending changes
  2. Allows you to checkin all your pending changes at once
  3. Allow to see inline file changes as well as full-file changes compared to the latest changeset
  4. Group changes to assets from Unreal Engine 5 One File Per Actor (OFPA) in the "Dirty Unreal Levels" resource group, coalesced under the name(s) of the corresponding map(s)

Install

  1. Install Visual Studio Code (1.64 or higher)
  2. Launch Code
  3. Open the command palette : Ctrl ⇧ P (Windows, Linux), ⌘ ⇧ P (macOS)
  4. Select Install Extensions
  5. Choose the extension Plastic SCM
  6. Reload Visual Studio Code

Configure

Name Type Description
plastic-scm.autorefresh boolean Whether the extension should automatically look for changes in the workspace
plastic-scm.enabled boolean Whether the extension is enabled
plastic-scm.cmConfiguration.cmPath string Location of the cm CLI executable
plastic-scm.cmConfiguration.millisToStop number Grace time to wait before requesting a shell to closeshell to start
plastic-scm.cmConfiguration.millisToWaitUntilUp number Time to wait for the shell to start
plastic-scm.decorations.enabled boolean Whether or not file decorations are enabled
plastic-scm.consolidateUnrealOneFilePerActorChanges boolean Whether all changes under Unreal Engine 5 One File Per Actor (OFPA) should be groupped under "Dirty Unreal Levels"

Commands

We're working to add more! 👷‍♀️👨‍🏭

Have a look at the list of issues on Github.

Checkin

You can type in the input field in the SCM view and hit Ctrl+Enter to checkin all your pending changes. We don't support selecting what items you want to check in at the moment.

You can also invoke the Checkin command using the Command Palette. You'll be prompted to enter a commit message in that case.

File Changes

When editing a tracked text file, you'll see VS Code show inline gutter color indicators to show lines added, changed, or removed, similar to using Git or other source control extensions. You can also open the Source Control panel to and click on any modified text file to open a full-file diff from the latest changeset.

Contribute

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request

Credits

License

MIT