@sapphire/ts-config 5.0.4-next.fff340cc → 6.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +36 -0
- package/README.md +39 -32
- package/UPGRADING-v4-v5.md +12 -12
- package/package.json +14 -12
- package/src/tsconfig.json +3 -2
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,42 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
|
|
5
|
+
# [@sapphire/ts-config@6.0.0](https://github.com/sapphiredev/utilities/compare/@sapphire/ts-config@5.0.3...@sapphire/ts-config@6.0.0) - (2026-11-15)
|
|
6
|
+
|
|
7
|
+
## 🏠 Refactor
|
|
8
|
+
|
|
9
|
+
- Update to ESLint v10 ([991c466](https://github.com/sapphiredev/utilities/commit/991c4665ff10d9efa32d34cab134570fa7d2dd22))
|
|
10
|
+
- ***:** All round repository upgrade ([44c5c90](https://github.com/sapphiredev/utilities/commit/44c5c900ecd6f9164e073c09630a7800d69f745a))
|
|
11
|
+
- 💥 **BREAKING CHANGE:** Build system has been changed from tsup to tsdown. There may be unexpected changes in the build output.
|
|
12
|
+
- 💥 **BREAKING CHANGE:** CJS support has been entirely dropped, all packages in this repository are now ESM-only.
|
|
13
|
+
- 💥 **BREAKING CHANGE:** The `tslib` dependency has been removed from all packages.
|
|
14
|
+
- 💥 **BREAKING CHANGE:** TypeScript has been internally updated to v7.
|
|
15
|
+
- ***:** All round repository upgrade ([a58424e](https://github.com/sapphiredev/utilities/commit/a58424eadcea4990a730b0f89ce2d45f5d896c65))
|
|
16
|
+
- 💥 **BREAKING CHANGE:** Build system has been changed from tsup to tsdown. There may be unexpected changes in the build output.
|
|
17
|
+
- 💥 **BREAKING CHANGE:** CJS support has been entirely dropped, all packages in this repository are now ESM-only.
|
|
18
|
+
- 💥 **BREAKING CHANGE:** The `tslib` dependency has been removed from all packages.
|
|
19
|
+
- 💥 **BREAKING CHANGE:** TypeScript has been internally updated to v7.
|
|
20
|
+
|
|
21
|
+
## 🐛 Bug Fixes
|
|
22
|
+
|
|
23
|
+
- **deps:** Update all non-major dependencies ([09c1811](https://github.com/sapphiredev/utilities/commit/09c1811dae117f501f4e03b2015d8288e28734f8)) ([#982](https://github.com/sapphiredev/utilities/pull/982) by @renovate[bot])
|
|
24
|
+
- **deps:** Update all non-major dependencies ([72499d9](https://github.com/sapphiredev/utilities/commit/72499d99a9feb107fd3dccea601da462f1f725c1)) ([#980](https://github.com/sapphiredev/utilities/pull/980) by @renovate[bot])
|
|
25
|
+
- **deps:** Update all non-major dependencies ([e6d4bac](https://github.com/sapphiredev/utilities/commit/e6d4bac47e65e9e0ec95ebaaa1b679cfc01bd107)) ([#953](https://github.com/sapphiredev/utilities/pull/953) by @renovate[bot])
|
|
26
|
+
- **deps:** Update all non-major dependencies ([3f9fe93](https://github.com/sapphiredev/utilities/commit/3f9fe93b770479fd72b7fd56f476244c040fcb41)) ([#952](https://github.com/sapphiredev/utilities/pull/952) by @renovate[bot])
|
|
27
|
+
- **deps:** Update all non-major dependencies ([841436f](https://github.com/sapphiredev/utilities/commit/841436f1b501f468b002790283a25298561768d6)) ([#946](https://github.com/sapphiredev/utilities/pull/946) by @renovate[bot])
|
|
28
|
+
|
|
29
|
+
## 📝 Documentation
|
|
30
|
+
|
|
31
|
+
- **readme:** Update feature descriptions across packages ([302730a](https://github.com/sapphiredev/utilities/commit/302730a5b8eccb763b7b9761c3de1db9d3857394))
|
|
32
|
+
- Update typedoc to proper tsdoc ([1d29dd6](https://github.com/sapphiredev/utilities/commit/1d29dd63bc2ffd1ea25093ca2d0a9ab7d6efc9e9))
|
|
33
|
+
|
|
34
|
+
## 🚀 Features
|
|
35
|
+
|
|
36
|
+
- Update eslint rules ([901aca9](https://github.com/sapphiredev/utilities/commit/901aca995e28bf5f4b343b441ab658d9c6511195))
|
|
37
|
+
- 💥 **BREAKING CHANGE:** ESLint has been updated to v10
|
|
38
|
+
- 💥 **BREAKING CHANGE:** ESLint configuration has been changed to a flat config
|
|
39
|
+
- 💥 **BREAKING CHANGE:** Our ESLint config is now a small layer on top of [eslint-config-neon](https://www.npmjs.com/package/eslint-config-neon) which brings a LOT more rules and stricter linting.
|
|
40
|
+
|
|
5
41
|
# [@sapphire/ts-config@5.0.2](https://github.com/sapphiredev/utilities/compare/@sapphire/ts-config@5.0.1...@sapphire/ts-config@5.0.2) - (2025-11-21)
|
|
6
42
|
|
|
7
43
|
## 🏠 Refactor
|
package/README.md
CHANGED
|
@@ -14,15 +14,22 @@
|
|
|
14
14
|
|
|
15
15
|
**Table of Contents**
|
|
16
16
|
|
|
17
|
-
-
|
|
18
|
-
-
|
|
19
|
-
|
|
20
|
-
-
|
|
21
|
-
-
|
|
22
|
-
-
|
|
23
|
-
-
|
|
24
|
-
-
|
|
25
|
-
-
|
|
17
|
+
- [Features](#features)
|
|
18
|
+
- [Installation](#installation)
|
|
19
|
+
- [Usage](#usage)
|
|
20
|
+
- [Base](#base)
|
|
21
|
+
- [Extra Strict](#extra-strict)
|
|
22
|
+
- [Decorators](#decorators)
|
|
23
|
+
- [Verbatim](#verbatim)
|
|
24
|
+
- [Bundler](#bundler)
|
|
25
|
+
- [Buy us some doughnuts](#buy-us-some-doughnuts)
|
|
26
|
+
- [Contributors](#contributors)
|
|
27
|
+
|
|
28
|
+
## Features
|
|
29
|
+
|
|
30
|
+
- Provides reusable base and extra-strict TypeScript configurations
|
|
31
|
+
- Includes presets for decorators, verbatim module syntax, and bundler resolution
|
|
32
|
+
- Compose presets through TypeScript's `extends` configuration
|
|
26
33
|
|
|
27
34
|
## Installation
|
|
28
35
|
|
|
@@ -39,24 +46,24 @@ npm install --save-dev @sapphire/ts-config
|
|
|
39
46
|
This package ships a couple of different sets of tsconfig, they should be used in an array of
|
|
40
47
|
`extends` in your `tsconfig.json` file. The supported configs are:
|
|
41
48
|
|
|
42
|
-
-
|
|
43
|
-
-
|
|
44
|
-
-
|
|
45
|
-
-
|
|
49
|
+
- `@sapphire/ts-config/base` -> This is identical to `@sapphire/ts-config`
|
|
50
|
+
- `@sapphire/ts-config/extra-strict`
|
|
51
|
+
- `@sapphire/ts-config/decorators`
|
|
52
|
+
- `@sapphire/ts-config/verbatim`
|
|
46
53
|
|
|
47
54
|
You should always start with the base config, regardless of what other configs you choose.
|
|
48
55
|
Next you can opt-in to the other configs.
|
|
49
56
|
|
|
50
57
|
Finally you should configure your package.json properly based on what kind of package you are writing
|
|
51
58
|
|
|
52
|
-
-
|
|
53
|
-
-
|
|
54
|
-
-
|
|
55
|
-
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
-
|
|
59
|
-
|
|
59
|
+
- For CJS packages you should add `"type": "commonjs"` to your `package.json`
|
|
60
|
+
- For ESM packages you should add `"type": "module"` to your `package.json`
|
|
61
|
+
- For a package that is going to be used by both CJS and ESM then you should not add any `"type"` to your `package.json`
|
|
62
|
+
- Note that if you intend to compile for both your best option is to compile
|
|
63
|
+
for CJS from TypeScript, then use [`gen-esm-wrapper`](https://github.com/addaleax/gen-esm-wrapper) to transform your
|
|
64
|
+
input file to ESM compatible exports. This is also what we do for our Sapphire packages.
|
|
65
|
+
- Note also that in this case you should not enable `@sapphire/ts-config/verbatim`, because it will not work without
|
|
66
|
+
a `"type"` specified in `package.json`
|
|
60
67
|
|
|
61
68
|
Next we will go over the different configs and what they do.
|
|
62
69
|
|
|
@@ -71,10 +78,10 @@ You can view the content of this tsconfig [here](https://github.com/sapphiredev/
|
|
|
71
78
|
|
|
72
79
|
You should include this config if you want to extra strict checking. This configures the following compiler options:
|
|
73
80
|
|
|
74
|
-
-
|
|
75
|
-
-
|
|
76
|
-
-
|
|
77
|
-
-
|
|
81
|
+
- [`allowUnreachableCode` to `false`](https://www.typescriptlang.org/tsconfig#allowUnreachableCode)
|
|
82
|
+
- [`allowUnusedLabels` to `false`](https://www.typescriptlang.org/tsconfig#allowUnusedLabels)
|
|
83
|
+
- [`exactOptionalPropertyTypes` to `false`](https://www.typescriptlang.org/tsconfig#exactOptionalPropertyTypes)
|
|
84
|
+
- [`noImplicitOverride` to `true`](https://www.typescriptlang.org/tsconfig#noImplicitOverride)
|
|
78
85
|
|
|
79
86
|
You can view the content of this tsconfig [here](https://github.com/sapphiredev/utilities/blob/main/packages/ts-config/src/extra-strict.json)
|
|
80
87
|
|
|
@@ -87,8 +94,8 @@ you are using decorators. Packages such as `@sapphire/decorators` rely on this c
|
|
|
87
94
|
|
|
88
95
|
This enables the following compiler options:
|
|
89
96
|
|
|
90
|
-
-
|
|
91
|
-
-
|
|
97
|
+
- [experimentalDecorators](https://www.typescriptlang.org/tsconfig#experimentalDecorators)
|
|
98
|
+
- [emitDecoratorMetadata](https://www.typescriptlang.org/tsconfig#emitDecoratorMetadata)
|
|
92
99
|
|
|
93
100
|
You can view the content of this tsconfig [here](https://github.com/sapphiredev/utilities/blob/main/packages/ts-config/src/decorators.json)
|
|
94
101
|
|
|
@@ -101,20 +108,20 @@ See the TypeScript documentation for more information.
|
|
|
101
108
|
|
|
102
109
|
This enables the following compiler options:
|
|
103
110
|
|
|
104
|
-
-
|
|
111
|
+
- [verbatimModuleSyntax](https://www.typescriptlang.org/tsconfig#verbatimModuleSyntax)
|
|
105
112
|
|
|
106
113
|
You can view the content of this tsconfig [here](https://github.com/sapphiredev/utilities/blob/main/packages/ts-config/src/verbatim.json)
|
|
107
114
|
|
|
108
115
|
### Bundler
|
|
109
116
|
|
|
110
|
-
You may include this config if bundle your code with a bundler such as [
|
|
117
|
+
You may include this config if bundle your code with a bundler such as [tsdown], [esbuild], [swc] or something else. This
|
|
111
118
|
config sets [`moduleResolution` to `Bundler`][moduleResolution] and [`module` to `ES2022`][module]. This will likely also allow you to enable
|
|
112
119
|
[Verbatim](#verbatim).
|
|
113
120
|
|
|
114
121
|
This configures the following compiler options:
|
|
115
122
|
|
|
116
|
-
-
|
|
117
|
-
-
|
|
123
|
+
- [`moduleResolution` to `Bundler`][moduleResolution]
|
|
124
|
+
- [`module` to `ES2022`][module]
|
|
118
125
|
|
|
119
126
|
You can view the content of this tsconfig [here](https://github.com/sapphiredev/utilities/blob/main/packages/ts-config/src/bundler.json)
|
|
120
127
|
|
|
@@ -144,6 +151,6 @@ Thank you to all the people who already contributed to Sapphire!
|
|
|
144
151
|
[contributing]: https://github.com/sapphiredev/.github/blob/main/.github/CONTRIBUTING.md
|
|
145
152
|
[module]: https://www.typescriptlang.org/tsconfig#module
|
|
146
153
|
[moduleResolution]: https://www.typescriptlang.org/tsconfig#moduleResolution
|
|
147
|
-
[
|
|
154
|
+
[tsdown]: https://tsdown.dev
|
|
148
155
|
[esbuild]: https://esbuild.github.io
|
|
149
156
|
[swc]: https://swc.rs
|
package/UPGRADING-v4-v5.md
CHANGED
|
@@ -4,24 +4,24 @@ Between major version 4 and 5 of `@sapphire/ts-config`, the package has been rew
|
|
|
4
4
|
|
|
5
5
|
The following configs have been removed:
|
|
6
6
|
|
|
7
|
-
-
|
|
8
|
-
-
|
|
7
|
+
- `@sapphire/ts-config/extra-strict-without-decorators`
|
|
8
|
+
- `@sapphire/ts-config/without-decorators`
|
|
9
9
|
|
|
10
10
|
The following changes have been applied to the base config:
|
|
11
11
|
|
|
12
|
-
-
|
|
13
|
-
-
|
|
14
|
-
-
|
|
15
|
-
-
|
|
16
|
-
|
|
12
|
+
- `experimentalDecorators` is now `false` by default
|
|
13
|
+
- `emitDecoratorMetadata` is now `false` by default
|
|
14
|
+
- `verbatimModuleSyntax` is now `false` by default. It gets set to true by `@sapphire/ts-config/verbatim`.
|
|
15
|
+
- Note that you should not enable `@sapphire/ts-config/verbatim` without also setting `"type"` in `package.json`
|
|
16
|
+
to either `"commonjs"` or `"module"`
|
|
17
17
|
|
|
18
18
|
The following configs have been added:
|
|
19
19
|
|
|
20
|
-
-
|
|
21
|
-
-
|
|
22
|
-
-
|
|
23
|
-
-
|
|
24
|
-
-
|
|
20
|
+
- `@sapphire/ts-config/extra-strict`
|
|
21
|
+
- `@sapphire/ts-config/decorators`
|
|
22
|
+
- `@sapphire/ts-config/base` -> This is identical to `@sapphire/ts-config`
|
|
23
|
+
- `@sapphire/ts-config/verbatim`
|
|
24
|
+
- `@sapphire/ts-config/bundler`
|
|
25
25
|
|
|
26
26
|
In order to achieve the following old configs you now need to use:
|
|
27
27
|
|
package/package.json
CHANGED
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sapphire/ts-config",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "6.0.0",
|
|
4
4
|
"description": "Shareable TypeScript configuration for the Sapphire Community",
|
|
5
5
|
"author": "@sapphire",
|
|
6
6
|
"license": "MIT",
|
|
7
|
+
"type": "module",
|
|
7
8
|
"main": "src/tsconfig.json",
|
|
8
9
|
"exports": {
|
|
9
10
|
".": {
|
|
@@ -41,22 +42,22 @@
|
|
|
41
42
|
"homepage": "https://github.com/sapphiredev/utilities/tree/main/packages/ts-config",
|
|
42
43
|
"scripts": {
|
|
43
44
|
"test": "vitest run",
|
|
44
|
-
"lint": "eslint tests --ext mjs,ts --fix
|
|
45
|
+
"lint": "eslint tests --ext mjs,ts --fix",
|
|
45
46
|
"build": "tsc -b tests",
|
|
46
47
|
"bump": "cliff-jumper",
|
|
47
48
|
"check-update": "cliff-jumper --dry-run"
|
|
48
49
|
},
|
|
49
50
|
"dependencies": {
|
|
50
|
-
"
|
|
51
|
-
"typescript": "~
|
|
51
|
+
"@types/node": "*",
|
|
52
|
+
"typescript": "~6.0.3"
|
|
52
53
|
},
|
|
53
54
|
"files": [
|
|
54
55
|
"src",
|
|
55
56
|
"UPGRADING-*.md"
|
|
56
57
|
],
|
|
57
58
|
"engines": {
|
|
58
|
-
"node": ">=
|
|
59
|
-
"npm": ">=
|
|
59
|
+
"node": ">=v24.0.0",
|
|
60
|
+
"npm": ">=11.0.0"
|
|
60
61
|
},
|
|
61
62
|
"repository": {
|
|
62
63
|
"type": "git",
|
|
@@ -80,11 +81,12 @@
|
|
|
80
81
|
"access": "public"
|
|
81
82
|
},
|
|
82
83
|
"devDependencies": {
|
|
83
|
-
"@favware/cliff-jumper": "^6.
|
|
84
|
-
"@sapphire/eslint-config": "^
|
|
85
|
-
"@sapphire/eslint-plugin-result": "^
|
|
86
|
-
"@vitest/coverage-v8": "^
|
|
87
|
-
"
|
|
88
|
-
"
|
|
84
|
+
"@favware/cliff-jumper": "^6.1.0",
|
|
85
|
+
"@sapphire/eslint-config": "^6.0.0",
|
|
86
|
+
"@sapphire/eslint-plugin-result": "^3.0.0",
|
|
87
|
+
"@vitest/coverage-v8": "^5.1.0",
|
|
88
|
+
"eslint": "^10.15.0",
|
|
89
|
+
"tsdown": "^0.23.7",
|
|
90
|
+
"vitest": "^5.1.0"
|
|
89
91
|
}
|
|
90
92
|
}
|