Add vcs option to cli reference and roadmap
This commit is contained in:
parent
e908e4d564
commit
dbaa63a575
|
@ -45,12 +45,26 @@ export default defineConfig({
|
|||
autogenerate: {
|
||||
directory: 'guides',
|
||||
},
|
||||
translations: {
|
||||
de: 'Anleitungen',
|
||||
}
|
||||
},
|
||||
{
|
||||
label: 'Roadmap',
|
||||
link: '/roadmap',
|
||||
translations: {
|
||||
de: 'Zukunftspläne',
|
||||
},
|
||||
},
|
||||
{
|
||||
label: 'Reference',
|
||||
autogenerate: {
|
||||
directory: 'reference',
|
||||
},
|
||||
collapsed: true,
|
||||
translations: {
|
||||
de: 'Referenz',
|
||||
},
|
||||
badge: {
|
||||
text: 'WIP',
|
||||
variant: 'caution',
|
||||
|
|
|
@ -21,6 +21,7 @@ Optionen:
|
|||
- `--name`: Der Name des Projekts. Standardmäßig der Name des Verzeichnisses.
|
||||
- `--description`: Die Beschreibung des Projekts.
|
||||
- `--pack-format`: Das Format des Packs. Standardmäßig `26`.
|
||||
- `--vcs`: Das gewünschte Versionskontrollsystem. Standardmäßig `git`.
|
||||
|
||||
## build
|
||||
Baut das Projekt im angegebenen Pfad in das `dist`-Verzeichnis.
|
||||
|
|
|
@ -58,6 +58,8 @@ The project structure should look like this:
|
|||
## Writing your first script
|
||||
After opening the file `src/main.shu` in your favorite text editor, you should see the following content:
|
||||
```shulkerscript title="src/main.shu"
|
||||
namespace "your-name";
|
||||
|
||||
#[tick]
|
||||
fn main() {
|
||||
/say Hello, world!
|
||||
|
|
|
@ -21,6 +21,7 @@ Options:
|
|||
- `--name`: The name of the project. Defaults to the name of the directory.
|
||||
- `--description`: The description of the project.
|
||||
- `--pack-format`: The format of the pack. Defaults to `26`.
|
||||
- `--vcs`: The version control system to use. Defaults to `git`.
|
||||
|
||||
## build
|
||||
Build the project at the specified path to the `dist` folder.
|
||||
|
|
|
@ -0,0 +1,32 @@
|
|||
---
|
||||
title: Roadmap
|
||||
description: Our Plans for the future of ShulkerScript.
|
||||
hero:
|
||||
tagline: Our Plans for the future of ShulkerScript.
|
||||
image:
|
||||
file: ../../assets/logo.webp
|
||||
actions:
|
||||
- text: Contribute yourself
|
||||
link: https://github.com/moritz-hoelting/shulkerscript-cli
|
||||
icon: external
|
||||
variant: primary
|
||||
---
|
||||
import { Steps } from '@astrojs/starlight/components';
|
||||
|
||||
<Steps>
|
||||
1. **Multi-File Support**\
|
||||
Allow users to split their code into multiple files and import them into each other.
|
||||
This will work something like this:
|
||||
```shulkerscript
|
||||
use "path/to/file.shu";
|
||||
```
|
||||
And will import all the public (`pub`) functions and variables from the file.
|
||||
2. **Better Error Reports**\
|
||||
Improve the error reports to be more helpful and easier to understand.
|
||||
3. **Package CLI-command**\
|
||||
Add a command to the CLI to package the code into a zip file that can easily be distributed.
|
||||
4. **Variables & Constants**\
|
||||
Add support for variables and constants. Constants can be any type (string, number, etc.) and
|
||||
can be passed from function to function. They will be processed by the compiler. Variables will be
|
||||
mutable and can be changed at any time, and are stored as entries in minecraft scoreboards.
|
||||
</Steps>
|
Loading…
Reference in New Issue