Skip to content

Commit 8cd1aa0

Browse files
authored
chore: README fixes (#6)
1 parent a87adc3 commit 8cd1aa0

File tree

3 files changed

+14
-16
lines changed

3 files changed

+14
-16
lines changed

README.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,34 @@
11
# javascript-debug-ids
22

3-
JavaScript Polyfills and Bundler Plugins for the TC39 [Debug ID proposal](https://github.com/tc39/source-map/blob/main/proposals/debug-id.md).
3+
JavaScript Polyfills and Bundler Plugins for the [TC39 Debug ID proposal](https://github.com/tc39/source-map/blob/main/proposals/debug-id.md).
44

55
## Polyfills
66

77
### Browser
88

99
```ts
10-
import { getDebugIdForUrl } from "@sentry/debug-ids/browser";
10+
import { getDebugIdForUrl } from "debug-id/browser";
1111

1212
const debugId = await getDebugIdForUrl("https://example.com/main.js");
1313
```
1414

1515
### Node.js
1616

1717
```ts
18-
import { getDebugIdForUrl } from "@sentry/debug-ids/node";
18+
import { getDebugIdForUrl } from "debug-id/node";
1919

2020
const debugId = await getDebugIdForUrl("./path/to/main.js");
2121
```
2222

2323
## Bundler Plugins
2424

25-
Bundler plugins to inject [Debug
26-
IDs](https://github.com/tc39/source-map/blob/main/proposals/debug-id.md) into
27-
both source and source-maps.
25+
Bundler plugins to inject Debug IDs into both source and source-maps.
2826

2927
### Rollup
3028

3129
`rollup.config.mjs`
3230
```ts
33-
import debugIds from "@sentry/debug-ids/rollup";
31+
import debugIds from "debug-id/rollup";
3432

3533
export default {
3634
input: "./src/main.js",
@@ -47,7 +45,7 @@ export default {
4745

4846
`webpack.config.mjs`
4947
```ts
50-
import { DebugIdWebpackPlugin } from "@sentry/debug-ids/webpack";
48+
import { DebugIdWebpackPlugin } from "debug-id/webpack";
5149

5250
export default {
5351
entry: "./src/main.js",
@@ -66,7 +64,7 @@ export default {
6664
`build.mjs`
6765
```ts
6866
import * as esbuild from "esbuild";
69-
import debugIds from "@sentry/debug-ids/esbuild";
67+
import debugIds from "debug-id/esbuild";
7068

7169
await esbuild.build({
7270
entryPoints: ["./src/main.js"],
@@ -83,7 +81,7 @@ await esbuild.build({
8381

8482
`vite.config.mjs`
8583
```ts
86-
import debugIds from "@sentry/debug-ids/vite";
84+
import debugIds from "debug-id/vite";
8785

8886
export default {
8987
root: "./src",
@@ -100,7 +98,7 @@ export default {
10098

10199
`rspack.config.mjs`
102100
```ts
103-
import { DebugIdRspackPlugin } from "@sentry/debug-ids/rspack";
101+
import { DebugIdRspackPlugin } from "debug-id/rspack";
104102

105103
export default {
106104
entry: "./src/main.js",
@@ -118,7 +116,7 @@ export default {
118116

119117
`rolldown.config.mjs`
120118
```ts
121-
import debugIds from "@sentry/debug-ids/rolldown";
119+
import debugIds from "debug-id/rolldown";
122120

123121
export default {
124122
input: "./src/main.js",
@@ -138,7 +136,7 @@ export default {
138136
{
139137
"extends": "@parcel/config-default",
140138
"optimizers": {
141-
"*.{js,cjs,mjs}": ["...", "@sentry/debug-ids/parcel"]
139+
"*.{js,cjs,mjs}": ["...", "debug-id/parcel"]
142140
}
143141
}
144142
```

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@sentry/debug-ids",
2+
"name": "debug-id",
33
"version": "0.0.1",
44
"license": "MIT",
55
"exports": {

test/parcel/parcel.test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ function parcelTest(path: string, options: TestOptions) {
3333
describe('parcel', () => {
3434
test('with sourcemaps', () => {
3535
parcelTest('with-sourcemaps', {
36-
'index.9ed5572c.js': { hasDebugIds: true, hasSourceMapUrl: true },
37-
'another.3bf0f9d4.js': { hasDebugIds: true, hasSourceMapUrl: true },
36+
'index.ec07a15c.js': { hasDebugIds: true, hasSourceMapUrl: true },
37+
'another.20051b13.js': { hasDebugIds: true, hasSourceMapUrl: true },
3838
});
3939
});
4040
});

0 commit comments

Comments
 (0)