Skip to content

Commit

Permalink
sort nested config
Browse files Browse the repository at this point in the history
  • Loading branch information
ignatiusmb committed Jul 9, 2021
1 parent a06aac2 commit 400c99f
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions documentation/docs/14-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,15 @@ const config = {
hydrate: true,
package: {
dir: 'package',
emitTypes: true,
exports: {
include: ['**'],
exclude: ['_*', '**/_*']
},
files: {
include: ['**'],
exclude: []
},
emitTypes: true
}
},
paths: {
assets: '',
Expand Down Expand Up @@ -85,10 +85,10 @@ The directory relative to `paths.assets` where the built JS and CSS (and importe
An object containing zero or more of the following `string` values:

- `assets` — a place to put static files that should have stable URLs and undergo no processing, such as `favicon.ico` or `manifest.json`
- `hooks` — the location of your hooks module (see [Hooks](#hooks))
- `lib` — your app's internal library, accessible throughout the codebase as `$lib`
- `routes` — the files that define the structure of your app (see [Routing](#routing))
- `serviceWorker` — the location of your service worker's entry point (see [Service workers](#service-workers))
- `hooks` — the location of your hooks module (see [Hooks](#hooks))
- `template` — the location of the template for HTML responses

### floc
Expand Down Expand Up @@ -131,9 +131,9 @@ Whether to [hydrate](#ssr-and-javascript-hydrate) the server-rendered HTML with
Options related to [creating a package](#packaging).

- `dir` - output directory
- `emitTypes` - by default, `svelte-kit package` will automatically generate types for your package in the form of `d.ts.` files. While generating types is configurable, we believe it is best for the ecosystem quality to generate types, always. Please make sure you have a good reason when setting it to `false` (for example when you want to provide handwritten type definitions instead).
- `exports` - contains a `includes` and a `excludes` array which specifies which files to mark as exported from the `exports` field of the `package.json`
- `files` - contains a `includes` and a `excludes` array which specifies which files to process and copy over when packaging
- `emitTypes` - by default, `svelte-kit package` will automatically generate types for your package in the form of `d.ts.` files. While generating types is configurable, we believe it is best for the ecosystem quality to generate types, always. Please make sure you have a good reason when setting it to `false` (for example when you want to provide handwritten type definitions instead).

### paths

Expand Down
8 changes: 4 additions & 4 deletions packages/kit/types/config.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ export type Config = {
hydrate?: boolean;
package?: {
dir?: string;
emitTypes?: boolean;
exports?: {
include?: string[];
exclude?: string[];
Expand All @@ -54,11 +55,10 @@ export type Config = {
include?: string[];
exclude?: string[];
};
emitTypes?: boolean;
};
paths?: {
base?: string;
assets?: string;
base?: string;
};
prerender?: {
crawl?: boolean;
Expand Down Expand Up @@ -100,6 +100,7 @@ export type ValidatedConfig = {
hydrate: boolean;
package: {
dir: string;
emitTypes: boolean;
exports: {
include: string[];
exclude: string[];
Expand All @@ -108,11 +109,10 @@ export type ValidatedConfig = {
include: string[];
exclude: string[];
};
emitTypes: boolean;
};
paths: {
base: string;
assets: string;
base: string;
};
prerender: {
crawl: boolean;
Expand Down

0 comments on commit 400c99f

Please sign in to comment.