Skip to content

Commit

Permalink
Fix minor issues
Browse files Browse the repository at this point in the history
  • Loading branch information
kristianmandrup authored and DominikPieper committed Oct 23, 2023
1 parent 121b7fa commit 98ac839
Show file tree
Hide file tree
Showing 8 changed files with 262 additions and 40,386 deletions.
2 changes: 1 addition & 1 deletion docs/docs/sveltekit/executors.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ Options can be configured in the 'project.json' when defining the executor, or w

Type: `string`

Possible values: `tailwindcss`, `mdsvex`, `graphql`, `postcss`, `bulma`, `windicss`, `firebase-hosting`
Possible values: `tailwindcss`, `mdsvex`, `graphql`, `postcss`, `picocss`, `bulma`, `windicss`, `firebase-hosting`

Package you want to install
244 changes: 244 additions & 0 deletions docs/docs/sveltekit/generators.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,3 +121,247 @@ Type: `string`
Possible values: `vitest`, `none`

Test runner to use for unit tests.

## @nxext/sveltekit:library

route generator

### Usage

```bash
nx generate library ...
```

By default, Nx will search for `library` in the default collection provisioned in nx.json.

You can specify the collection explicitly as follows:

```bash
nx g @nxext/sveltekit:library ...
```

Show what will be generated without writing to disk:

```bash
nx g library ... --dry-run
```

### Options

#### name (_**required**_)

Type: `string`

#### buildable

Default: `false`

Type: `boolean`

Generate a buildable library.

#### directory

Alias(es): d

Type: `string`

A directory where the lib is placed.

#### e2eTestRunner

Default: `cypress`

Type: `string`

Possible values: `cypress`, `none`

Test runner to use for end to end (e2e) tests.

#### importPath

Type: `string`

The library name used to import it, like @myorg/my-awesome-lib

#### linter

Default: `eslint`

Type: `string`

Possible values: `eslint`

The tool to use for running lint checks.

#### publishable

Type: `boolean`

Create a publishable library.

#### skipFormat

Default: `false`

Type: `boolean`

Skip formatting files.

#### tags

Alias(es): t

Type: `string`

Add tags to the project (used for linting)

#### unitTestRunner

Default: `vitest`

Type: `string`

Possible values: `jest`, `vitest`, `none`

Test runner to use for unit tests.

## @nxext/sveltekit:route

route generator

### Usage

```bash
nx generate route ...
```

By default, Nx will search for `route` in the default collection provisioned in nx.json.

You can specify the collection explicitly as follows:

```bash
nx g @nxext/sveltekit:route ...
```

Show what will be generated without writing to disk:

```bash
nx g route ... --dry-run
```

### Options

#### name (_**required**_)

Alias(es): n

Type: `string`

#### project (_**required**_)

Type: `string`

Project where the component is generated

#### api

Alias(es): a

Default: `false`

Type: `boolean`

Whether to create a server API file

#### error

Alias(es): e

Default: `false`

Type: `boolean`

Whether to create an error page

#### layout

Alias(es): l

Default: `false`

Type: `boolean`

Whether to create a layout file

#### layoutClientLoader

Default: `false`

Type: `boolean`

Whether to create a layout client data loader file

#### layoutServerLoader

Default: `false`

Type: `boolean`

Whether to create a layout server data loader file

#### methods

Alias(es): m

Type: `string`

HTTP methods for endpoints (GET, POST)

#### page

Alias(es): p

Default: `true`

Type: `boolean`

Whether to create a page file

#### pageClientLoader

Alias(es): c

Default: `false`

Type: `boolean`

Whether to create a client data loader file

#### pageServerLoader

Alias(es): s

Default: `false`

Type: `boolean`

Whether to create a server data loader file

#### targetPath

Alias(es): t

Type: `string`

Where in the project the page should be generated

#### unitTestRunner

Default: `vitest`

Type: `string`

Possible values: `vitest`, `none`

Test runner to use for unit tests.
Loading

0 comments on commit 98ac839

Please sign in to comment.