strict-ts-lib-v5.1 0.5.0 → 0.6.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 ADDED
@@ -0,0 +1,131 @@
1
+ # strict-ts-lib-v5.1
2
+
3
+ ## 0.6.0
4
+
5
+ ### Minor Changes
6
+
7
+ - ac290c1: Leave `Exclude`, `Extract`, `Omit` and `Pick` with the constraints TypeScript
8
+ declares, and widen `strict-ts-lib-v7.0`'s `typescript` peer range to
9
+ `>=6.0.0 <8.0.0`.
10
+
11
+ Both landed on main in #1672 and #1673 but shipped no release: those changesets
12
+ named the bundle packages (`strict-ts-lib-v7.0` and friends) rather than the
13
+ `-source` harnesses this repository versions. `changeset version` bumped the
14
+ bundle manifests, and `strict-lib:gen:packages` — which runs next and stamps
15
+ each bundle with its harness's version — wrote 0.5.1 straight back over them,
16
+ the harnesses never having been bumped at all. Nothing errored; the version
17
+ simply did not move.
18
+
19
+ All twelve harnesses are named. The `fixed` group in `.changeset/config.json`
20
+ would align the versions from a single name, but a changeset's text reaches
21
+ only the packages it names — the rest get a bare version heading with nothing
22
+ under it. A change to the shared converter affects every series equally, so
23
+ every series' changelog should say so.
24
+
25
+ ### `Exclude` and `Omit`
26
+
27
+ Two of the four utility types had their second argument narrowed here —
28
+ `Exclude<T, U extends T>` and `Omit<T, K extends keyof T>`, against upstream's
29
+ `Exclude<T, U>` and `Omit<T, K extends keyof any>`. `Extract` and `Pick`
30
+ already matched.
31
+
32
+ Narrowing makes a choice on the caller's behalf, and only one of the two
33
+ readings is ever right for a given call. Subtracting keys a type may not have
34
+ is legitimate — upstream's own declarations do it — and under the narrowed
35
+ constraint it is a TS2344 that nothing can fix when the declaration lives
36
+ inside a dependency. Making the choice explicit belongs in the caller's code,
37
+ which is what `eslint-plugin-ts-type-forge`'s
38
+ `prefer-strict-or-relaxed-utility-type` does, pointing at `StrictOmit` /
39
+ `RelaxedOmit` and the rest.
40
+
41
+ Only widens what is accepted, so anything that compiled still does.
42
+
43
+ ### Peer range
44
+
45
+ TypeScript 6.0.3 compiles the v7.0 lib set with `skipLibCheck: false` and no
46
+ errors, and resolves `@typescript/lib-*` by the same package-name lookup
47
+ TypeScript 7 uses, so one bundle serves both compilers. Without the wider
48
+ declaration npm refuses to install it beside TypeScript 6.
49
+
50
+ ## 0.5.1
51
+
52
+ ### Patch Changes
53
+
54
+ - strict-ts-lib-scripts-common@0.0.1
55
+
56
+ ## 0.4.0
57
+
58
+ ### Minor Changes
59
+
60
+ - 931dc7c: Ship every built-in library inside one package instead of ~107 per flavor: install one tarball and map @typescript/lib-* to its libs/ directory with tsconfig paths
61
+
62
+ ## 0.3.0
63
+
64
+ ### Minor Changes
65
+
66
+ - 5ea9021: Stop `string & {}` from leaking into key types that are already `string`.
67
+
68
+ `Object.keys` and `Object.entries` open their key union with a `string & {}` arm
69
+ so that the declared keys still autocomplete while the excess keys a wider
70
+ object may carry are accepted. That arm only means something for a union of
71
+ string literals. Added to a key type that already contains `string` it produced
72
+ `string | (string & {})` — which _is_ `string`, just spelled in a way that then
73
+ showed up in everything computed from it.
74
+
75
+ The arm is now added only where it widens something (`WithOpenString`):
76
+
77
+ | expression | before | after |
78
+ | ---------------------------------------- | ------------------------------------------------------- | -------------------------- |
79
+ | `Object.keys(rec: Record<string, V>)` | `(string \| (string & {}))[]` | `string[]` |
80
+ | `Object.entries(rec: Record<string, V>)` | `(readonly [string, V] \| readonly [string & {}, V])[]` | `(readonly [string, V])[]` |
81
+ | `Object.keys(obj: { a: 1; b: 2 })` | `('a' \| 'b' \| (string & {}))[]` | unchanged |
82
+ | `Object.entries(obj: { a: 1; b: 2 })` | keeps the open arm | unchanged |
83
+
84
+ This also fixes `Object.fromEntries(Object.entries(rec).map(...))` on a record
85
+ keyed by an index signature. `PartialIfKeyIsUnion` wraps the result in `Partial`
86
+ when the key is a union, and the redundant arm made every key type a union — so
87
+ `Record<string, V>` came back as `Partial<Record<string | (string & {}), V>>`
88
+ and could not be assigned back to the record type it came from. With the arm
89
+ gone the key is plain `string`, which is not a union, so the result stays total.
90
+ Records with literal keys still get `Partial`, since entries genuinely may not
91
+ cover every declared key.
92
+
93
+ `PartialIfKeyIsUnion` itself is unchanged, as are hand-written entries arrays
94
+ and the fixed-length-tuple path.
95
+
96
+ ### Patch Changes
97
+
98
+ - 9e98b83: Fix `Set` / `Map` subclassing, tighten the collection constructors, and publish three lib files at the subpath TypeScript actually looks up.
99
+
100
+ - `SetConstructor.prototype` / `MapConstructor.prototype` were narrowed to
101
+ `Set<never>` / `Map<never, never>`, which made every `class X extends Set<T>`
102
+ and `class X extends Map<K, V>` fail with TS2417 — `prototype` is what the
103
+ `extends` clause checks a subclass's static side against. They are now the
104
+ `ReadonlySet<unknown>` / `ReadonlyMap<unknown, unknown>` form, matching how
105
+ `ArrayConstructor.prototype` is already declared. The protection against an
106
+ untyped `new Set()` / `new Map()` swallowing anything is unchanged: it comes
107
+ from the constructor overloads, not from `prototype`.
108
+ - `lib.es2015.symbol.wellknown`, `lib.es2016.array.include` and
109
+ `lib.es2020.symbol.wellknown` were published one directory level too deep
110
+ (`es2015/symbol/wellknown` instead of `es2015/symbol-wellknown`), a subpath
111
+ `libReplacement` never resolves — so consumers silently got the stock
112
+ declarations for those three libs. They now land where TypeScript looks.
113
+ - An untyped `new WeakSet()` / `new WeakMap()` no longer accepts every object.
114
+ Both now default to `never`, like `new Set()` / `new Map()` already did.
115
+ `new WeakSet<object>()` and `new WeakMap<object, number>()` keep working,
116
+ because the no-argument overload carries its own type parameters.
117
+ - `null` is no longer an accepted initializer for any of the four collection
118
+ constructors. Upstream allows `new Set(null)` because the runtime tolerates
119
+ it, but a `null` reaching a collection constructor is a bug at the call site
120
+ rather than an intentional "start empty" — `new Set()` says that already.
121
+ Passing a plain optional still works (`(xs?: readonly T[]) => new Set(xs)`);
122
+ code that types its own parameter as `... | null` and forwards it has to drop
123
+ the `| null`. **This is the one change here that can require a consumer edit.**
124
+ - `Temporal.PartialTemporalLike` no longer trips this lib's narrowed
125
+ `Exclude<T, U extends T>` (TS2344).
126
+
127
+ ## 0.2.0
128
+
129
+ ### Minor Changes
130
+
131
+ - c0c9f9d: Bump all packages (minor).
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md CHANGED
@@ -12,25 +12,30 @@ Every built-in library ships inside this one package, in two flavors:
12
12
  - `libs/` — plain `number`
