Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
FlorianRappl committed Jun 10, 2023
1 parent 250ab77 commit ec35b1d
Show file tree
Hide file tree
Showing 33 changed files with 585 additions and 2,176 deletions.
88 changes: 88 additions & 0 deletions docs/commands/add-piral-instance-pilet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
# `pilet add-piral-instance`

Adds another Piral instance to the available apps hosting the current pilet.

## Syntax

From the command line:

```sh
pilet add-piral-instance <app> [source]
```

Alternative:

```sh
pb add-piral-instance-pilet <app> [source]
```

## Aliases

Instead of `add-piral-instance-pilet` you can also use:

- `add-shell-pilet`
- `install-shell-pilet`
- `add-app-pilet`
- `with-app-pilet`

## Positionals

### `app`

Sets the name of the Piral instance to be added.


- Type: `string`
- Default: `undefined`

### `source`

Sets the source pilet path where the Piral instance should be added.


- Type: `string`
- Default: `.`

## Flags

### `--log-level`

Sets the log level to use (1-5).


- Type: `number`
- Default: `3`

### `--npm-client`

Sets the npm client to be used for adding the Piral instance.


- Type: `string`
- Choices: `"npm"`, `"pnpm"`, `"pnp"`, `"yarn"`, `"lerna"`, `"rush"`
- Default: `undefined`

### `--selected`

Defines if the provided Piral instance should be selected initially.


- Type: `boolean`
- Default: `false`

### `--no-selected`

Opposite of:
Defines if the provided Piral instance should be selected initially.


- Type: `boolean`
- Default: `true`

### `--base`

Sets the base directory. By default the current directory is used.


- Type: `string`
- Default: `process.cwd()`
21 changes: 19 additions & 2 deletions docs/commands/build-pilet.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Instead of `build-pilet` you can also use:

### `source`

Sets the source index.tsx file for collecting all the information.
Sets the source pilet path for collecting all the information.


- Type: `string`
Expand Down Expand Up @@ -85,6 +85,23 @@ Creates source maps for the bundles.
- Type: `boolean`
- Default: `false`

### `--watch`

Continuously re-builds while watching the source files.


- Type: `boolean`
- Default: `false`

### `--no-watch`

Opposite of:
Continuously re-builds while watching the source files.


- Type: `boolean`
- Default: `true`

### `--fresh`

Performs a fresh build by removing the target directory first.
Expand Down Expand Up @@ -177,7 +194,7 @@ Sets the schema to be used when bundling the pilets.

- Type: `string`
- Choices: `"v0"`, `"v1"`, `"v2"`, `"none"`
- Default: `"v2"`
- Default: `undefined`

### `--bundler`

Expand Down
19 changes: 18 additions & 1 deletion docs/commands/build-piral.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Instead of `build-piral` you can also use:

### `source`

Sets the source root directory or index.html file for collecting all the information.
Sets the source Piral instance path for collecting all the information.


- Type: `string`
Expand Down Expand Up @@ -111,6 +111,23 @@ Create associated source maps for the bundles.
- Type: `boolean`
- Default: `false`

### `--watch`

Continuously re-builds while watching the source files.


- Type: `boolean`
- Default: `false`

### `--no-watch`

Opposite of:
Continuously re-builds while watching the source files.


- Type: `boolean`
- Default: `true`

### `--subdir`

Places the build's output in an appropriate subdirectory (e.g., "emulator"). Ignored for "--all".
Expand Down
10 changes: 9 additions & 1 deletion docs/commands/debug-pilet.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,14 @@ Activates Hot Module Reloading (HMR).
- Type: `boolean`
- Default: `false`

### `--krasrc`

Sets a config file for overwriting the default kras options.


- Type: `string`
- Default: `undefined`

### `--optimize-modules`

Also includes the node modules for target transpilation.
Expand All @@ -134,7 +142,7 @@ Sets the schema to be used when bundling the pilets.

- Type: `string`
- Choices: `"v0"`, `"v1"`, `"v2"`, `"none"`
- Default: `"v2"`
- Default: `undefined`

### `--bundler`

Expand Down
10 changes: 9 additions & 1 deletion docs/commands/debug-piral.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Instead of `debug-piral` you can also use:

