Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
FlorianRappl committed Jul 24, 2023
1 parent 3630312 commit da5f369
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/commands/build-pilet.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Sets the maximum number of concurrent build jobs.


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

### `--source-maps`

Expand Down
2 changes: 1 addition & 1 deletion docs/commands/debug-pilet.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Sets the maximum number of concurrent build jobs.


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

### `--open`

Expand Down
2 changes: 1 addition & 1 deletion 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: `"1.0.0"`
- Default: `"1.0.2"`

### `--force-overwrite`

Expand Down
6 changes: 6 additions & 0 deletions docs/commands/validate-pilet.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,12 @@ Checks that no other (third-party) dependencies are bundled in.

**Options**: `'ignore' | 'active'`

### `has-non-conflicting-css`

Checks if a pilet might cause a CSS conflict. A score of 100 means that there is the least chance of a CSS conflict, while a score of 0 means that a CSS conflict is most likely. Negative values yield a warning if the CSS score is below the given number. Positive values yield an error if the CSS score is below the given number. A value of 0 turns this validation off. By default, a pilet's stylesheet having a CSS score of below 50 will result in a warning.

**Options**: `number`

### `stays-small`

Checks if the main bundle of the pilet is not exceeding a given threshold. The pilet must have been built beforehand for this validation to be conclusive. Negative values yield a warning if the absolute size in kB is exceeded. Positive values yield an error if the absolute size in kB is exceeded. A value of 0 turns this validation off. By default, a pilet's main bundle exceeding 50 kB will result in a warning.
Expand Down

0 comments on commit da5f369

Please sign in to comment.