README.md

VSCode Configurator-rs

This is a CLI tool to quickly bootstrap a new project for VSCode. More specifically, it's to reduce the amount of common tasks I perform.

Note

This is mainly just a tool I'm writing for myself.

😵‍💫 Getting a little deja vu?

That's because this is actually a "rewrite" of the original VSCode Configurator project that I wrote in C#, but this time in Rust. I've been wanting to learn how to write Rust for a while and I needed a bit of a starting point to get me acclimated with the language. So why not translate a CLI tool I've written before into Rust?

📄 Docs

You can view the docs for installing and using the CLI here:

• Docs

📦 Installation

You can read the following documentation for installing the CLI tool:

• Installing vscode-configurator

🏗️ Building from source

🧰 Pre-requisites

• Rust
  • The nightly toolchain is preferred, but stable should work as well.
  • Make sure to have the toolchains for the target platforms you want to build for.

🧱 Building

Command-line

1. Navigate to the project directory in your terminal.
2. Run the following command to build the project:

cargo build --package vscodeconfigurator --release --target <TARGET>

Replace <TARGET> with the desired target platform.

Command-line (PowerShell)

If you have PowerShell 7 (or higher) installed on Linux, macOS, or Windows, you can do the following:

1. Navigate to the project directory in your terminal.
2. Run the following command to build the project:

./tools/Compile-VSCodeConfigurator.ps1 -Platform <PLATFORM> -Architechture <ARCHITECTURE>

Make sure to replace the following:

• <PLATFORM> with the desired platform (e.g. Windows, Linux, or macOS).
• <ARCHITECTURE> with the desired architecture (e.g. x64 or arm64).

🗂️ Dependencies used

• clap
• clap_complete
• crossterm
• serde_json

Build dependencies

• git-version
• toml_edit

🤝 License

The source code for this project is licensed with the MIT License.