Skip to content

Commit

Permalink
update default options doc
Browse files Browse the repository at this point in the history
  • Loading branch information
GaryB432 committed Sep 30, 2024
1 parent d7abafa commit f954cea
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 18 deletions.
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,14 @@ Bump package.json version

<!-- prettier-ignore -->
| ARGUMENT | DESCRIPTION | VALUE TYPE |
| ---- | ---- | ---- |
| --- | --- | --- |
| part | Which part to increment | major \| premajor \| minor \| preminor \| patch \| prepatch \| prerelease |

### Options

<!-- prettier-ignore -->
| OPTION | DESCRIPTION | VALUE TYPE | DEFAULT VALUE |
| ---- | ---- | ---- | ---- |
| --- | --- | --- | --- |
| --skipInstall | Skip package installation | boolean | false |

## devops
Expand All @@ -50,14 +50,14 @@ Add platform devops pipeline

<!-- prettier-ignore -->
| ARGUMENT | DESCRIPTION | VALUE TYPE |
| ---- | ---- | ---- |
| --- | --- | --- |
| platform | Which Dev Ops pipeline | azure \| github |

### Options

<!-- prettier-ignore -->
| OPTION | DESCRIPTION | VALUE TYPE | DEFAULT VALUE |
| ---- | ---- | ---- | ---- |
| --- | --- | --- | --- |
| --skipInstall | Skip package installation | boolean | false |

## eslint
Expand All @@ -72,9 +72,9 @@ Add eslint configuration.

<!-- prettier-ignore -->
| OPTION | DESCRIPTION | VALUE TYPE | DEFAULT VALUE |
| ---- | ---- | ---- | ---- |
| --- | --- | --- | --- |
| --includeTypescript | Include Typescript | boolean | true |
| --includePrettier | Include Prettier | boolean | true |
| --includePrettier | Include Prettier | boolean | false |
| --skipInstall | Skip package installation | boolean | false |

## jest
Expand All @@ -97,14 +97,14 @@ Add Class or general Module

<!-- prettier-ignore -->
| ARGUMENT | DESCRIPTION | VALUE TYPE |
| ---- | ---- | ---- |
| --- | --- | --- |
| name | The name of the module. | string |

### Options

<!-- prettier-ignore -->
| OPTION | DESCRIPTION | VALUE TYPE | DEFAULT VALUE |
| ---- | ---- | ---- | ---- |
| --- | --- | --- | --- |
| --directory | The directory to create the module, relative to the project source. | string | |
| --kind | kind of module | class \| values | values |
| --unitTestRunner | Test runner to use for unit tests. | jest \| vitest \| native \| none | jest |
Expand Down Expand Up @@ -133,17 +133,17 @@ Add a component to your sveltekit project

<!-- prettier-ignore -->
| ARGUMENT | DESCRIPTION | VALUE TYPE |
| ---- | ---- | ---- |
| --- | --- | --- |
| name | The name of the component. | string |

### Options

<!-- prettier-ignore -->
| OPTION | DESCRIPTION | VALUE TYPE | DEFAULT VALUE |
| ---- | ---- | ---- | ---- |
| --- | --- | --- | --- |
| --directory | The directory to create the component, relative to your project source. | string | |
| --language | Component script language (ts/js). | js \| ts | ts |
| --style | Component style language (css/scss). | css \| scss | scss |
| --language | Component script language (ts/js). | js \| ts | js |
| --style | Component style language (css/scss). | css \| scss | css |
| --projectRoot | Svelte App root directory | string | |

## sveltekit-route
Expand All @@ -158,16 +158,16 @@ Add a route to your sveltekit project

<!-- prettier-ignore -->
| ARGUMENT | DESCRIPTION | VALUE TYPE |
| ---- | ---- | ---- |
| --- | --- | --- |
| name | The name of the route. | string |

### Options

<!-- prettier-ignore -->
| OPTION | DESCRIPTION | VALUE TYPE | DEFAULT VALUE |
| ---- | ---- | ---- | ---- |
| --- | --- | --- | --- |
| --path | The path at which to create the route file, relative to the projectRoot. Default is a folder with the same name as the route in the project root. | string | |
| --style | The value of style element lang attribute | css \| scss \| none | scss |
| --style | The value of style element lang attribute | css \| scss \| none | css |
| --skipTests | Do not create "spec.ts" test files for the new route. | boolean | false |
| --endpoint | Create an endpoint handler for your route. | boolean | true |

Expand All @@ -183,7 +183,7 @@ Add typescript.

<!-- prettier-ignore -->
| OPTION | DESCRIPTION | VALUE TYPE | DEFAULT VALUE |
| ---- | ---- | ---- | ---- |
| --- | --- | --- | --- |
| --skipInstall | Skip package installation | boolean | false |

see
Expand Down
4 changes: 2 additions & 2 deletions tools/make-help.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ function makeDescription(name: string, details: Details): string {

function tableHeader(...cells: string[]): string {
const ff = tableRow(...cells);
const fj = tableRow(...cells.map(() => '----'));
return [ff, fj].join('\n');
const fj = tableRow(...cells.map(() => '---'));
return ['<!-- prettier-ignore -->', ff, fj].join('\n');
}

function tableRow(...cells: string[]): string {
Expand Down

0 comments on commit f954cea

Please sign in to comment.