### `source`

Sets the source root directory or index.html file for collecting all the information.
Sets the source Piral instance path for collecting all the information.


- Type: `string`
Expand Down Expand Up @@ -102,6 +102,14 @@ Activates Hot Module Reloading (HMR).
- Type: `boolean`
- Default: `false`

### `--krasrc`

Sets a config file for overwriting the default kras options.


- Type: `string`
- Default: `undefined`

### `--optimize-modules`

Also includes the node modules for target transpilation.
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/declaration-piral.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Instead of `declaration-piral` you can also use:

### `source`

Sets the source root directory or index.html file for collecting all the information.
Sets the source Piral instance path for collecting all the information.


- Type: `string`
Expand Down
4 changes: 2 additions & 2 deletions docs/commands/new-pilet.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Sets the source package (potentially incl. its tag/version) containing a Piral i


- Type: `string`
- Default: `piral`
- Default: `undefined`

## Flags

Expand Down Expand Up @@ -120,7 +120,7 @@ Sets the default bundler to install.


- Type: `string`
- Choices: `"none"`, `"esbuild"`, `"parcel"`, `"parcel2"`, `"rollup"`, `"webpack"`, `"webpack5"`, `"vite"`, `"xbuild"`
- Choices: `"none"`, `"esbuild"`, `"parcel"`, `"parcel2"`, `"rollup"`, `"rspack"`, `"webpack"`, `"webpack5"`, `"vite"`, `"xbuild"`
- Default: `"none"`

### `--vars`
Expand Down
4 changes: 2 additions & 2 deletions docs/commands/new-piral.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Sets the tag or version of the package to install. By default, this uses the ver

- Aliases: `--piral-version`
- Type: `string`
- Default: `"0.14.32"`
- Default: `"0.15.13"`

### `--force-overwrite`

Expand Down Expand Up @@ -135,7 +135,7 @@ Sets the default bundler to install.


- Type: `string`
- Choices: `"none"`, `"esbuild"`, `"parcel"`, `"parcel2"`, `"rollup"`, `"webpack"`, `"webpack5"`, `"vite"`, `"xbuild"`
- Choices: `"none"`, `"esbuild"`, `"parcel"`, `"parcel2"`, `"rollup"`, `"rspack"`, `"webpack"`, `"webpack5"`, `"vite"`, `"xbuild"`
- Default: `"none"`

### `--vars`
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/pack-pilet.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Instead of `pack-pilet` you can also use:

### `source`

Sets the source package.json file for creating the package.
Sets the source pilet path for creating the package.


- Type: `string`
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/publish-pilet.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Sets the schema to be used when making a fresh build of the pilet.

- Type: `string`
- Choices: `"v0"`, `"v1"`, `"v2"`, `"none"`
- Default: `"v2"`
- Default: `undefined`

### `--mode`

Expand Down
71 changes: 71 additions & 0 deletions docs/commands/remove-piral-instance-pilet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# `pilet remove-piral-instance`

Removes an existing Piral instance from the available apps hosting the current pilet.

## Syntax

From the command line:

```sh
pilet remove-piral-instance <app> [source]
```

Alternative:

```sh
pb remove-piral-instance-pilet <app> [source]
```

## Aliases

Instead of `remove-piral-instance-pilet` you can also use:

- `remove-shell-pilet`
- `uninstall-shell-pilet`
- `remove-app-pilet`
- `without-app-pilet`

## Positionals

### `app`

Sets the name of the Piral instance to be removed.


- Type: `string`
- Default: `undefined`

### `source`

Sets the source pilet path where the Piral instance should be removed.


- Type: `string`
- Default: `.`

## Flags

### `--log-level`

Sets the log level to use (1-5).


- Type: `number`
- Default: `3`

### `--npm-client`

Sets the npm client to be used for removing the Piral instance.


- Type: `string`
- Choices: `"npm"`, `"pnpm"`, `"pnp"`, `"yarn"`, `"lerna"`, `"rush"`
- Default: `undefined`

### `--base`

Sets the base directory. By default the current directory is used.


- Type: `string`
- Default: `process.cwd()`
Loading

0 comments on commit ec35b1d

Please sign in to comment.