Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs/v3 default flag values #899

Merged
merged 4 commits into from
Aug 1, 2022
Merged

Docs/v3 default flag values #899

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
41612ba
docs(config): update `sourceMaps` default to `true`
Aug 1, 2022
fb30f4c
docs(custom-elements): set `generateTypeDeclarations` default to `true`
Aug 1, 2022
0a3ccb1
chore(): fix grammatical error
Aug 1, 2022
83acd78
docs(config): update language for clarity
Aug 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions src/docs/config/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,12 +180,13 @@ Will generate the following comment:

## sourceMap

*default: `false`*
*default: `true`*

When set to `true`, sourcemaps will be generated for a project.
When omitted or set to `true`, sourcemaps will be generated for a project.
When set to `false`, sourcemaps will not be generated.

```tsx
sourceMap: true
sourceMap: true | false
```

Sourcemaps create a translation between Stencil components that are written in TypeScript/JSX and the resulting
Expand All @@ -201,8 +202,6 @@ compared to the minified result produced when `sourceMap` is not enabled.
Developers are responsible for determining whether or not they choose to serve sourcemaps in each environment their
components are served and implementing their decision accordingly.

When omitted or set to `false`, sourcemaps will not be generated.

## srcDir

*default: `src`*
Expand Down
12 changes: 3 additions & 9 deletions src/docs/output-targets/custom-elements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,17 +71,11 @@ This flag defaults to `false` when omitted from a Stencil configuration file.

### generateTypeDeclarations

By default, type declaration files (`.d.ts` files) are only generated for the `dist-custom-elements` output target when
the [`dist` output target](/docs/distribution) is also declared in a Stencil project's configuration. This behavior
isn't always desirable, as not all users need the files emitted by the `dist` output target. To generate type
declaration files for the `dist-custom-elements`, the experimental `generateTypeDeclarations` field can be set to
`true`.
By default, Stencil will generate type declaration files (`.d.ts` files) as a part of the `dist-custom-elements` output target through the `generateTypeDeclarations` field on the target options. Type declaration files will be placed in the `dist/types` directory in the root of a Stencil project. At this time, this output destination is not able to be configured.

Setting this flag to `true` will generate type declaration files for the `dist-custom-elements` output target. Type
declaration files will be placed in the `dist/types` directory in the root of a Stencil project. At this time, this
output destination is not able to be configured.
Setting this flag to `false` will not generate type declaration files for the `dist-custom-elements` output target.

This flag defaults to `false` when omitted from a Stencil configuration file.
This flag defaults to `true` when omitted from a Stencil configuration file.

## Making Assets Available

Expand Down