13
13
  - `libs-branded/` — branded number types (`Uint8`, `SafeUint`, …)
14
14
 
15
- Pick one with `paths` in your `tsconfig.json`:
15
+ TypeScript 5.1 resolves `@typescript/lib-*` as ordinary
16
+ package names, through a fixed Node10 lookup — it does not read `paths`
17
+ for this. Run the linker this package ships to supply those names. It
18
+ creates one symlink per lib group under `node_modules/@typescript/`:
19
+
20
+ ```sh
21
+ npx strict-ts-lib-v5.1-link # plain `number`
22
+ npx strict-ts-lib-v5.1-link --branded # branded number types
23
+ ```
24
+
25
+ Add it to your own `package.json` so that a reinstall restores the links:
16
26
 
17
27
  ```jsonc
18
28
  {
19
- "compilerOptions": {
20
- "libReplacement": true, // TypeScript 6.0 and later
21
- "paths": {
22
- "@typescript/lib-*": ["./node_modules/strict-ts-lib-v5.1/libs/*"],
23
- },
29
+ "scripts": {
30
+ "prepare": "strict-ts-lib-v5.1-link",
24
31
  },
25
32
  }
26
33
  ```
27
34
 
28
- Two things to watch, because both fail silently — the replacement simply
29
- does not happen, with no error:
35
+ Nothing goes in `tsconfig.json`: the lookup is unconditional at
36
+ TypeScript 5.1, where `libReplacement` is not yet a known
37
+ option — setting it is an error.
30
38
 
