@systemfsoftware/vitest-config 0.0.0-bootstrap.0 → 0.1.3
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 +39 -1
- package/lib/base.d.ts +13 -0
- package/lib/base.js +308 -0
- package/lib/files.js +30 -0
- package/package.json +40 -5
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,41 @@
|
|
|
1
1
|
# @systemfsoftware/vitest-config
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The Vitest configuration System F Software packages share: CI-aware timeouts and reporters, coverage settings, source-condition resolution, and a `defineConfig` that adds the `@systemfsoftware/vitest` guard to every block that runs tests.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
Add it as a devDependency together with its peers and the guard's package. It is distributed as a workspace tarball of the [systemfsoftware flake](https://github.com/systemfsoftware/systemfsoftware) (`packages.<system>.vitest-config`), which `lib.mkConsumerStore` serves to an offline pnpm install.
|
|
8
|
+
|
|
9
|
+
| Package | Range |
|
|
10
|
+
| ------------------------- | ---------------------------- |
|
|
11
|
+
| `vitest` (peer) | `^5` |
|
|
12
|
+
| `vite` (peer) | `^8` |
|
|
13
|
+
| `@systemfsoftware/vitest` | the flake's `vitest` tarball |
|
|
14
|
+
|
|
15
|
+
`@systemfsoftware/vitest` must be a direct devDependency of the package whose tests run: `defineConfig` looks for it in that package's own `node_modules`.
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
```ts
|
|
20
|
+
// vitest.config.ts
|
|
21
|
+
import { defineConfig } from '@systemfsoftware/vitest-config'
|
|
22
|
+
|
|
23
|
+
export default defineConfig({ test: { include: ['tests/**/*.test.ts'] } })
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
`defineConfig` returns a promise, because finding the guard reads the file system. Vitest accepts a promised config.
|
|
27
|
+
|
|
28
|
+
When the guard is missing, config load fails instead of running the tests unguarded, and the error names the `package.json` to fix.
|
|
29
|
+
|
|
30
|
+
## Exports
|
|
31
|
+
|
|
32
|
+
| Export | What it is |
|
|
33
|
+
| ------------------------- | --------------------------------------------------------------------------------------- |
|
|
34
|
+
| `defineConfig` | Vitest's `defineConfig` with the guard setup file and the fork's provided context added |
|
|
35
|
+
| `sharedConfig` | the shared `test` settings, for a config that does not use `defineConfig` |
|
|
36
|
+
| `sourceResolveConditions` | resolve conditions that read a workspace sibling's source instead of its build |
|
|
37
|
+
| `isCI` | whether the run is classified as CI |
|
|
38
|
+
|
|
39
|
+
## License
|
|
40
|
+
|
|
41
|
+
[Apache-2.0](./LICENSE)
|
package/lib/base.d.ts
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { ViteUserConfig } from 'vitest/config'
|
|
2
|
+
|
|
3
|
+
declare const sourceResolveConditions: ViteUserConfig
|
|
4
|
+
declare const sharedConfig: ViteUserConfig
|
|
5
|
+
declare const isCI: boolean
|
|
6
|
+
/**
|
|
7
|
+
* Vitest's `defineConfig` with the guard and the fork's provided context added to every block that runs
|
|
8
|
+
* tests. Resolving the guard reads the file system, so the config it returns is a promise.
|
|
9
|
+
*/
|
|
10
|
+
declare const defineConfig: (config: ViteUserConfig) => Promise<ViteUserConfig>
|
|
11
|
+
|
|
12
|
+
export { defineConfig, isCI, sharedConfig, sourceResolveConditions }
|
|
13
|
+
export type { ViteUserConfig }
|
package/lib/base.js
ADDED
|
@@ -0,0 +1,308 @@
|
|
|
1
|
+
import { realpath } from 'node:fs/promises'
|
|
2
|
+
import { dirname, join } from 'node:path'
|
|
3
|
+
import { defaultClientConditions, defaultServerConditions } from 'vite'
|
|
4
|
+
import { defineConfig as defineVitestConfig } from 'vitest/config'
|
|
5
|
+
|
|
6
|
+
import { exists, firstExisting, readJson } from './files.js'
|
|
7
|
+
|
|
8
|
+
/** @typedef {import('vitest/config').ViteUserConfig} ViteUserConfig */
|
|
9
|
+
/** @typedef {NonNullable<ViteUserConfig['test']>} TestConfig */
|
|
10
|
+
/** @typedef {NonNullable<TestConfig['projects']>} Projects */
|
|
11
|
+
/**
|
|
12
|
+
* What one config load reads from disk about its own package: the exemption table entry that decides
|
|
13
|
+
* where the guard applies, the fork setup files (guard and property defaults) its projects take, and the name and workspace root the
|
|
14
|
+
* fork's provided context carries.
|
|
15
|
+
*
|
|
16
|
+
* @typedef {{
|
|
17
|
+
* readonly exemption: { readonly projects: readonly string[] | '*', readonly registrar: string } | undefined,
|
|
18
|
+
* readonly forkSetupFiles: ReadonlyArray<string>,
|
|
19
|
+
* readonly name: string,
|
|
20
|
+
* readonly root: string,
|
|
21
|
+
* }} PackageFacts
|
|
22
|
+
*/
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* @param {unknown} value
|
|
26
|
+
* @param {string} key
|
|
27
|
+
* @returns {string}
|
|
28
|
+
*/
|
|
29
|
+
const stringField = (value, key) => {
|
|
30
|
+
const field = typeof value === 'object' && value !== null ? Reflect.get(value, key) : undefined
|
|
31
|
+
return typeof field === 'string' ? field : ''
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
// Workspace packages expose their source under this condition in `exports`, so a
|
|
35
|
+
// test resolves a sibling's `src/` instead of a `dist/` this run may not have built.
|
|
36
|
+
// Both pipelines need it: node-environment tests resolve through the SSR resolver,
|
|
37
|
+
// while browser tests use the client one. Vite replaces the default conditions when
|
|
38
|
+
// they are set, so the defaults are spread back in rather than dropped.
|
|
39
|
+
const sourceCondition = '@systemfsoftware/source'
|
|
40
|
+
|
|
41
|
+
// The fork's package. Its own tests load its guard from source, since it holds no dependency on itself.
|
|
42
|
+
const forkPackage = '@systemfsoftware/vitest'
|
|
43
|
+
|
|
44
|
+
/**
|
|
45
|
+
* The one table that takes a package's tests out from under the guard. A package is exempt only by being
|
|
46
|
+
* listed here, together with the runner that registers its tests: vitest's own `it` is what the guard
|
|
47
|
+
* refuses, so every test another runner registers must not load it. `projects` is `'*'` when the whole
|
|
48
|
+
* package is exempt, otherwise the names of the exempt inline test projects.
|
|
49
|
+
*
|
|
50
|
+
* @type {Readonly<Record<string, { readonly projects: readonly string[] | '*', readonly registrar: string }>>}
|
|
51
|
+
*/
|
|
52
|
+
const guardExemptions = {
|
|
53
|
+
'@systemfsoftware/oxlint-plugin-cell-architecture': {
|
|
54
|
+
projects: '*',
|
|
55
|
+
registrar: "oxlint's RuleTester registers every case with vitest's it",
|
|
56
|
+
},
|
|
57
|
+
'@systemfsoftware/oxlint-plugin-dmmf-workflow': {
|
|
58
|
+
projects: '*',
|
|
59
|
+
registrar: "oxlint's RuleTester registers every case with vitest's it",
|
|
60
|
+
},
|
|
61
|
+
'@systemfsoftware/oxlint-plugin-effect-platform': {
|
|
62
|
+
projects: '*',
|
|
63
|
+
registrar: "oxlint's RuleTester registers every case with vitest's it",
|
|
64
|
+
},
|
|
65
|
+
'@systemfsoftware/oxlint-plugin-effect-schema': {
|
|
66
|
+
projects: '*',
|
|
67
|
+
registrar: "oxlint's RuleTester registers every case with vitest's it",
|
|
68
|
+
},
|
|
69
|
+
'@systemfsoftware/oxlint-plugin-test-discipline': {
|
|
70
|
+
projects: '*',
|
|
71
|
+
registrar: "oxlint's RuleTester registers every case with vitest's it",
|
|
72
|
+
},
|
|
73
|
+
'@systemfsoftware/storybook-gherkin': {
|
|
74
|
+
projects: ['storybook'],
|
|
75
|
+
registrar: "Storybook's vitest plugin registers every story",
|
|
76
|
+
},
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
/**
|
|
80
|
+
* A setup file the fork exports (`./guard`, `./property-defaults`), as an absolute path. The fork is looked up only where pnpm
|
|
81
|
+
* links a package's declared dependencies, `<package>/node_modules/<fork>`: Node resolution is not
|
|
82
|
+
* used because pnpm's bin shims put the whole virtual store on `NODE_PATH`, so it finds the fork from
|
|
83
|
+
* a package that never declared it. Vitest reads a setup-file specifier without the project's resolve
|
|
84
|
+
* conditions, so the fork's `./guard` export is resolved here: its source entry when that file exists,
|
|
85
|
+
* so an unbuilt fork still guards, otherwise its built entry. A package that has not declared the fork,
|
|
86
|
+
* or whose fork has no guard on disk, fails config load instead of running unguarded. Resolving it
|
|
87
|
+
* reads the file system, so the config a package exports is a promise.
|
|
88
|
+
*
|
|
89
|
+
* @param {string} cwd
|
|
90
|
+
* @param {string} name
|
|
91
|
+
* @param {string} subpath the fork export, `./guard` or `./property-defaults`
|
|
92
|
+
* @returns {Promise<string>}
|
|
93
|
+
*/
|
|
94
|
+
const forkSetupFile = async (cwd, name, subpath) => {
|
|
95
|
+
if (name === forkPackage) return join(cwd, 'src', `${subpath.slice(2)}.ts`)
|
|
96
|
+
const refuse = (/** @type {string} */ what) =>
|
|
97
|
+
new Error(
|
|
98
|
+
`[@systemfsoftware/vitest-config] ${name} ${what}, so its tests would run without the KTD8 guard. ` +
|
|
99
|
+
`Add "${forkPackage}" to devDependencies of ${join(cwd, 'package.json')} ` +
|
|
100
|
+
`(as "workspace:^" inside the systemfsoftware monorepo, otherwise the flake tarball or a version range), ` +
|
|
101
|
+
`or name the exempt test project in vitest-config's guard exemption table.`,
|
|
102
|
+
)
|
|
103
|
+
const forkDir = join(cwd, 'node_modules', forkPackage)
|
|
104
|
+
const manifestPath = join(forkDir, 'package.json')
|
|
105
|
+
if (!(await exists(manifestPath))) throw refuse(`has no "${forkPackage}" linked in its own node_modules`)
|
|
106
|
+
const exportsField = Reflect.get(Object(await readJson(manifestPath)), 'exports')
|
|
107
|
+
const entry = Reflect.get(Object(exportsField), subpath)
|
|
108
|
+
const found = await firstExisting(
|
|
109
|
+
[stringField(entry, sourceCondition), stringField(entry, 'default')]
|
|
110
|
+
.filter((file) => file.length > 0)
|
|
111
|
+
.map((file) => join(forkDir, file)),
|
|
112
|
+
)
|
|
113
|
+
if (found === undefined) throw refuse(`links a "${forkPackage}" whose "${subpath}" export has no file on disk`)
|
|
114
|
+
return realpath(found)
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
// A package config is evaluated with the package directory as the working directory (`pnpm --filter <pkg>
|
|
118
|
+
// test`, and turbo's per-package task), so `<cwd>/package.json` is the package this config belongs to.
|
|
119
|
+
/**
|
|
120
|
+
* The facts about the package this config belongs to, read from disk once.
|
|
121
|
+
*
|
|
122
|
+
* @param {string} cwd
|
|
123
|
+
* @returns {Promise<PackageFacts>}
|
|
124
|
+
*/
|
|
125
|
+
const packageFacts = async (cwd) => {
|
|
126
|
+
const name = stringField(await readJson(join(cwd, 'package.json')), 'name')
|
|
127
|
+
const exemption = guardExemptions[name]
|
|
128
|
+
const forkFiles = exemption?.projects === '*'
|
|
129
|
+
? []
|
|
130
|
+
: [await forkSetupFile(cwd, name, './guard'), await forkSetupFile(cwd, name, './property-defaults')]
|
|
131
|
+
const root = await workspaceRoot(cwd)
|
|
132
|
+
return { exemption, forkSetupFiles: forkFiles, name, root }
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
/**
|
|
136
|
+
* The workspace root: the nearest ancestor of `cwd` that holds `pnpm-workspace.yaml`, or `cwd` when none does.
|
|
137
|
+
*
|
|
138
|
+
* @param {string} cwd
|
|
139
|
+
* @returns {Promise<string>}
|
|
140
|
+
*/
|
|
141
|
+
const workspaceRoot = async (cwd) => {
|
|
142
|
+
let dir = cwd
|
|
143
|
+
while (!(await exists(join(dir, 'pnpm-workspace.yaml')))) {
|
|
144
|
+
const parent = dirname(dir)
|
|
145
|
+
if (parent === dir) return cwd
|
|
146
|
+
dir = parent
|
|
147
|
+
}
|
|
148
|
+
return dir
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
/**
|
|
152
|
+
* The facts a run's provided context carries for the fork: this package's npm name and the workspace root every
|
|
153
|
+
* rendered path is relativized against. The runner reads them with Vitest's `inject`, so a rerun line names the
|
|
154
|
+
* package without the fork ever reading a built-in.
|
|
155
|
+
*
|
|
156
|
+
* @param {PackageFacts} facts
|
|
157
|
+
* @returns {Record<string, string>}
|
|
158
|
+
*/
|
|
159
|
+
const packageProvide = (facts) => {
|
|
160
|
+
/** @type {Record<string, string>} */
|
|
161
|
+
const provided = {}
|
|
162
|
+
if (facts.name.length > 0) provided['@systemfsoftware/vitest:package'] = facts.name
|
|
163
|
+
if (facts.root.length > 0) provided['@systemfsoftware/vitest:workspace-root'] = facts.root
|
|
164
|
+
return provided
|
|
165
|
+
}
|
|
166
|
+
|
|
167
|
+
/**
|
|
168
|
+
* A test block with the package's own provided values merged over whatever it already provides.
|
|
169
|
+
*
|
|
170
|
+
* @param {TestConfig | undefined} test
|
|
171
|
+
* @param {PackageFacts} facts
|
|
172
|
+
* @returns {TestConfig}
|
|
173
|
+
*/
|
|
174
|
+
const withProvide = (test, facts) => ({ ...test, provide: { ...test?.provide, ...packageProvide(facts) } })
|
|
175
|
+
|
|
176
|
+
/**
|
|
177
|
+
* A test block with the package's guard setup files added on top of its own, each at most once.
|
|
178
|
+
* `guard` true adds them; false leaves them out, which an exempt project — one whose tests another
|
|
179
|
+
* runner registers — must not carry.
|
|
180
|
+
*
|
|
181
|
+
* @param {TestConfig | undefined} test
|
|
182
|
+
* @param {boolean} guard
|
|
183
|
+
* @param {PackageFacts} facts
|
|
184
|
+
* @returns {TestConfig}
|
|
185
|
+
*/
|
|
186
|
+
const withSetupFiles = (test, guard, facts) => {
|
|
187
|
+
const own = (test?.setupFiles === undefined ? [] : [test.setupFiles].flat())
|
|
188
|
+
.filter((file) => guard || !facts.forkSetupFiles.includes(file))
|
|
189
|
+
return {
|
|
190
|
+
...test,
|
|
191
|
+
setupFiles: [...new Set([...own, ...(guard ? facts.forkSetupFiles : [])])],
|
|
192
|
+
}
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
/**
|
|
196
|
+
* Whether a project's tests are registered by a runner the guard does not apply to.
|
|
197
|
+
*
|
|
198
|
+
* @param {TestConfig | undefined} test
|
|
199
|
+
* @param {PackageFacts} facts
|
|
200
|
+
* @returns {boolean}
|
|
201
|
+
*/
|
|
202
|
+
const isExemptProject = (test, facts) => {
|
|
203
|
+
const names = facts.exemption?.projects
|
|
204
|
+
if (names === undefined || names === '*') return false
|
|
205
|
+
const name = test?.name
|
|
206
|
+
return typeof name === 'string' && names.includes(name)
|
|
207
|
+
}
|
|
208
|
+
|
|
209
|
+
/**
|
|
210
|
+
* Whether a value is an inline project with a test block.
|
|
211
|
+
*
|
|
212
|
+
* @param {unknown} value
|
|
213
|
+
* @returns {value is { readonly test?: TestConfig }}
|
|
214
|
+
*/
|
|
215
|
+
const isTestProject = (value) => typeof value === 'object' && value !== null && 'test' in value
|
|
216
|
+
|
|
217
|
+
/**
|
|
218
|
+
* An inline project gets the setup files itself. A project the exemption table names is the one
|
|
219
|
+
* exception: the runner that registers its tests is not vitest's, so it takes the handoff without the
|
|
220
|
+
* guard.
|
|
221
|
+
*
|
|
222
|
+
* @param {unknown} project
|
|
223
|
+
* @param {PackageFacts} facts
|
|
224
|
+
* @returns {unknown}
|
|
225
|
+
*/
|
|
226
|
+
const projectWithSetup = (project, facts) => {
|
|
227
|
+
if (!isTestProject(project)) return project
|
|
228
|
+
const test = project.test
|
|
229
|
+
return { ...project, test: withProvide(withSetupFiles(test, !isExemptProject(test, facts), facts), facts) }
|
|
230
|
+
}
|
|
231
|
+
|
|
232
|
+
/**
|
|
233
|
+
* Vitest's `defineConfig` with the guard and the fork's provided context added to every block that runs
|
|
234
|
+
* tests: the root when the config declares no projects, otherwise each inline project. The root of a
|
|
235
|
+
* config with projects runs no tests of its own, and a project with `extends: true` inherits the root's
|
|
236
|
+
* setup files, so a guard on that root would reach an exempt project. The config it builds is a promise,
|
|
237
|
+
* because resolving the guard reads the file system.
|
|
238
|
+
*
|
|
239
|
+
* @param {ViteUserConfig} config
|
|
240
|
+
* @returns {Promise<ViteUserConfig>}
|
|
241
|
+
*/
|
|
242
|
+
export const defineConfig = async (config) => {
|
|
243
|
+
const facts = await packageFacts(process.cwd())
|
|
244
|
+
const declared = config.test?.projects
|
|
245
|
+
const base = withProvide(withSetupFiles(config.test, declared === undefined, facts), facts)
|
|
246
|
+
return defineVitestConfig({
|
|
247
|
+
...config,
|
|
248
|
+
test: declared === undefined
|
|
249
|
+
? base
|
|
250
|
+
: { ...base, projects: /** @type {Projects} */ (declared.map((project) => projectWithSetup(project, facts))) },
|
|
251
|
+
})
|
|
252
|
+
}
|
|
253
|
+
|
|
254
|
+
// AGENT outranks CI. This repo's agent shell sets both, so a CI-first reading
|
|
255
|
+
// gives every agent run the thorough forge treatment - tenfold property draws
|
|
256
|
+
// and coverage - for work that wants fast feedback. An agent run is a dev run.
|
|
257
|
+
const isAgent = process.env['AGENT'] !== undefined
|
|
258
|
+
|
|
259
|
+
// Presence, not equality: GitHub Actions writes "true" and the agent shell
|
|
260
|
+
// writes "1", so testing against either value classifies the other as local.
|
|
261
|
+
// The same rule the fork's run-count table applies: any value except unset, empty, `false` and `0`.
|
|
262
|
+
const ciValue = process.env['CI']
|
|
263
|
+
export const isCI = !isAgent && ciValue !== undefined && !['', 'false', '0'].includes(ciValue)
|
|
264
|
+
|
|
265
|
+
const sharedTestTimeout = isCI ? 30_000 : isAgent ? 15_000 : 8_000
|
|
266
|
+
|
|
267
|
+
/**
|
|
268
|
+
* Spread into a `defineConfig` object that does not use `sharedConfig` as a whole.
|
|
269
|
+
* Both pipelines need the condition, and Vite replaces its defaults when they are set.
|
|
270
|
+
* @type {import('vitest/config').ViteUserConfig}
|
|
271
|
+
*/
|
|
272
|
+
export const sourceResolveConditions = {
|
|
273
|
+
resolve: { conditions: [...defaultClientConditions, sourceCondition] },
|
|
274
|
+
ssr: { resolve: { conditions: [...defaultServerConditions, sourceCondition] } },
|
|
275
|
+
}
|
|
276
|
+
|
|
277
|
+
/**
|
|
278
|
+
* @type {import('vitest/config').ViteUserConfig}
|
|
279
|
+
*/
|
|
280
|
+
export const sharedConfig = {
|
|
281
|
+
...sourceResolveConditions,
|
|
282
|
+
// Effect v3's `effect/TestClock` path, which models keep writing, resolves to
|
|
283
|
+
// the fork's compat module; on its virtual time `adjust` lets that much time pass.
|
|
284
|
+
resolve: {
|
|
285
|
+
...sourceResolveConditions.resolve,
|
|
286
|
+
alias: { 'effect/TestClock': '@systemfsoftware/vitest/TestClock' },
|
|
287
|
+
},
|
|
288
|
+
test: {
|
|
289
|
+
globals: false,
|
|
290
|
+
environment: 'node',
|
|
291
|
+
// The guard and the conformance handoff are added to every test block that runs tests by
|
|
292
|
+
// `defineConfig`, which resolves the guard asynchronously; a config that spreads this object
|
|
293
|
+
// still carries both.
|
|
294
|
+
setupFiles: [],
|
|
295
|
+
includeSource: ['src/**/*.{js,ts}'],
|
|
296
|
+
exclude: ['**/.stryker-tmp/**', '**/node_modules/**', '**/.repo/**'],
|
|
297
|
+
passWithNoTests: true,
|
|
298
|
+
testTimeout: sharedTestTimeout,
|
|
299
|
+
silent: isAgent || isCI ? 'passed-only' : false,
|
|
300
|
+
...(isCI ? { reporters: ['agent', 'github-actions'] } : {}),
|
|
301
|
+
...(isAgent ? { bail: 1 } : {}),
|
|
302
|
+
coverage: {
|
|
303
|
+
enabled: process.env['COVERAGE'] === 'true',
|
|
304
|
+
provider: 'v8',
|
|
305
|
+
reporter: ['json', 'html', 'lcov'],
|
|
306
|
+
},
|
|
307
|
+
},
|
|
308
|
+
}
|
package/lib/files.js
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The file helpers the config and the gate share. Every call is asynchronous, so a config that reads a
|
|
3
|
+
* manifest, resolves a guard or scans a source set never blocks the event loop it shares.
|
|
4
|
+
*/
|
|
5
|
+
import { access, readFile } from 'node:fs/promises'
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* Whether a path exists, as a value rather than a throw.
|
|
9
|
+
*
|
|
10
|
+
* @param {string} path
|
|
11
|
+
* @returns {Promise<boolean>}
|
|
12
|
+
*/
|
|
13
|
+
export const exists = (path) => access(path).then(() => true, () => false)
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* The first path that exists, or undefined when none does.
|
|
17
|
+
*
|
|
18
|
+
* @param {ReadonlyArray<string>} paths
|
|
19
|
+
* @returns {Promise<string | undefined>}
|
|
20
|
+
*/
|
|
21
|
+
export const firstExisting = async (paths) =>
|
|
22
|
+
(await Promise.all(paths.map(async (path) => ((await exists(path)) ? path : undefined)))).find(
|
|
23
|
+
(path) => path !== undefined,
|
|
24
|
+
)
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* @param {string} path
|
|
28
|
+
* @returns {Promise<unknown>}
|
|
29
|
+
*/
|
|
30
|
+
export const readJson = async (path) => JSON.parse(await readFile(path, 'utf8'))
|
package/package.json
CHANGED
|
@@ -1,10 +1,45 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@systemfsoftware/vitest-config",
|
|
3
|
-
"
|
|
4
|
-
"
|
|
3
|
+
"license": "Apache-2.0",
|
|
4
|
+
"version": "0.1.3",
|
|
5
|
+
"author": "Ryan Lee <drdgvhbh@gmail.com>",
|
|
6
|
+
"type": "module",
|
|
7
|
+
"module": "./lib/base.js",
|
|
8
|
+
"exports": {
|
|
9
|
+
"./package.json": "./package.json",
|
|
10
|
+
".": {
|
|
11
|
+
"import": {
|
|
12
|
+
"types": "./lib/base.d.ts",
|
|
13
|
+
"default": "./lib/base.js"
|
|
14
|
+
}
|
|
15
|
+
}
|
|
16
|
+
},
|
|
17
|
+
"files": [
|
|
18
|
+
"lib"
|
|
19
|
+
],
|
|
20
|
+
"publishConfig": {
|
|
21
|
+
"access": "public",
|
|
22
|
+
"provenance": true
|
|
23
|
+
},
|
|
24
|
+
"peerDependencies": {
|
|
25
|
+
"vite": "^8.3.4",
|
|
26
|
+
"vitest": "^5.1.0"
|
|
27
|
+
},
|
|
28
|
+
"devDependencies": {
|
|
29
|
+
"@systemfsoftware/arethetypeswrong-cli": "^4.2.0",
|
|
30
|
+
"@systemfsoftware/tsconfig": "^2.1.0",
|
|
31
|
+
"@types/node": "^26.6.5",
|
|
32
|
+
"vite": "^8.3.4",
|
|
33
|
+
"vitest": "^5.1.0"
|
|
34
|
+
},
|
|
5
35
|
"repository": {
|
|
6
36
|
"type": "git",
|
|
7
|
-
"url": "git+https://github.com/systemfsoftware/systemfsoftware.git"
|
|
37
|
+
"url": "git+https://github.com/systemfsoftware/systemfsoftware.git",
|
|
38
|
+
"directory": "packages/toolchain/vitest-config"
|
|
8
39
|
},
|
|
9
|
-
"
|
|
10
|
-
|
|
40
|
+
"homepage": "https://github.com/systemfsoftware/systemfsoftware/tree/main/packages/toolchain/vitest-config#readme",
|
|
41
|
+
"scripts": {
|
|
42
|
+
"typecheck": "tsc -b",
|
|
43
|
+
"attw": "attw --pack ."
|
|
44
|
+
}
|
|
45
|
+
}
|