@systemfsoftware/tsdown-config 0.0.0-stage → 0.1.2
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 +5 -0
- package/LICENSE +203 -0
- package/README.md +51 -2
- package/package.json +57 -3
- package/src/api-extractor-quiet.js +99 -0
- package/src/eager-entry-budget.d.mts +29 -0
- package/src/eager-entry-budget.mjs +67 -0
- package/src/quiet-build.d.ts +8 -0
- package/src/quiet-build.js +38 -0
package/CHANGELOG.md
ADDED
package/LICENSE
ADDED
|
@@ -0,0 +1,203 @@
|
|
|
1
|
+
Copyright (c) 2026 Ryan Lee (systemfsoftware)
|
|
2
|
+
|
|
3
|
+
Apache License
|
|
4
|
+
Version 2.0, January 2004
|
|
5
|
+
http://www.apache.org/licenses/
|
|
6
|
+
|
|
7
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
8
|
+
|
|
9
|
+
1. Definitions.
|
|
10
|
+
|
|
11
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
12
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
13
|
+
|
|
14
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
15
|
+
the copyright owner that is granting the License.
|
|
16
|
+
|
|
17
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
18
|
+
other entities that control, are controlled by, or are under common
|
|
19
|
+
control with that entity. For the purposes of this definition,
|
|
20
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
21
|
+
direction or management of such entity, whether by contract or
|
|
22
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
23
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
24
|
+
|
|
25
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
26
|
+
exercising permissions granted by this License.
|
|
27
|
+
|
|
28
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
29
|
+
including but not limited to software source code, documentation
|
|
30
|
+
source, and configuration files.
|
|
31
|
+
|
|
32
|
+
"Object" form shall mean any form resulting from mechanical
|
|
33
|
+
transformation or translation of a Source form, including but
|
|
34
|
+
not limited to compiled object code, generated documentation,
|
|
35
|
+
and conversions to other media types.
|
|
36
|
+
|
|
37
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
38
|
+
Object form, made available under the License, as indicated by a
|
|
39
|
+
copyright notice that is included in or attached to the work
|
|
40
|
+
(an example is provided in the Appendix below).
|
|
41
|
+
|
|
42
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
43
|
+
form, that is based on (or derived from) the Work and for which the
|
|
44
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
45
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
46
|
+
of this License, Derivative Works shall not include works that remain
|
|
47
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
48
|
+
the Work and Derivative Works thereof.
|
|
49
|
+
|
|
50
|
+
"Contribution" shall mean any work of authorship, including
|
|
51
|
+
the original version of the Work and any modifications or additions
|
|
52
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
53
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
54
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
55
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
56
|
+
means any form of electronic, verbal, or written communication sent
|
|
57
|
+
to the Licensor or its representatives, including but not limited to
|
|
58
|
+
communication on electronic mailing lists, source code control systems,
|
|
59
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
60
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
61
|
+
excluding communication that is conspicuously marked or otherwise
|
|
62
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
63
|
+
|
|
64
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
65
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
66
|
+
subsequently incorporated within the Work.
|
|
67
|
+
|
|
68
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
69
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
70
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
71
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
72
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
73
|
+
Work and such Derivative Works in Source or Object form.
|
|
74
|
+
|
|
75
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
76
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
77
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
78
|
+
(except as stated in this section) patent license to make, have made,
|
|
79
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
80
|
+
where such license applies only to those patent claims licensable
|
|
81
|
+
by such Contributor that are necessarily infringed by their
|
|
82
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
83
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
84
|
+
institute patent litigation against any entity (including a
|
|
85
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
86
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
87
|
+
or contributory patent infringement, then any patent licenses
|
|
88
|
+
granted to You under this License for that Work shall terminate
|
|
89
|
+
as of the date such litigation is filed.
|
|
90
|
+
|
|
91
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
92
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
93
|
+
modifications, and in Source or Object form, provided that You
|
|
94
|
+
meet the following conditions:
|
|
95
|
+
|
|
96
|
+
(a) You must give any other recipients of the Work or
|
|
97
|
+
Derivative Works a copy of this License; and
|
|
98
|
+
|
|
99
|
+
(b) You must cause any modified files to carry prominent notices
|
|
100
|
+
stating that You changed the files; and
|
|
101
|
+
|
|
102
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
103
|
+
that You distribute, all copyright, patent, trademark, and
|
|
104
|
+
attribution notices from the Source form of the Work,
|
|
105
|
+
excluding those notices that do not pertain to any part of
|
|
106
|
+
the Derivative Works; and
|
|
107
|
+
|
|
108
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
109
|
+
distribution, then any Derivative Works that You distribute must
|
|
110
|
+
include a readable copy of the attribution notices contained
|
|
111
|
+
within such NOTICE file, excluding those notices that do not
|
|
112
|
+
pertain to any part of the Derivative Works, in at least one
|
|
113
|
+
of the following places: within a NOTICE text file distributed
|
|
114
|
+
as part of the Derivative Works; within the Source form or
|
|
115
|
+
documentation, if provided along with the Derivative Works; or,
|
|
116
|
+
within a display generated by the Derivative Works, if and
|
|
117
|
+
wherever such third-party notices normally appear. The contents
|
|
118
|
+
of the NOTICE file are for informational purposes only and
|
|
119
|
+
do not modify the License. You may add Your own attribution
|
|
120
|
+
notices within Derivative Works that You distribute, alongside
|
|
121
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
122
|
+
that such additional attribution notices cannot be construed
|
|
123
|
+
as modifying the License.
|
|
124
|
+
|
|
125
|
+
You may add Your own copyright statement to Your modifications and
|
|
126
|
+
may provide additional or different license terms and conditions
|
|
127
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
128
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
129
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
130
|
+
the conditions stated in this License.
|
|
131
|
+
|
|
132
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
133
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
134
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
135
|
+
this License, without any additional terms or conditions.
|
|
136
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
137
|
+
the terms of any separate license agreement you may have executed
|
|
138
|
+
with Licensor regarding such Contributions.
|
|
139
|
+
|
|
140
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
141
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
142
|
+
except as required for reasonable and customary use in describing the
|
|
143
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
144
|
+
|
|
145
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
146
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
147
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
148
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
149
|
+
implied, including, without limitation, any warranties or conditions
|
|
150
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
151
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
152
|
+
appropriateness of using or redistributing the Work and assume any
|
|
153
|
+
risks associated with Your exercise of permissions under this License.
|
|
154
|
+
|
|
155
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
156
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
157
|
+
unless required by applicable law (such as deliberate and grossly
|
|
158
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
159
|
+
liable to You for damages, including any direct, indirect, special,
|
|
160
|
+
incidental, or consequential damages of any character arising as a
|
|
161
|
+
result of this License or out of the use or inability to use the
|
|
162
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
163
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
164
|
+
other commercial damages or losses), even if such Contributor
|
|
165
|
+
has been advised of the possibility of such damages.
|
|
166
|
+
|
|
167
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
168
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
169
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
170
|
+
or other liability obligations and/or rights consistent with this
|
|
171
|
+
License. However, in accepting such obligations, You may act only
|
|
172
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
173
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
174
|
+
defend, and hold each Contributor harmless for any liability
|
|
175
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
176
|
+
of your accepting any such warranty or additional liability.
|
|
177
|
+
|
|
178
|
+
END OF TERMS AND CONDITIONS
|
|
179
|
+
|
|
180
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
181
|
+
|
|
182
|
+
To apply the Apache License to your work, attach the following
|
|
183
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
184
|
+
replaced with your own identifying information. (Don't include
|
|
185
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
186
|
+
comment syntax for the file format. We also recommend that a
|
|
187
|
+
file or class name and description of purpose be included on the
|
|
188
|
+
same "printed page" as the copyright notice for easier
|
|
189
|
+
identification within third-party archives.
|
|
190
|
+
|
|
191
|
+
Copyright 2026 Ryan Lee (systemfsoftware)
|
|
192
|
+
|
|
193
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
194
|
+
you may not use this file except in compliance with the License.
|
|
195
|
+
You may obtain a copy of the License at
|
|
196
|
+
|
|
197
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
198
|
+
|
|
199
|
+
Unless required by applicable law or agreed to in writing, software
|
|
200
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
201
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
202
|
+
See the License for the specific language governing permissions and
|
|
203
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,3 +1,52 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @systemfsoftware/tsdown-config
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Build-output policy and build guards shared by System F Software's tsdown packages: a quiet log level that keeps every actionable warning, an entry-size budget for startup-sensitive plugins, and an `api-extractor` wrapper that drops its success chatter.
|
|
4
|
+
|
|
5
|
+
Every entry is plain JavaScript with declaration files, so it loads from `node_modules` under Node 24 without type stripping.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
Add the package as a devDependency. It is distributed as a workspace tarball of the [systemfsoftware flake](https://github.com/systemfsoftware/systemfsoftware) (`packages.<system>.tsdown-config`), which `lib.mkConsumerStore` serves to an offline pnpm install.
|
|
10
|
+
|
|
11
|
+
| Peer | Needed for |
|
|
12
|
+
| ------------------------------------ | -------------------------------------------------------------- |
|
|
13
|
+
| `tsdown` `^0.23.0` | `quiet-build` and `eager-entry-budget` in a `tsdown.config.ts` |
|
|
14
|
+
| `@microsoft/api-extractor` `^7.59.1` | the `api-extractor-quiet` bin |
|
|
15
|
+
|
|
16
|
+
Both peers are optional: install the one for the entry you use.
|
|
17
|
+
|
|
18
|
+
## Usage
|
|
19
|
+
|
|
20
|
+
### `quiet-build`
|
|
21
|
+
|
|
22
|
+
Spread it into the config and build with `tsdown -l warn`. The CLI flag silences the startup banner, which is printed before the config loads; `quietBuild` drops the one non-actionable `rolldown-plugin-dts` warning about TypeScript 7's API and leaves every other warning in place.
|
|
23
|
+
|
|
24
|
+
```ts
|
|
25
|
+
// tsdown.config.ts
|
|
26
|
+
import { quietBuild } from '@systemfsoftware/tsdown-config/quiet-build'
|
|
27
|
+
import { defineConfig } from 'tsdown'
|
|
28
|
+
|
|
29
|
+
export default defineConfig({ ...quietBuild, entry: ['src/index.ts'] })
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
### `eager-entry-budget`
|
|
33
|
+
|
|
34
|
+
A rolldown plugin that fails the build when an `index.js` entry statically pulls more than `maxBytes` (default 32 KiB), or leaves `effect` external. Dynamic imports are not counted.
|
|
35
|
+
|
|
36
|
+
```ts
|
|
37
|
+
import { eagerEntryBudget } from '@systemfsoftware/tsdown-config/eager-entry-budget'
|
|
38
|
+
|
|
39
|
+
export default defineConfig({ entry: ['src/index.ts'], plugins: [eagerEntryBudget({ maxBytes: 64 * 1024 })] })
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### `api-extractor-quiet`
|
|
43
|
+
|
|
44
|
+
Runs the `api-extractor` your package resolves from its own `node_modules/.bin`, forwards stderr, and drops only the lines API Extractor prints on success. A non-zero exit prints the full output unfiltered.
|
|
45
|
+
|
|
46
|
+
```json
|
|
47
|
+
{ "scripts": { "api:check": "api-extractor-quiet run" } }
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## License
|
|
51
|
+
|
|
52
|
+
[Apache-2.0](./LICENSE)
|
package/package.json
CHANGED
|
@@ -1,6 +1,60 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@systemfsoftware/tsdown-config",
|
|
3
|
-
"
|
|
4
|
-
"
|
|
5
|
-
"
|
|
3
|
+
"license": "Apache-2.0",
|
|
4
|
+
"version": "0.1.2",
|
|
5
|
+
"author": "Ryan Lee <drdgvhbh@gmail.com>",
|
|
6
|
+
"type": "module",
|
|
7
|
+
"exports": {
|
|
8
|
+
"./package.json": "./package.json",
|
|
9
|
+
"./eager-entry-budget": {
|
|
10
|
+
"types": "./src/eager-entry-budget.d.mts",
|
|
11
|
+
"default": "./src/eager-entry-budget.mjs"
|
|
12
|
+
},
|
|
13
|
+
"./quiet-build": {
|
|
14
|
+
"types": "./src/quiet-build.d.ts",
|
|
15
|
+
"default": "./src/quiet-build.js"
|
|
16
|
+
}
|
|
17
|
+
},
|
|
18
|
+
"bin": {
|
|
19
|
+
"api-extractor-quiet": "./src/api-extractor-quiet.js"
|
|
20
|
+
},
|
|
21
|
+
"files": [
|
|
22
|
+
"src"
|
|
23
|
+
],
|
|
24
|
+
"publishConfig": {
|
|
25
|
+
"access": "public",
|
|
26
|
+
"provenance": true
|
|
27
|
+
},
|
|
28
|
+
"peerDependencies": {
|
|
29
|
+
"@microsoft/api-extractor": "^7.59.4",
|
|
30
|
+
"tsdown": "^0.23.0"
|
|
31
|
+
},
|
|
32
|
+
"peerDependenciesMeta": {
|
|
33
|
+
"@microsoft/api-extractor": {
|
|
34
|
+
"optional": true
|
|
35
|
+
},
|
|
36
|
+
"tsdown": {
|
|
37
|
+
"optional": true
|
|
38
|
+
}
|
|
39
|
+
},
|
|
40
|
+
"devDependencies": {
|
|
41
|
+
"@microsoft/api-extractor": "^7.59.4",
|
|
42
|
+
"@systemfsoftware/arethetypeswrong-cli": "^4.2.0",
|
|
43
|
+
"@systemfsoftware/tsconfig": "^2.1.0",
|
|
44
|
+
"@systemfsoftware/vitest-config": "^0.1.3",
|
|
45
|
+
"@types/node": "^26.6.5",
|
|
46
|
+
"tsdown": "^0.23.0",
|
|
47
|
+
"vitest": "^5.1.0"
|
|
48
|
+
},
|
|
49
|
+
"repository": {
|
|
50
|
+
"type": "git",
|
|
51
|
+
"url": "git+https://github.com/systemfsoftware/systemfsoftware.git",
|
|
52
|
+
"directory": "packages/toolchain/tsdown-config"
|
|
53
|
+
},
|
|
54
|
+
"homepage": "https://github.com/systemfsoftware/systemfsoftware/tree/main/packages/toolchain/tsdown-config#readme",
|
|
55
|
+
"scripts": {
|
|
56
|
+
"typecheck": "tsc -b",
|
|
57
|
+
"test": "vitest run",
|
|
58
|
+
"attw": "attw --pack ."
|
|
59
|
+
}
|
|
6
60
|
}
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
// api-extractor-quiet.js — run API Extractor with its success chatter dropped.
|
|
3
|
+
//
|
|
4
|
+
// API Extractor has no quiet mode: `run` always prints a version banner, the
|
|
5
|
+
// config path it guessed, the TypeScript engine it picked, and a "completed
|
|
6
|
+
// successfully" footer. Across 30 packages that is ~150 log lines per cold
|
|
7
|
+
// build carrying no information — the only facts that matter are the
|
|
8
|
+
// diagnostics and the exit code.
|
|
9
|
+
//
|
|
10
|
+
// This runs whatever `api-extractor` the calling package resolved (its own
|
|
11
|
+
// node_modules/.bin, so the pinned version is unchanged), forwards stderr
|
|
12
|
+
// untouched, and drops exactly the known-success lines from stdout. Any other
|
|
13
|
+
// line — warnings, errors, the "completed with warnings/errors" footer — is
|
|
14
|
+
// printed verbatim. On a non-zero exit the full output is printed instead, so a
|
|
15
|
+
// failure is never filtered into silence.
|
|
16
|
+
//
|
|
17
|
+
// It ships as a package `bin`, so pnpm links it into every consumer's
|
|
18
|
+
// node_modules/.bin and the package scripts call it by name. The pnpm shim
|
|
19
|
+
// execs `node <this file>`, which is why it is plain JavaScript with no Deno
|
|
20
|
+
// APIs and no dependencies: Node refuses to strip types from a file under
|
|
21
|
+
// node_modules, so a TypeScript bin would fail for every installed consumer.
|
|
22
|
+
|
|
23
|
+
import { spawnSync } from 'node:child_process'
|
|
24
|
+
import { existsSync } from 'node:fs'
|
|
25
|
+
import { dirname, join } from 'node:path'
|
|
26
|
+
|
|
27
|
+
const EXE = process.platform === 'win32' ? 'api-extractor.cmd' : 'api-extractor'
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* Lines API Extractor prints on every successful run, and only on success.
|
|
31
|
+
* @type {readonly RegExp[]}
|
|
32
|
+
*/
|
|
33
|
+
const SUCCESS_LINES = [
|
|
34
|
+
/^api-extractor\s+\d+\.\d+\.\d+.*api-extractor\.com\/?$/u,
|
|
35
|
+
/^Using configuration from .+$/u,
|
|
36
|
+
/^Analysis will use the bundled TypeScript version .+$/u,
|
|
37
|
+
/^API Extractor completed successfully$/u,
|
|
38
|
+
]
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* Strip SGR color codes so a colored banner still matches its pattern.
|
|
42
|
+
* @param {string} line
|
|
43
|
+
*/
|
|
44
|
+
const stripAnsi = (line) => line.replaceAll(/\u001B\[[0-9;]*m/gu, '')
|
|
45
|
+
|
|
46
|
+
/**
|
|
47
|
+
* Walk up from `start` looking for the package-local binary shim.
|
|
48
|
+
* @param {string} start
|
|
49
|
+
* @returns {string | null}
|
|
50
|
+
*/
|
|
51
|
+
const resolveReal = (start) => {
|
|
52
|
+
let dir = start
|
|
53
|
+
while (true) {
|
|
54
|
+
const candidate = join(dir, 'node_modules', '.bin', EXE)
|
|
55
|
+
if (existsSync(candidate)) return candidate
|
|
56
|
+
const parent = dirname(dir)
|
|
57
|
+
if (parent === dir) return null
|
|
58
|
+
dir = parent
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
// The calling package is where `api:check` runs, so that is where its pinned
|
|
63
|
+
// `api-extractor` lives: pnpm links it into the package's own node_modules.
|
|
64
|
+
const real = resolveReal(process.cwd())
|
|
65
|
+
|
|
66
|
+
if (real === null) {
|
|
67
|
+
console.error(
|
|
68
|
+
`api-extractor-quiet: no ${EXE} found from ${process.cwd()} upward; ` +
|
|
69
|
+
'the package must depend on @microsoft/api-extractor',
|
|
70
|
+
)
|
|
71
|
+
process.exit(1)
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
const result = spawnSync(real, process.argv.slice(2), {
|
|
75
|
+
encoding: 'utf8',
|
|
76
|
+
stdio: ['inherit', 'pipe', 'inherit'],
|
|
77
|
+
env: { ...process.env, PATH: `${dirname(real)}:${process.env['PATH'] ?? ''}` },
|
|
78
|
+
})
|
|
79
|
+
|
|
80
|
+
const exitCode = result.status ?? 1
|
|
81
|
+
const raw = result.stdout ?? ''
|
|
82
|
+
|
|
83
|
+
if (exitCode !== 0) {
|
|
84
|
+
// A failure is exactly what the run is for: print everything, unfiltered.
|
|
85
|
+
process.stdout.write(raw)
|
|
86
|
+
process.exit(exitCode)
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
const kept = raw
|
|
90
|
+
.split('\n')
|
|
91
|
+
.filter((line) => {
|
|
92
|
+
if (line.trim() === '') return false
|
|
93
|
+
const plain = stripAnsi(line).trimEnd()
|
|
94
|
+
return !SUCCESS_LINES.some((pattern) => pattern.test(plain))
|
|
95
|
+
})
|
|
96
|
+
.join('\n')
|
|
97
|
+
.trimEnd()
|
|
98
|
+
|
|
99
|
+
if (kept !== '') process.stdout.write(`${kept}\n`)
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/** A rolldown output chunk, as far as the budget reads it. */
|
|
2
|
+
export interface BudgetedChunk {
|
|
3
|
+
readonly type: 'chunk'
|
|
4
|
+
readonly fileName: string
|
|
5
|
+
readonly isEntry: boolean
|
|
6
|
+
readonly imports: readonly string[]
|
|
7
|
+
readonly code: string
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
/** Any other rolldown output file; the budget skips it. */
|
|
11
|
+
export interface BudgetedAsset {
|
|
12
|
+
readonly type: 'asset'
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
/** The rolldown plugin `eagerEntryBudget` returns. */
|
|
16
|
+
export interface EagerEntryBudgetPlugin {
|
|
17
|
+
readonly name: 'omp-eager-entry-budget'
|
|
18
|
+
generateBundle(
|
|
19
|
+
this: { error(message: string): never },
|
|
20
|
+
options: unknown,
|
|
21
|
+
bundle: Readonly<Record<string, BudgetedChunk | BudgetedAsset>>,
|
|
22
|
+
): void
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* Fails the build when an omp plugin entry's static closure exceeds `maxBytes`
|
|
27
|
+
* (default 32 KiB) or leaves `effect` external.
|
|
28
|
+
*/
|
|
29
|
+
export declare function eagerEntryBudget(options?: { readonly maxBytes?: number }): EagerEntryBudgetPlugin
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
const FORBIDDEN_EXTERNAL = /^(effect|@effect\/)/
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Fails the build when an omp plugin entry would cost too much at startup.
|
|
5
|
+
*
|
|
6
|
+
* The host awaits `import(entry)` and runs a scoped Bun `onLoad` hook over every
|
|
7
|
+
* module in the graph, so startup pays for the entry's *static* closure only —
|
|
8
|
+
* dynamic imports are deferred and deliberately not counted. Two ways to blow it:
|
|
9
|
+
* leaving `effect` external (~400 unbundled modules, measured ~30s), or statically
|
|
10
|
+
* reaching a heavy chunk from the entry (e.g. importing a barrel).
|
|
11
|
+
*
|
|
12
|
+
* Its consumer-facing types live in `eager-entry-budget.d.mts`; the JSDoc here
|
|
13
|
+
* borrows them, so the two cannot drift apart unnoticed.
|
|
14
|
+
*
|
|
15
|
+
* @param {{ readonly maxBytes?: number }} [options]
|
|
16
|
+
* @returns {import('./eager-entry-budget.mjs').EagerEntryBudgetPlugin}
|
|
17
|
+
*/
|
|
18
|
+
export function eagerEntryBudget({ maxBytes = 32 * 1024 } = {}) {
|
|
19
|
+
return {
|
|
20
|
+
name: 'omp-eager-entry-budget',
|
|
21
|
+
generateBundle(_options, bundle) {
|
|
22
|
+
const chunks = Object.values(bundle).filter(
|
|
23
|
+
/** @returns {c is import('./eager-entry-budget.mjs').BudgetedChunk} */ (c) => c.type === 'chunk',
|
|
24
|
+
)
|
|
25
|
+
const entries = chunks.filter((c) => c.isEntry && /(?:^|\/)index\.js$/.test(c.fileName))
|
|
26
|
+
|
|
27
|
+
if (entries.length === 0) return
|
|
28
|
+
|
|
29
|
+
/** @type {Set<string>} */
|
|
30
|
+
const externals = new Set()
|
|
31
|
+
for (const chunk of chunks) {
|
|
32
|
+
for (const specifier of chunk.imports) {
|
|
33
|
+
if (!bundle[specifier] && FORBIDDEN_EXTERNAL.test(specifier)) externals.add(specifier)
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
if (externals.size > 0) {
|
|
37
|
+
this.error(
|
|
38
|
+
`[omp] externalized ${[...externals].sort().join(', ')} — the host taxes every module in ` +
|
|
39
|
+
`the graph, so these must be bundled via deps.alwaysBundle in tsdown.config.ts`,
|
|
40
|
+
)
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
for (const entry of entries) {
|
|
44
|
+
/** @type {Set<string>} */
|
|
45
|
+
const seen = new Set()
|
|
46
|
+
let bytes = 0
|
|
47
|
+
/** @param {string} fileName */
|
|
48
|
+
const walk = (fileName) => {
|
|
49
|
+
if (seen.has(fileName)) return
|
|
50
|
+
const chunk = bundle[fileName]
|
|
51
|
+
if (!chunk || chunk.type !== 'chunk') return
|
|
52
|
+
seen.add(fileName)
|
|
53
|
+
bytes += Buffer.byteLength(chunk.code, 'utf8')
|
|
54
|
+
for (const next of chunk.imports) walk(next)
|
|
55
|
+
}
|
|
56
|
+
walk(entry.fileName)
|
|
57
|
+
|
|
58
|
+
if (bytes > maxBytes) {
|
|
59
|
+
this.error(
|
|
60
|
+
`[omp] ${entry.fileName} statically pulls ${bytes} bytes (budget ${maxBytes}) via ` +
|
|
61
|
+
`${[...seen].join(', ')} — this is paid on every startup; defer it behind a dynamic import`,
|
|
62
|
+
)
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
},
|
|
66
|
+
}
|
|
67
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Build-output policy shared by every tsdown config in the workspace.
|
|
3
|
+
*
|
|
4
|
+
* The build is the loudest step in the gate: 30 packages each print a tsdown
|
|
5
|
+
* banner, per-entry info, a size report, and — through `rolldown-plugin-dts` —
|
|
6
|
+
* one identical "TypeScript 7.0 does not yet have a stable API" warning. None
|
|
7
|
+
* of that is actionable. What *is* actionable (a real rolldown warning such as
|
|
8
|
+
* the `'use client'` module-directive notice) must still reach the log.
|
|
9
|
+
*
|
|
10
|
+
* This is a config fragment, not a script: each `tsdown.config.ts` spreads it
|
|
11
|
+
* into `defineConfig({ ...quietBuild, ... })`. tsdown's own loader imports it at
|
|
12
|
+
* config-load time, from the consumer's node_modules once installed, and Node
|
|
13
|
+
* refuses to strip types there, so it stays plain JavaScript with its types in
|
|
14
|
+
* `quiet-build.d.ts`. It must import nothing: no Deno APIs, no `@std/*`.
|
|
15
|
+
*
|
|
16
|
+
* Apply alongside the `tsdown -l warn` build script: the CLI flag is what gates
|
|
17
|
+
* the startup banner (it is read before the config file loads, so a `logLevel`
|
|
18
|
+
* here could not suppress it), and `suppressWarnings` is what drops the
|
|
19
|
+
* plugin's non-actionable warning while leaving every other warning intact.
|
|
20
|
+
*/
|
|
21
|
+
|
|
22
|
+
/**
|
|
23
|
+
* Matches the `rolldown-plugin-dts` notice that fires once per package because
|
|
24
|
+
* this repo pins `typescript@7` on purpose. Suppressing it does not hide a real
|
|
25
|
+
* emission problem — the notice is about the TypeScript *API* being unstable,
|
|
26
|
+
* not about this build.
|
|
27
|
+
*/
|
|
28
|
+
const NON_ACTIONABLE_WARNINGS = [/TypeScript 7\.0 does not yet have a stable API/]
|
|
29
|
+
|
|
30
|
+
/**
|
|
31
|
+
* Typed by its own `quiet-build.d.ts`, the declaration consumers see, so
|
|
32
|
+
* `checkJs` rejects a value that drifts from it.
|
|
33
|
+
* @type {typeof import('./quiet-build.js').quietBuild}
|
|
34
|
+
*/
|
|
35
|
+
export const quietBuild = {
|
|
36
|
+
logLevel: 'warn',
|
|
37
|
+
suppressWarnings: NON_ACTIONABLE_WARNINGS,
|
|
38
|
+
}
|