31
- - **`paths` is replaced, not merged, by a config that `extends` another**,
32
- so it has to be written in whichever config TypeScript actually loads.
33
- - **The path is relative to the config that contains it**, which in a
34
- monorepo package is usually `../../node_modules/…`.
39
+ `--unlink` removes the links again.
35
40
 
36
- See <https://github.com/noshiro-pf/strict-typescript-lib> for usage and version support.
41
+ See <https://github.com/noshiro-pf/mono> for usage and version support.
@@ -33282,10 +33282,7 @@ interface MathMLElementTagNameMap {
33282
33282
  type ElementTagNameMap = HTMLElementTagNameMap &
33283
33283
  Pick<
33284
33284
  SVGElementTagNameMap,
33285
- import('ts-type-forge').RelaxedExclude<
33286
- keyof SVGElementTagNameMap,
33287
- keyof HTMLElementTagNameMap
33288
- >
33285
+ Exclude<keyof SVGElementTagNameMap, keyof HTMLElementTagNameMap>
33289
33286
  >;
33290
33287
 
33291
33288
  declare const Audio: {
@@ -46,8 +46,7 @@ declare namespace StrictLibInternals {
46
46
  ToStr<keyof PickByValue<R, R[K]>>,
47
47
  R[K],
48
48
  ];
49
- // eslint-disable-next-line @typescript-eslint/no-restricted-types
50
- }[import('ts-type-forge').RelaxedExclude<keyof R, symbol>]
49
+ }[Exclude<keyof R, symbol>]
51
50
  )[]
52
51
  : never;
53
52
  }
