rojo-rbx/rojo
1
0
Fork 1
mirror of https://github.com/rojo-rbx/rojo.git synced 2026-04-23 14:15:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve CLI help text

Browse Source
This commit is contained in:
Lucien Greathouse
2021-06-08 15:37:59 -04:00
parent 7f230a8bf4
commit 45e8208e9c
1 changed files with 3 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/cli/mod.rs
View File

@@ -103,23 +103,15 @@ pub struct ColorChoiceParseError {
#[derive(Debug, StructOpt)] #[derive(Debug, StructOpt)]
pub enum Subcommand { pub enum Subcommand {
Init(InitCommand), Init(InitCommand),
/// Serves the project's files for use with the Rojo Studio plugin.
Serve(ServeCommand), Serve(ServeCommand),
/// Generates a model or place file from the project.
Build(BuildCommand), Build(BuildCommand),
/// Generates a place or model file out of the project and uploads it to Roblox.
Upload(UploadCommand), Upload(UploadCommand),
FmtProject(FmtProjectCommand), FmtProject(FmtProjectCommand),
Doc(DocCommand), Doc(DocCommand),
Plugin(PluginCommand), Plugin(PluginCommand),
} }
/// Expose a Rojo project through a web server that can communicate with the /// Expose a Rojo project to the Rojo Studio plugin.
/// Rojo Roblox Studio plugin, or be visited by the user in the browser.
#[derive(Debug, StructOpt)] #[derive(Debug, StructOpt)]
pub struct ServeCommand { pub struct ServeCommand {
/// Path to the project to serve. Defaults to the current directory. /// Path to the project to serve. Defaults to the current directory.
@@ -142,7 +134,7 @@ impl ServeCommand {
} }
} }
/// Build a Rojo project into a file. /// Generates a model or place file from the Rojo project.
#[derive(Debug, StructOpt)] #[derive(Debug, StructOpt)]
pub struct BuildCommand { pub struct BuildCommand {
/// Path to the project to serve. Defaults to the current directory. /// Path to the project to serve. Defaults to the current directory.
@@ -164,7 +156,7 @@ impl BuildCommand {
} }
} }
/// Build and upload a Rojo project to Roblox.com. /// Builds the project and uploads it to Roblox.
#[derive(Debug, StructOpt)] #[derive(Debug, StructOpt)]
pub struct UploadCommand { pub struct UploadCommand {
/// Path to the project to upload. Defaults to the current directory. /// Path to the project to upload. Defaults to the current directory.