Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/smapiot/piral into document…
Browse files Browse the repository at this point in the history
…ation
  • Loading branch information
FlorianRappl committed Jul 3, 2022
2 parents 92132df + d76ab00 commit 19ccbc0
Show file tree
Hide file tree
Showing 94 changed files with 1,583 additions and 836 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Piral Changelog

## 0.14.28 (July 1, 2022)

- Improved download for templates falling back to default registry
- Fixed navigation via `NavigationManager` of Blazor in `piral-blazor`
- Added warning when overwriting crucial Webpack sections
- Added support for `order` and `empty` props from `piral-blazor`
- Added CLI aliases for problematic flags (e.g., `--install`)

## 0.14.27 (June 7, 2022)

- Fixed issue with `piral-cli-webpack` and `piral-cli-webpack5` not resolving *.jsx*
Expand Down
36 changes: 36 additions & 0 deletions docs/commands/build-pilet.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Instead of `build-pilet` you can also use:

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


- Type: `string`
- Default: `./src/index`

Expand All @@ -39,20 +40,39 @@ Sets the source index.tsx file for collecting all the information.

Sets the target file of bundling.


- Type: `string`
- Default: `"./dist/index.js"`

### `--public-url`

Sets the public URL (path) of the application.


- Type: `string`
- Default: `"/"`

### `--log-level`

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


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

### `--concurrency`

Sets the maximum number of concurrent build jobs.


- Type: `number`
- Default: `12`

### `--source-maps`

Creates source maps for the bundles.


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

Expand All @@ -61,13 +81,15 @@ Creates source maps for the bundles.
Opposite of:
Creates source maps for the bundles.


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

### `--fresh`

Performs a fresh build by removing the target directory first.


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

Expand All @@ -76,13 +98,15 @@ Performs a fresh build by removing the target directory first.
Opposite of:
Performs a fresh build by removing the target directory first.


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

### `--minify`

Performs minification or other post-bundle transformations.


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

Expand All @@ -91,13 +115,15 @@ Performs minification or other post-bundle transformations.
Opposite of:
Performs minification or other post-bundle transformations.


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

### `--declaration`

Creates a declaration file for the pilet.


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

Expand All @@ -106,13 +132,15 @@ Creates a declaration file for the pilet.
Opposite of:
Creates a declaration file for the pilet.


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

### `--content-hash`

Appends the hash to the side-bundle files.


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

Expand All @@ -121,13 +149,15 @@ Appends the hash to the side-bundle files.
Opposite of:
Appends the hash to the side-bundle files.


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

### `--optimize-modules`

Also includes the node modules for target transpilation.


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

Expand All @@ -136,13 +166,15 @@ Also includes the node modules for target transpilation.
Opposite of:
Also includes the node modules for target transpilation.


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

### `--schema`

Sets the schema to be used when bundling the pilets.


- Type: `string`
- Choices: `"v0"`, `"v1"`, `"v2"`, `"none"`
- Default: `"v2"`
Expand All @@ -151,6 +183,7 @@ Sets the schema to be used when bundling the pilets.

Sets the bundler to use.


- Type: `string`
- Choices: ``
- Default: `undefined`
Expand All @@ -159,6 +192,7 @@ Sets the bundler to use.

Selects the target type of the build.


- Type: `string`
- Choices: `"default"`, `"standalone"`, `"manifest"`
- Default: `"default"`
Expand All @@ -167,12 +201,14 @@ Selects the target type of the build.

Sets the name of the Piral instance.


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

### `--base`

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


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

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


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

Expand All @@ -39,27 +40,31 @@ Sets the source root directory or index.html file for collecting all the informa

Sets the target directory or file of bundling.


- Type: `string`
- Default: `"./dist"`

### `--public-url`

Sets the public URL (path) of the bundle. Only for release output.


- Type: `string`
- Default: `"/"`

### `--log-level`

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


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

### `--fresh`

Performs a fresh build by removing the target directory first.


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

Expand All @@ -68,13 +73,15 @@ Performs a fresh build by removing the target directory first.
Opposite of:
Performs a fresh build by removing the target directory first.


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

### `--minify`

Performs minification or other post-bundle transformations.


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

Expand All @@ -83,13 +90,15 @@ Performs minification or other post-bundle transformations.
Opposite of:
Performs minification or other post-bundle transformations.


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

### `--source-maps`

Create associated source maps for the bundles.


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

Expand All @@ -98,13 +107,15 @@ Create associated source maps for the bundles.
Opposite of:
Create associated source maps for the bundles.


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

### `--subdir`

Places the build's output in an appropriate subdirectory (e.g., "emulator"). Ignored for "--all".


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

Expand All @@ -113,13 +124,15 @@ Places the build's output in an appropriate subdirectory (e.g., "emulator"). Ign
Opposite of:
Places the build's output in an appropriate subdirectory (e.g., "emulator"). Ignored for "--all".


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

### `--content-hash`

Appends the hash to the side-bundle files.


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

Expand All @@ -128,13 +141,15 @@ Appends the hash to the side-bundle files.
Opposite of:
Appends the hash to the side-bundle files.


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

### `--optimize-modules`

Also includes the node modules for target transpilation.


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

Expand All @@ -143,13 +158,15 @@ Also includes the node modules for target transpilation.
Opposite of:
Also includes the node modules for target transpilation.


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

### `--type`

Selects the target type of the build. "all" builds all target types.


- Type: `string`
- Choices: `"all"`, `"release"`, `"emulator"`, `"emulator-sources"`
- Default: `"all"`
Expand All @@ -158,6 +175,7 @@ Selects the target type of the build. "all" builds all target types.

Sets the bundler to use.


- Type: `string`
- Choices: ``
- Default: `undefined`
Expand All @@ -166,5 +184,6 @@ Sets the bundler to use.

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


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

0 comments on commit 19ccbc0

Please sign in to comment.