@@ -1859,7 +1859,7 @@ type Record<K extends PropertyKey, T> = {
1859
1859
  /**
1860
1860
  * Exclude from T those types that are assignable to U
1861
1861
  */
1862
- type Exclude<T, U extends T> = T extends U ? never : T;
1862
+ type Exclude<T, U> = T extends U ? never : T;
1863
1863
 
1864
1864
  /**
1865
1865
  * Extract from T those types that are assignable to U
@@ -1869,7 +1869,7 @@ type Extract<T, U> = T extends U ? T : never;
1869
1869
  /**
1870
1870
  * Construct a type with the properties of T except for those in type K.
1871
1871
  */
1872
- type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
1872
+ type Omit<T, K extends PropertyKey> = Pick<T, Exclude<keyof T, K>>;
1873
1873
 
1874
1874
  /**
1875
1875
  * Exclude null and undefined from T
@@ -33289,10 +33289,7 @@ interface MathMLElementTagNameMap {
33289
33289
  type ElementTagNameMap = HTMLElementTagNameMap &
33290
33290
  Pick<
33291
33291
  SVGElementTagNameMap,
33292
- import('ts-type-forge').RelaxedExclude<
33293
- keyof SVGElementTagNameMap,
33294
- keyof HTMLElementTagNameMap
33295
- >
33292
+ Exclude<keyof SVGElementTagNameMap, keyof HTMLElementTagNameMap>
33296
33293
  >;
33297
33294
 
33298
33295
  declare const Audio: {
@@ -46,8 +46,7 @@ declare namespace StrictLibInternals {
46
46
  ToStr<keyof PickByValue<R, R[K]>>,
47
47
  R[K],
48
48
  ];
49
- // eslint-disable-next-line @typescript-eslint/no-restricted-types
50
- }[import('ts-type-forge').RelaxedExclude<keyof R, symbol>]
49
+ }[Exclude<keyof R, symbol>]
51
50
  )[]
52
51
  : never;
53
52
  }
@@ -2014,7 +2014,7 @@ type Record<K extends PropertyKey, T> = {
2014
2014
  /**
2015
2015
  * Exclude from T those types that are assignable to U
2016
2016
  */
2017
- type Exclude<T, U extends T> = T extends U ? never : T;
2017
+ type Exclude<T, U> = T extends U ? never : T;
2018
2018
 
2019
2019
  /**
2020
2020
  * Extract from T those types that are assignable to U
@@ -2024,7 +2024,7 @@ type Extract<T, U> = T extends U ? T : never;
2024
2024
  /**
2025
2025
  * Construct a type with the properties of T except for those in type K.
2026
2026
  */
2027
- type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
2027
+ type Omit<T, K extends PropertyKey> = Pick<T, Exclude<keyof T, K>>;
2028
2028
 
2029
2029
  /**
2030
2030
  * Exclude null and undefined from T
package/link-libs.mjs ADDED
@@ -0,0 +1,206 @@
1
+ #!/usr/bin/env node
2
+ // Copied verbatim into every published bundle by `gen-packages.mts`, and run
3
+ // by consumers as `npx <package>-link`. Plain JavaScript with no dependencies,
4
+ // because it runs from inside `node_modules` in someone else's project.
5
+ //
6
+ // WHAT IT IS FOR
7
+ //
8
+ // TypeScript resolves a lib replacement in one of two ways, and which one
9
+ // depends on the version — they are exclusive, both measured:
10
+ //
11
+ // - TypeScript 7 reads `paths`, and no longer looks `@typescript/lib-*` up
12
+ // by name. Those consumers need no linking; the README's `paths` entry is
13
+ // the whole setup.
14
+ // - TypeScript 6 and earlier ignore `paths` here and resolve
15
+ // `@typescript/lib-<group>` as an ordinary package name, through a fixed
16
+ // Node10 lookup. A single package shipping every lib as a subdirectory has
17
+ // no name for them to find.
18
+ //
19
+ // This script supplies those names: one symlink per lib group, from
20
+ // `node_modules/@typescript/lib-<group>` to this package's `libs/<group>`.
21
+ // A directory holding an `index.d.ts` resolves without a manifest of its own,
22
+ // so nothing else has to ship.
23
+ //
24
+ // USAGE
25
+ //
26
+ // npx <package>-link link the plain-number flavor
27
+ // npx <package>-link --branded link the branded flavor
28
+ // npx <package>-link --dir <path> treat <path> as the project root
29
+ // npx <package>-link --unlink remove the links again
30
+ //
31
+ // Add it to your own `package.json` so a reinstall restores the links:
32
+ //
33
+ // { "scripts": { "prepare": "<package>-link" } }
34
+
35
+ import * as fs from 'node:fs/promises';
36
+ import * as path from 'node:path';
37
+ import { fileURLToPath } from 'node:url';
38
+
39
+ const SCOPE = '@typescript';
40
+
41
+ const main = async () => {
42
+ const options = parseArgs(process.argv.slice(2));
43
+
44
+ const packageDir = path.dirname(fileURLToPath(import.meta.url));
45
+
46
+ const packageName = await readPackageName(packageDir);
47
+
48
+ const flavor = options.branded ? 'libs-branded' : 'libs';
49
+
50
+ const libsDir = path.join(packageDir, flavor);
51
+
52
+ const groups = await readGroups(libsDir);
53
+
54
+ if (groups.length === 0) {
55
+ throw new Error(`No lib groups found in ${libsDir}.`);
56
+ }
57
+
58
+ const scopeDir = path.join(
59
+ await resolveNodeModules(options.dir, packageDir, packageName),
60
+ SCOPE,
61
+ );
62
+
63
+ await fs.mkdir(scopeDir, { recursive: true });
64
+
65
+ for (const group of groups) {
66
+ const linkPath = path.join(scopeDir, `lib-${group}`);
67
+
68
+ await removeIfPresent(linkPath);
69
+
70
+ if (options.unlink) continue;
71
+
72
+ // Relative on POSIX so the tree stays portable; a Windows junction is
73
+ // the only kind of directory link an unprivileged user can make, and it
74
+ // takes an absolute target.
75
+ const target =
76
+ process.platform === 'win32'
77
+ ? path.join(packageDir, flavor, group)
78
+ : path.join('..', packageName, flavor, group);
79
+
80
+ await fs.symlink(
81
+ target,
82
+ linkPath,
83
+ process.platform === 'win32' ? 'junction' : 'dir',
84
+ );
85
+
86
+ // A dangling link is the one failure mode that would look like success:
87
+ // TypeScript falls back to its own declarations without saying anything.
88
+ if (!(await exists(linkPath))) {
89
+ throw new Error(
90
+ `${linkPath} -> ${target} does not resolve. Is ${packageName} installed in this project?`,
91
+ );
92
+ }
93
+ }
94
+
95
+ console.info(
96
+ options.unlink
97
+ ? `Removed ${groups.length} ${SCOPE}/lib-* links from ${scopeDir}.`
98
+ : `Linked ${groups.length} ${SCOPE}/lib-* to ${packageName}/${flavor} in ${scopeDir}.`,
99
+ );
100
+ };
101
+
102
+ const parseArgs = (argv) => {
103
+ const dirIndex = argv.indexOf('--dir');
104
+
105
+ return {
106
+ branded: argv.includes('--branded'),
107
+ unlink: argv.includes('--unlink'),
108
+ dir: dirIndex === -1 ? undefined : argv[dirIndex + 1],
109
+ };
110
+ };
111
+
112
+ /**
113
+ * The `node_modules` to link into: the one this package was installed in.
114
+ *
115
+ * Not "the nearest `node_modules` above the working directory" — in a
116
+ * monorepo that finds the workspace root, and the links land next to a copy
117
+ * of this package that is not there, which the caller then has to notice.
118
+ * The anchor is the package itself:
119
+ *
120
+ * 1. `--dir` wins outright.
121
+ * 2. If this file sits directly under a `node_modules`, that is the answer.
122
+ * npm and yarn install that way.
123
+ * 3. pnpm does not — the real path is inside `.pnpm`, reached through a
124
+ * symlink — so walk up from the working directory for the first project
125
+ * whose `node_modules` holds this package by name.
126
+ */
127
+ const resolveNodeModules = async (explicitDir, packageDir, packageName) => {
128
+ if (explicitDir !== undefined) {
129
+ return path.resolve(explicitDir, 'node_modules');
130
+ }
131
+
132
+ const parent = path.dirname(packageDir);
133
+
134
+ if (
135
+ path.basename(parent) === 'node_modules' &&
136
+ !parent.split(path.sep).includes('.pnpm')
137
+ ) {
138
+ return parent;
139
+ }
140
+
141
+ let mut_dir = process.cwd();
142
+
143
+ for (;;) {
144
+ const candidate = path.join(mut_dir, 'node_modules');
145
+
146
+ if (await exists(path.join(candidate, packageName))) return candidate;
147
+
148
+ const next = path.dirname(mut_dir);
149
+
150
+ if (next === mut_dir) {
151
+ throw new Error(
152
+ `Could not find a project with ${packageName} installed, starting from ${process.cwd()}. Run this from that project, or pass --dir <path>.`,
153
+ );
154
+ }
155
+
156
+ mut_dir = next;
157
+ }
158
+ };
159
+
160
+ const readGroups = async (libsDir) => {
161
+ const entries = await fs.readdir(libsDir, { withFileTypes: true });
162
+
163
+ return entries
164
+ .filter((entry) => entry.isDirectory())
165
+ .map((entry) => entry.name)
166
+ .sort();
167
+ };
168
+
169
+ const readPackageName = async (packageDir) => {
170
+ const raw = await fs.readFile(path.join(packageDir, 'package.json'), 'utf8');
171
+
172
+ const name = JSON.parse(raw).name;
173
+
174
+ if (typeof name !== 'string') {
175
+ throw new Error(`No name in ${packageDir}/package.json.`);
176
+ }
177
+
178
+ return name;
179
+ };
180
+
181
+ /**
182
+ * Only a symlink is removed. A real directory at `@typescript/lib-<group>` is
183
+ * someone else's package, and silently deleting it would be worse than
184
+ * failing.
185
+ */
186
+ const removeIfPresent = async (linkPath) => {
187
+ const stats = await fs.lstat(linkPath).catch(() => undefined);
188
+
189
+ if (stats === undefined) return;
190
+
191
+ if (!stats.isSymbolicLink()) {
192
+ throw new Error(
193
+ `${linkPath} exists and is not a symlink; refusing to replace it.`,
194
+ );
195
+ }
196
+
197
+ await fs.unlink(linkPath);
198
+ };
199
+
200
+ const exists = async (target) =>
201
+ await fs.access(target).then(
202
+ () => true,
203
+ () => false,
204
+ );
205
+
206
+ await main();
package/package.json CHANGED
@@ -1,18 +1,23 @@
1
1
  {
2
2
  "name": "strict-ts-lib-v5.1",
3
- "version": "0.5.0",
3
+ "version": "0.6.0",
4
4
  "private": false,
5
5
  "description": "Strict TypeScript 5.1.6 standard library (all libs in one package)",
6
6
  "license": "Apache-2.0",
7
7
  "author": "noshiro-pf <noshiro.pf@gmail.com>",
8
8
  "repository": {
9
9
  "type": "git",
10
- "url": "https://github.com/noshiro-pf/strict-typescript-lib.git"
10
+ "url": "https://github.com/noshiro-pf/mono.git"
11
+ },
12
+ "bin": {
13
+ "strict-ts-lib-v5.1-link": "./link-libs.mjs"
11
14
  },
12
15
  "files": [
13
16
  "libs",
14
17
  "libs-branded",
15
- "!libs/**/package.json"
18
+ "!libs/**/package.json",
19
+ "link-libs.mjs",
20
+ "CHANGELOG.md"
16
21
  ],
17
22
  "type": "module",
18
23
  "sideEffects": false,
@@ -22,4 +27,4 @@
22
27
  "peerDependencies": {
23
28
  "typescript": ">=5.1.0 <5.2.0"
24
29
  }
25
- }
30
+ }