Skip to content

Commit 040297c

Browse files
committed
Update doc and types
1 parent d101adc commit 040297c

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

packages/plugins/error-tracking/README.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ Interact with Error Tracking directly from your build system.
1111
<!-- #toc -->
1212
- [Configuration](#configuration)
1313
- [Sourcemaps Upload](#sourcemaps-upload)
14-
- [`errorTracking.sourcemaps.bailOnError`](#errortrackingsourcemapsbailonerror)
15-
- [`errorTracking.sourcemaps.dryRun`](#errortrackingsourcemapsdryrun)
16-
- [`errorTracking.sourcemaps.intakeUrl`](#errortrackingsourcemapsintakeurl)
17-
- [`errorTracking.sourcemaps.maxConcurrency`](#errortrackingsourcemapsmaxconcurrency)
18-
- [`errorTracking.sourcemaps.minifiedPathPrefix`](#errortrackingsourcemapsminifiedpathprefix)
19-
- [`errorTracking.sourcemaps.releaseVersion`](#errortrackingsourcemapsreleaseversion)
20-
- [`errorTracking.sourcemaps.service`](#errortrackingsourcemapsservice)
14+
- [errorTracking.sourcemaps.bailOnError](#errortrackingsourcemapsbailonerror)
15+
- [errorTracking.sourcemaps.dryRun](#errortrackingsourcemapsdryrun)
16+
- [errorTracking.sourcemaps.intakeUrl](#errortrackingsourcemapsintakeurl)
17+
- [errorTracking.sourcemaps.maxConcurrency](#errortrackingsourcemapsmaxconcurrency)
18+
- [errorTracking.sourcemaps.minifiedPathPrefix](#errortrackingsourcemapsminifiedpathprefix)
19+
- [errorTracking.sourcemaps.releaseVersion](#errortrackingsourcemapsreleaseversion)
20+
- [errorTracking.sourcemaps.service](#errortrackingsourcemapsservice)
2121
<!-- #toc -->
2222

2323
## Configuration
@@ -45,31 +45,31 @@ Upload JavaScript sourcemaps to Datadog to un-minify your errors.
4545
> You can override the intake URL by setting the `DATADOG_SOURCEMAP_INTAKE_URL` environment variable (eg. `https://sourcemap-intake.datadoghq.com/v1/input`).
4646
> Or only the domain with the `DATADOG_SITE` environment variable (eg. `datadoghq.com`).
4747
48-
### `errorTracking.sourcemaps.bailOnError`
48+
### errorTracking.sourcemaps.bailOnError
4949

5050
> default: `false`
5151
5252
Should the upload of sourcemaps fail the build on first error?
5353

54-
### `errorTracking.sourcemaps.dryRun`
54+
### errorTracking.sourcemaps.dryRun
5555

5656
> default: `false`
5757
5858
It will not upload the sourcemaps to Datadog, but will do everything else.
5959

60-
### `errorTracking.sourcemaps.intakeUrl`
60+
### errorTracking.sourcemaps.intakeUrl
6161

6262
> default: `https://sourcemap-intake.datadoghq.com/api/v2/srcmap`
6363
6464
Against which endpoint do you want to upload the sourcemaps.
6565

66-
### `errorTracking.sourcemaps.maxConcurrency`
66+
### errorTracking.sourcemaps.maxConcurrency
6767

6868
> default: `20`
6969
7070
Number of concurrent upload to the API.
7171

72-
### `errorTracking.sourcemaps.minifiedPathPrefix`
72+
### errorTracking.sourcemaps.minifiedPathPrefix
7373

7474
> required
7575
@@ -79,13 +79,13 @@ The prefix can be a full URL or an absolute path.
7979

8080
Example: if you're uploading `dist/file.js` to `https://example.com/static/file.js`, you can use `minifiedPathPrefix: 'https://example.com/static/'` or `minifiedPathPrefix: '/static/'`.`minifiedPathPrefix: '/'` is a valid input when you upload JS at the root directory of the server.
8181

82-
### `errorTracking.sourcemaps.releaseVersion`
82+
### errorTracking.sourcemaps.releaseVersion
8383

8484
> required
8585
8686
Is similar and will be used to match the `version` tag set on the RUM SDK.
8787

88-
### `errorTracking.sourcemaps.service`
88+
### errorTracking.sourcemaps.service
8989

9090
> required
9191

packages/plugins/error-tracking/src/validate.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ const validateMinifiedPathPrefix = (minifiedPathPrefix: string): boolean => {
6969

7070
export const validateSourcemapsOptions = (
7171
config: Partial<OptionsWithErrorTracking>,
72-
): ToReturn<ErrorTrackingOptionsWithDefaults['sourcemaps']> => {
72+
): ToReturn<SourcemapsOptionsWithDefaults> => {
7373
const red = chalk.bold.red;
7474
const validatedOptions: ErrorTrackingOptions = config[CONFIG_KEY] || {};
7575
const toReturn: ToReturn<SourcemapsOptionsWithDefaults> = {

0 commit comments

Comments
 (0)