From d1ac57f5448dc53c127f7e1bff67d8c9e92ab6a0 Mon Sep 17 00:00:00 2001 From: Dervex Date: Sun, 5 May 2024 00:03:23 +0200 Subject: [PATCH] Update CLI and VS Code commands, update global configuration --- docs/commands/cli.mdx | 7 +++++++ docs/commands/vscode.mdx | 4 ++++ docs/customization.mdx | 14 ++++++++------ 3 files changed, 19 insertions(+), 6 deletions(-) diff --git a/docs/commands/cli.mdx b/docs/commands/cli.mdx index 1bcf891..efb887c 100644 --- a/docs/commands/cli.mdx +++ b/docs/commands/cli.mdx @@ -176,6 +176,13 @@ Forcefully check for updates and update Argon CLI and plugin if available. argon update ``` +Options: + +| Short | Long | Description | +| ----- | ---------- | ------------------------------------------- | +| `-c` | `--cli` | Update the Argon CLI only (if available) | +| `-p` | `--plugin` | Update the Argon plugin only (if available) | + ## Plugin Install or uninstall Argon Roblox Studio plugin locally diff --git a/docs/commands/vscode.mdx b/docs/commands/vscode.mdx index 6ba12fd..983673b 100644 --- a/docs/commands/vscode.mdx +++ b/docs/commands/vscode.mdx @@ -101,6 +101,10 @@ Launch a new instance of Roblox Studio or open place file directly from the comm Install or uninstall Argon Roblox Studio plugin locally +## Update + +Forcefully check for updates and update Argon CLI and plugin if available. + ## Settings Open Argon only settings in the Visual Studio Code user or workspace settings. diff --git a/docs/customization.mdx b/docs/customization.mdx index 7451cc4..ca9f46f 100644 --- a/docs/customization.mdx +++ b/docs/customization.mdx @@ -11,7 +11,7 @@ Argon command line interface is customizable through two main ways. ### Command Options -When running the `argon` command, you can add options to customize the behavior of the command. Here are some examples: +When running `argon`, you can add options to customize the behavior of the [Commands](./commands/cli.mdx). Here are some examples: - `--docs` or `-d` - Include documentation in the project - `--template` or `-T` - Select the project template @@ -31,19 +31,21 @@ And can have the following settings: | port | `8000` | Default server port when live syncing | | template | `place` | Default project [Template](./getting-started/new-project.mdx#project-templates) to use when creating a new project with `argon init`. Argon comes with five templates: **place**, **plugin**, **package**, **model** and **quick**. But you can add your own! Just create a new folder with the desired name and contents in `.argon/templates/` | | license | `Apache-2.0` | Default project license [SPDX identifier](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository#searching-github-by-license-type) to use when creating a new project with `argon init`. Argon will pull license template from GitHub so if there is no internet connection, placeholder will be used instead | +| include_docs | `true` | Controls whether documentation files should be included in the project (**README**, **LICENSE**, **CHANGELOG**) when running `argon init` and present in the project **template** | +| use_git | `true` | Toggles the use of [Git](https://git-scm.com/) for source control. If enabled Argon will initialize a new repository and add `.gitignore` file when running `argon init` and present in the project **template** | +| use_wally | `false` | Whether to use use [Wally](https://wally.run/) for project package management. When enabled Argon will install dependencies automatically and add `wally.toml` file when running `argon init` and present in the project **template** | | run_async | `false` | Whether to run Argon "asynchronously" every time you use `argon serve` or `argon build` / `argon sourcemap` with `--watch` enabled. This will free up the terminal. To stop running Argon sessions use `argon stop` command | | scan_ports | `true` | When enabled Argon will scan for the first available port if selected one is already in use | +| detect_project | `true` | Whether Argon should intelligently detect the project type. This allows to run [roblox-ts](https://roblox-ts.com/) or to install [Wally](https://wally.run/) packages automatically | +| with_sourcemap | `false` | Whether Argon should generate sourcemap by default when running [Serve](./commands/cli.mdx#serve) or [Build](./commands/cli.mdx#build) command. Useful for [Luau LSP](https://github.com/JohnnyMorganz/luau-lsp) users | +| build_xml | `false` | If no path is provided, [Build](./commands/cli.mdx#build) command will always use the Roblox XML format instead of binary | | check_updates | `true` | Whether to check for new Argon releases on CLI startup (limited to once per hour). This setting also updates Argon plugin if `install_plugin` setting is enabled | | auto_update | `false` | When enabled Argon will automatically install Argon updates if available. Otherwise you will be prompted for confirmation. This setting also works with `install_plugin` | | install_plugin | `true` | Whether to install Roblox plugin locally by default and keep it updated when above settings are enabled | -| share_stats | `true` | Toggles sharing of anonymous Argon usage statistics which are displayed on the [argon.wiki](https://argon.wiki/) home page to show the size of the Argon community | -| auto_detect | `true` | Whether Argon should intelligently detect the project type. This allows to run [roblox-ts](https://roblox-ts.com/) or to install [Wally](https://wally.run/) packages automatically | -| use_git | `true` | Toggles the use of [Git](https://git-scm.com/) for source control. If enabled Argon will initialize a new repository and add `.gitignore` file when running `argon init` and present in the project **template** | -| use_wally | `false` | Whether to use use [Wally](https://wally.run/) for project package management. When enabled Argon will install dependencies automatically and add `wally.toml` file when running `argon init` and present in the project **template** | -| include_docs | `true` | Controls whether documentation files should be included in the project (**README**, **LICENSE**, **CHANGELOG**) when running `argon init` and present in the project **template** | | rojo_mode | `false` | When enabled Argon will use [Rojo](https://rojo.space/) namespace by default when creating a new project | | ts_mode | `false` | Whether to use [roblox-ts](https://roblox-ts.com/) by default when creating, serving or building any project | | move_to_bin | `false` | Controls whether to move files to the system bin instead of permanently deleting them (only applies when syncing changes from Roblox Studio to the file system) | +| share_stats | `true` | Toggles sharing of anonymous Argon usage statistics which are displayed on the [argon.wiki](https://argon.wiki/) home page to show the size of the Argon community | ## Argon Plugin