From c9ad2d877b7f88568478aab16c33303653c8abd0 Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Wed, 1 Apr 2026 09:49:19 +0200 Subject: [PATCH 1/3] chore: Remove unused `tsconfig-template` folder --- tsconfig-templates/README.md | 7 ------- tsconfig-templates/tsconfig.json | 9 --------- tsconfig-templates/tsconfig.test.json | 12 ------------ tsconfig-templates/tsconfig.types.json | 10 ---------- 4 files changed, 38 deletions(-) delete mode 100644 tsconfig-templates/README.md delete mode 100644 tsconfig-templates/tsconfig.json delete mode 100644 tsconfig-templates/tsconfig.test.json delete mode 100644 tsconfig-templates/tsconfig.types.json diff --git a/tsconfig-templates/README.md b/tsconfig-templates/README.md deleted file mode 100644 index f1b29fb1b3e9..000000000000 --- a/tsconfig-templates/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# `tsconfig` Templates - -Every package should get its own copy of the three files in this directory and the one in `test/` (which should go in an -analogous spot in the package). Package-specific options should go in `tsconfig.json` and test-specific options in -`tsconfig.test.json`. The `types` file shouldn't need to be modified, and only exists because tsconfigs don't support -multiple inheritance. The same goes for the file in `test/`, which only exists because VSCode only knows to look for a -file named (exactly) `tsconfig.json`. diff --git a/tsconfig-templates/tsconfig.json b/tsconfig-templates/tsconfig.json deleted file mode 100644 index bf45a09f2d71..000000000000 --- a/tsconfig-templates/tsconfig.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "extends": "../../tsconfig.json", - - "include": ["src/**/*"], - - "compilerOptions": { - // package-specific options - } -} diff --git a/tsconfig-templates/tsconfig.test.json b/tsconfig-templates/tsconfig.test.json deleted file mode 100644 index 1141567cdfec..000000000000 --- a/tsconfig-templates/tsconfig.test.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "extends": "./tsconfig.json", - - "include": ["test/**/*"], - - "compilerOptions": { - // should include all types from `./tsconfig.json` plus types for all test frameworks used - "types": [] - - // other package-specific, test-specific options - } -} diff --git a/tsconfig-templates/tsconfig.types.json b/tsconfig-templates/tsconfig.types.json deleted file mode 100644 index 65455f66bd75..000000000000 --- a/tsconfig-templates/tsconfig.types.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "extends": "./tsconfig.json", - - "compilerOptions": { - "declaration": true, - "declarationMap": true, - "emitDeclarationOnly": true, - "outDir": "build/types" - } -} From 03d457e20a4cef922ad87a72e0ccf87a2cbe1f8a Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Wed, 1 Apr 2026 10:06:35 +0200 Subject: [PATCH 2/3] add section about boilerplate files --- docs/creating-a-new-sdk.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/creating-a-new-sdk.md b/docs/creating-a-new-sdk.md index 986450b92b06..687c4b5ae99b 100644 --- a/docs/creating-a-new-sdk.md +++ b/docs/creating-a-new-sdk.md @@ -21,6 +21,17 @@ As a rule of thumb, we should follow these two ideas: 2. Instrumentation should follow common patterns for a specific platform. No config is always preferred, but if config is unavoidable, it should feel as native as possible to users of the given framework. +### Boilerplate Files + +Make sure all the boilerplate for your package is set up correctly. This can include, depending on the package: + +* `tsconfig.json`, `tsconfig.test.json`, `tsconfig.types.json`, `test/tsconfig.json` +* `oxlintsc.json` +* `rollup.*.config.mjs` +* `LICENSE` +* `README.md` +* `vite.config.ts` + ## 1. Browser SDKs A purely browser SDK generally should cover the following things: From a4838aeb03482a51fd8e11b5f28b544e4c25b624 Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Wed, 1 Apr 2026 11:05:32 +0200 Subject: [PATCH 3/3] fix linting --- docs/creating-a-new-sdk.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/creating-a-new-sdk.md b/docs/creating-a-new-sdk.md index 687c4b5ae99b..c3acd9c56bff 100644 --- a/docs/creating-a-new-sdk.md +++ b/docs/creating-a-new-sdk.md @@ -25,12 +25,12 @@ As a rule of thumb, we should follow these two ideas: Make sure all the boilerplate for your package is set up correctly. This can include, depending on the package: -* `tsconfig.json`, `tsconfig.test.json`, `tsconfig.types.json`, `test/tsconfig.json` -* `oxlintsc.json` -* `rollup.*.config.mjs` -* `LICENSE` -* `README.md` -* `vite.config.ts` +- `tsconfig.json`, `tsconfig.test.json`, `tsconfig.types.json`, `test/tsconfig.json` +- `oxlintsc.json` +- `rollup.*.config.mjs` +- `LICENSE` +- `README.md` +- `vite.config.ts` ## 1. Browser SDKs