https://github.com/smalls1652/vscodeconfigurator-rs
My VSCode Configurator CLI tool, but written in Rust!
https://github.com/smalls1652/vscodeconfigurator-rs
rust vscode
Last synced: 3 months ago
JSON representation
My VSCode Configurator CLI tool, but written in Rust!
- Host: GitHub
- URL: https://github.com/smalls1652/vscodeconfigurator-rs
- Owner: Smalls1652
- License: mit
- Created: 2024-09-24T23:05:57.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-02T07:39:06.000Z (7 months ago)
- Last Synced: 2025-04-04T13:12:50.248Z (7 months ago)
- Topics: rust, vscode
- Language: Rust
- Homepage:
- Size: 231 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# VSCode Configurator-rs [](https://github.com/Smalls1652/vscodeconfigurator-rs/actions/workflows/build.yml) [](./LICENSE)
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](https://github.com/Smalls1652/SmallsOnline.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](./docs/README.md)
## 📦 Installation
You can read the following documentation for installing the CLI tool:
- [Installing vscode-configurator](./docs/cli/Installing%20vscode-configurator.md)
## 🏗️ Building from source
### 🧰 Pre-requisites
- [Rust](https://www.rust-lang.org/tools/install)
- The `nightly` toolchain is preferred, but `stable` should work as well.
- Make sure to have the toolchains for the [target platforms](https://doc.rust-lang.org/nightly/rustc/platform-support.html) 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:
```bash
cargo build --package vscodeconfigurator --release --target
```
Replace `` with the desired [target platform](https://doc.rust-lang.org/nightly/rustc/platform-support.html).
#### 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:
```powershell
./tools/Compile-VSCodeConfigurator.ps1 -Platform -Architechture
```
Make sure to replace the following:
- `` with the desired platform (e.g. `Windows`, `Linux`, or `macOS`).
- `` with the desired architecture (e.g. `x64` or `arm64`).
## 🗂️ Dependencies used
- [`clap`](https://crates.io/crates/clap)
- [`clap_complete`](https://crates.io/crates/clap_complete)
- [`crossterm`](https://crates.io/crates/crossterm)
- [`serde_json`](https://crates.io/crates/serde_json)
### Build dependencies
- [`git-version`](https://crates.io/crates/git-version)
- [`toml_edit`](https://crates.io/crates/toml_edit)
## 🤝 License
The source code for this project is licensed with the [MIT License](LICENSE).