@thinair/factory 0.0.0-stage → 0.1.124
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/LICENSE +202 -0
- package/NOTICE +4 -0
- package/README.md +104 -2
- package/cli/evaluate.ts +101 -0
- package/cli/factory-code-lint.ts +146 -0
- package/cli/load.ts +463 -0
- package/cli/template.ts +73 -0
- package/domain/load.ts +67 -0
- package/domain/step.ts +70 -0
- package/domain/system-elements/agent.ts +41 -0
- package/domain/system-elements/app-shape.ts +88 -0
- package/domain/system-elements/compose.ts +211 -0
- package/domain/system-elements/factory.ts +61 -0
- package/domain/system-elements/goal.ts +37 -0
- package/domain/system-elements/hole.ts +25 -0
- package/domain/system-elements/job.ts +78 -0
- package/domain/system-elements/node.ts +189 -0
- package/domain/system-elements/pool.ts +63 -0
- package/domain/system-elements/program.ts +123 -0
- package/domain/system-elements/registry.ts +173 -0
- package/domain/system-elements/repository.ts +79 -0
- package/domain/system-elements/rule.ts +55 -0
- package/domain/system-elements/service.ts +82 -0
- package/domain/system-elements/source.ts +40 -0
- package/domain/system-elements/stage.ts +70 -0
- package/package.json +40 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/NOTICE
ADDED
package/README.md
CHANGED
|
@@ -1,3 +1,105 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @thinair/factory
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The SDK for Thinair factories.
|
|
4
|
+
|
|
5
|
+
A factory is a team of agents and jobs that builds software in a repository.
|
|
6
|
+
Its code lives in that repository, in a folder named `factory/`. The code says
|
|
7
|
+
what must be true: the repositories, the stages of work, the jobs, the agents,
|
|
8
|
+
the machines they can use, and the goals that stay true. Thinair runs the
|
|
9
|
+
factory. This package is only the authoring side: the language the code is
|
|
10
|
+
written in, and the loader that checks it on your computer.
|
|
11
|
+
|
|
12
|
+
You need [Bun](https://bun.sh) 1.4.3 or later.
|
|
13
|
+
|
|
14
|
+
## Start a factory
|
|
15
|
+
|
|
16
|
+
In the repository the factory will build:
|
|
17
|
+
|
|
18
|
+
```sh
|
|
19
|
+
bunx @thinair/factory init factory
|
|
20
|
+
cd factory
|
|
21
|
+
bun install
|
|
22
|
+
bunx @thinair/factory load .
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
`init` writes a blank factory into a new, empty folder:
|
|
26
|
+
|
|
27
|
+
- `factory.ts`: the factory's root. Each slot holds a hole, a part still to
|
|
28
|
+
build: a repository, an intake rule, a stage, a pool of machines and an
|
|
29
|
+
agent.
|
|
30
|
+
- `package.json`: pins this version of `@thinair/factory` and of `effect`.
|
|
31
|
+
- `tsconfig.json`, `README.md` and `.gitignore`.
|
|
32
|
+
|
|
33
|
+
## Check it
|
|
34
|
+
|
|
35
|
+
`load` checks the folder and prints the program as JSON:
|
|
36
|
+
|
|
37
|
+
1. the folder's shape;
|
|
38
|
+
2. the import rule: factory code imports only the authoring modules below,
|
|
39
|
+
its own files and its own npm packages;
|
|
40
|
+
3. the type check;
|
|
41
|
+
4. it runs the code in a separate process, with a time limit, and builds the
|
|
42
|
+
program.
|
|
43
|
+
|
|
44
|
+
Each finding names the part, the file and the line. The exit code is 0 when
|
|
45
|
+
the factory is ready, 1 when it is held (the findings say why), and 2 when
|
|
46
|
+
the loader itself failed.
|
|
47
|
+
|
|
48
|
+
`dev --factory <id>` loads the folder again on every save and sends each load
|
|
49
|
+
to that factory as a preview. It uses the `thinair` command, so run it where
|
|
50
|
+
`thinair` is signed in, for example in a Thinair Terminal.
|
|
51
|
+
|
|
52
|
+
## Fill a hole
|
|
53
|
+
|
|
54
|
+
Write the part in its own file, with one default export, and put it in
|
|
55
|
+
`factory.ts` where its hole was:
|
|
56
|
+
|
|
57
|
+
```ts
|
|
58
|
+
// stages/change.ts
|
|
59
|
+
import { Schema } from "effect";
|
|
60
|
+
import { done } from "@thinair/factory/domain/system-elements/compose";
|
|
61
|
+
import { stage } from "@thinair/factory/domain/system-elements/stage";
|
|
62
|
+
|
|
63
|
+
export default stage("change", {
|
|
64
|
+
spec: Schema.Struct({ pr: Schema.Int, head: Schema.String }),
|
|
65
|
+
compose: ({ spec }) => [done(`checked ${spec.head}`)],
|
|
66
|
+
});
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
```ts
|
|
70
|
+
// factory.ts
|
|
71
|
+
import change from "./stages/change";
|
|
72
|
+
// ...
|
|
73
|
+
stages: [change],
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## What factory code imports
|
|
77
|
+
|
|
78
|
+
- `@thinair/factory/domain/system-elements/factory`
|
|
79
|
+
- `@thinair/factory/domain/system-elements/repository`
|
|
80
|
+
- `@thinair/factory/domain/system-elements/source`
|
|
81
|
+
- `@thinair/factory/domain/system-elements/rule`
|
|
82
|
+
- `@thinair/factory/domain/system-elements/stage`
|
|
83
|
+
- `@thinair/factory/domain/system-elements/job`
|
|
84
|
+
- `@thinair/factory/domain/system-elements/service`
|
|
85
|
+
- `@thinair/factory/domain/system-elements/pool`
|
|
86
|
+
- `@thinair/factory/domain/system-elements/agent`
|
|
87
|
+
- `@thinair/factory/domain/system-elements/goal`
|
|
88
|
+
- `@thinair/factory/domain/system-elements/hole`
|
|
89
|
+
- `@thinair/factory/domain/system-elements/compose`
|
|
90
|
+
- `@thinair/factory/domain/step`
|
|
91
|
+
|
|
92
|
+
`@thinair/factory/domain/system-elements/program` and
|
|
93
|
+
`@thinair/factory/domain/load` hold the schemas of a program and of a load,
|
|
94
|
+
for tools that read what `load` prints.
|
|
95
|
+
|
|
96
|
+
## Versions
|
|
97
|
+
|
|
98
|
+
Each Thinair release publishes this package under its own version. A
|
|
99
|
+
factory's `package.json` pins the version its code was written against. A
|
|
100
|
+
factory that needs a newer version than the Thinair that runs it waits, and
|
|
101
|
+
says so, until that Thinair is updated.
|
|
102
|
+
|
|
103
|
+
## License
|
|
104
|
+
|
|
105
|
+
Apache-2.0. See `LICENSE` and `NOTICE`.
|
package/cli/evaluate.ts
ADDED
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
import { createHash } from "node:crypto";
|
|
2
|
+
import { readFile, writeFile } from "node:fs/promises";
|
|
3
|
+
import { pathToFileURL } from "node:url";
|
|
4
|
+
import { Effect, Schema } from "effect";
|
|
5
|
+
import { NodeId, SourceAt } from "../domain/system-elements/node";
|
|
6
|
+
import { Program } from "../domain/system-elements/program";
|
|
7
|
+
import { encodeFactory } from "../domain/system-elements/registry";
|
|
8
|
+
|
|
9
|
+
/*
|
|
10
|
+
* The evaluator: the loader runs it as a subprocess, with a runaway
|
|
11
|
+
* deadline, on the content-keyed bundle of a factory's code. It imports the
|
|
12
|
+
* bundle, encodes the root it exports and writes the result to a file (never
|
|
13
|
+
* stdout, which the factory's own code might write to).
|
|
14
|
+
*
|
|
15
|
+
* Importing the bundle is the one computed import in the framework: the
|
|
16
|
+
* bundle's path is a content key, so the same code always loads the same
|
|
17
|
+
* bundle, and nothing else is reached by a computed path.
|
|
18
|
+
*/
|
|
19
|
+
|
|
20
|
+
export const EvaluateInput = Schema.Struct({
|
|
21
|
+
tree: Schema.String,
|
|
22
|
+
bundle: Schema.String,
|
|
23
|
+
framework: Schema.String,
|
|
24
|
+
out: Schema.String,
|
|
25
|
+
files: Schema.Record(Schema.String, Schema.Struct({ digest: Schema.String, imports: Schema.Array(Schema.String) })),
|
|
26
|
+
});
|
|
27
|
+
export type EvaluateInput = typeof EvaluateInput.Type;
|
|
28
|
+
|
|
29
|
+
export const EvaluateOutput = Schema.Struct({
|
|
30
|
+
program: Schema.NullOr(Program),
|
|
31
|
+
problems: Schema.Array(Schema.Struct({
|
|
32
|
+
/** `evaluate`: the code threw while it loaded. `value`: the encoder's checks. */
|
|
33
|
+
step: Schema.Literals(["evaluate", "value"]),
|
|
34
|
+
node: Schema.NullOr(NodeId),
|
|
35
|
+
at: Schema.NullOr(SourceAt),
|
|
36
|
+
message: Schema.String,
|
|
37
|
+
})),
|
|
38
|
+
});
|
|
39
|
+
export type EvaluateOutput = typeof EvaluateOutput.Type;
|
|
40
|
+
export const EvaluateOutputJson = Schema.toCodecJson(EvaluateOutput);
|
|
41
|
+
|
|
42
|
+
class EvaluateFailed extends Schema.TaggedError<EvaluateFailed>()("EvaluateFailed", { message: Schema.String }) {}
|
|
43
|
+
|
|
44
|
+
const FRAME = /\(?((?:file:\/\/)?\/[^():]+):(\d+):\d+\)?\s*$/u;
|
|
45
|
+
|
|
46
|
+
/** Where a throw came from inside the factory folder, from its stack. */
|
|
47
|
+
const throwAt = (error: unknown, tree: string): SourceAt | null => {
|
|
48
|
+
const stack = error instanceof Error ? error.stack ?? "" : "";
|
|
49
|
+
for (const line of stack.split("\n")) {
|
|
50
|
+
const match = FRAME.exec(line);
|
|
51
|
+
if (match === null) continue;
|
|
52
|
+
const file = match[1]!.startsWith("file://") ? decodeURIComponent(match[1]!.slice("file://".length)) : match[1]!;
|
|
53
|
+
if (file.startsWith(`${tree}/`) && !file.slice(tree.length + 1).startsWith("node_modules/"))
|
|
54
|
+
return { file: file.slice(tree.length + 1), line: Math.max(1, Number(match[2])) };
|
|
55
|
+
}
|
|
56
|
+
return null;
|
|
57
|
+
};
|
|
58
|
+
|
|
59
|
+
const evaluate = Effect.fn("factory.evaluate")(function* (inputPath: string) {
|
|
60
|
+
const input = yield* Effect.tryPromise({
|
|
61
|
+
try: () => readFile(inputPath, "utf8"),
|
|
62
|
+
catch: () => new EvaluateFailed({ message: `Could not read the evaluator's input at ${inputPath}.` }),
|
|
63
|
+
}).pipe(Effect.flatMap(Schema.decodeUnknownEffect(Schema.fromJsonString(EvaluateInput))), Effect.mapError((error) => new EvaluateFailed({ message: error.message })));
|
|
64
|
+
const output = yield* Effect.tryPromise({
|
|
65
|
+
try: () => import(pathToFileURL(input.bundle).href) as Promise<Readonly<{ default?: unknown }>>,
|
|
66
|
+
catch: (error) => error,
|
|
67
|
+
}).pipe(
|
|
68
|
+
Effect.flatMap((module) => Effect.try({
|
|
69
|
+
try: (): EvaluateOutput => {
|
|
70
|
+
const encoded = encodeFactory(module.default, {
|
|
71
|
+
tree: input.tree,
|
|
72
|
+
framework: input.framework,
|
|
73
|
+
hash: (text) => createHash("sha256").update(text).digest("hex"),
|
|
74
|
+
files: input.files,
|
|
75
|
+
});
|
|
76
|
+
return { program: encoded.program, problems: encoded.problems.map((problem) => ({ step: "value" as const, ...problem })) };
|
|
77
|
+
},
|
|
78
|
+
catch: (error) => error,
|
|
79
|
+
})),
|
|
80
|
+
Effect.catch((error) => Effect.succeed<EvaluateOutput>({
|
|
81
|
+
program: null,
|
|
82
|
+
problems: [{ step: "evaluate", node: null, at: throwAt(error, input.tree), message: `The factory's code threw while it loaded: ${error instanceof Error ? error.message : String(error)}` }],
|
|
83
|
+
})),
|
|
84
|
+
);
|
|
85
|
+
const encoded = yield* Schema.encodeEffect(EvaluateOutputJson)(output).pipe(Effect.mapError((error) => new EvaluateFailed({ message: error.message })));
|
|
86
|
+
yield* Effect.tryPromise({
|
|
87
|
+
try: () => writeFile(input.out, JSON.stringify(encoded)),
|
|
88
|
+
catch: () => new EvaluateFailed({ message: `Could not write the evaluation to ${input.out}.` }),
|
|
89
|
+
});
|
|
90
|
+
});
|
|
91
|
+
|
|
92
|
+
if (import.meta.main) {
|
|
93
|
+
const inputPath = process.argv[2];
|
|
94
|
+
const exit = await Effect.runPromiseExit(inputPath === undefined
|
|
95
|
+
? Effect.fail(new EvaluateFailed({ message: "Usage: evaluate.ts <input.json>" }))
|
|
96
|
+
: evaluate(inputPath));
|
|
97
|
+
if (exit._tag === "Failure") {
|
|
98
|
+
process.stderr.write(`${String(exit.cause)}\n`);
|
|
99
|
+
process.exitCode = 1;
|
|
100
|
+
}
|
|
101
|
+
}
|
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* The `factory-code` lint: the one oxlint set a factory's code is held to.
|
|
3
|
+
* oxlint loads this file by path (`jsPlugins`), so it uses only erasable
|
|
4
|
+
* TypeScript and imports nothing; the loader passes the allowlist and the
|
|
5
|
+
* folder as rule options.
|
|
6
|
+
*
|
|
7
|
+
* - imports: factory code imports the authoring modules, its own npm
|
|
8
|
+
* packages and its own files, never the host repository, never the rest
|
|
9
|
+
* of the framework, never a runtime module, and always statically;
|
|
10
|
+
* - sealed: it never reaches the network, the disk or the process; steps
|
|
11
|
+
* reach a machine only through their holes;
|
|
12
|
+
* - one-default-export: factory.ts and each member file export one thing,
|
|
13
|
+
* the node it makes, as the default export.
|
|
14
|
+
*/
|
|
15
|
+
|
|
16
|
+
type Node = Readonly<{ type: string; [key: string]: unknown }>;
|
|
17
|
+
type Report = Readonly<{ node: Node; message: string }>;
|
|
18
|
+
type Context = Readonly<{
|
|
19
|
+
options: ReadonlyArray<unknown>;
|
|
20
|
+
filename: string;
|
|
21
|
+
report: (diagnostic: Report) => void;
|
|
22
|
+
sourceCode: Readonly<{ getScope: (node: Node) => Scope }>;
|
|
23
|
+
}>;
|
|
24
|
+
type Scope = Readonly<{ through: ReadonlyArray<Readonly<{ identifier: Node }>> }>;
|
|
25
|
+
type Visitor = Readonly<Record<string, (node: Node) => void>>;
|
|
26
|
+
type Rule = Readonly<{ meta: Readonly<{ type: "problem"; docs: Readonly<{ description: string }>; schema: ReadonlyArray<unknown> }>; create: (context: Context) => Visitor }>;
|
|
27
|
+
|
|
28
|
+
type Options = Readonly<{ root: string; modules: ReadonlyArray<string>; packages: ReadonlyArray<string>; members: ReadonlyArray<string> }>;
|
|
29
|
+
|
|
30
|
+
const stringList = { type: "array", items: { type: "string" } } as const;
|
|
31
|
+
const optionsSchema = [{
|
|
32
|
+
type: "object",
|
|
33
|
+
properties: { root: { type: "string" }, modules: stringList, packages: stringList, members: stringList },
|
|
34
|
+
additionalProperties: false,
|
|
35
|
+
}];
|
|
36
|
+
const optionsOf = (context: Context): Partial<Options> => (context.options[0] ?? {}) as Partial<Options>;
|
|
37
|
+
|
|
38
|
+
const sourceOf = (node: Node): string | null => {
|
|
39
|
+
const source = node["source"] as Node | null | undefined;
|
|
40
|
+
return source !== null && source !== undefined && typeof source["value"] === "string" ? source["value"] : null;
|
|
41
|
+
};
|
|
42
|
+
|
|
43
|
+
/** A path with `.` and `..` folded, `/`-separated. */
|
|
44
|
+
const normalize = (path: string): string => {
|
|
45
|
+
const parts: string[] = [];
|
|
46
|
+
for (const part of path.split(/[\\/]+/u)) {
|
|
47
|
+
if (part === "" || part === ".") continue;
|
|
48
|
+
if (part === "..") parts.pop();
|
|
49
|
+
else parts.push(part);
|
|
50
|
+
}
|
|
51
|
+
return `/${parts.join("/")}`;
|
|
52
|
+
};
|
|
53
|
+
const directoryOf = (file: string) => file.split(/[\\/]+/u).slice(0, -1).join("/");
|
|
54
|
+
const relativeTo = (root: string, file: string): string | null => {
|
|
55
|
+
const base = normalize(root);
|
|
56
|
+
const path = normalize(file);
|
|
57
|
+
return path.startsWith(`${base}/`) ? path.slice(base.length + 1) : null;
|
|
58
|
+
};
|
|
59
|
+
const packageOf = (specifier: string) => specifier.startsWith("@") ? specifier.split("/").slice(0, 2).join("/") : specifier.split("/")[0]!;
|
|
60
|
+
|
|
61
|
+
const imports: Rule = {
|
|
62
|
+
meta: {
|
|
63
|
+
type: "problem",
|
|
64
|
+
docs: { description: "Factory code imports the authoring modules, its own npm packages and its own files, statically." },
|
|
65
|
+
schema: optionsSchema,
|
|
66
|
+
},
|
|
67
|
+
create(context) {
|
|
68
|
+
const options = optionsOf(context);
|
|
69
|
+
const modules = new Set(options.modules ?? []);
|
|
70
|
+
const packages = new Set(options.packages ?? []);
|
|
71
|
+
const check = (node: Node) => {
|
|
72
|
+
const source = sourceOf(node);
|
|
73
|
+
if (source === null || modules.has(source)) return;
|
|
74
|
+
if (source.startsWith(".")) {
|
|
75
|
+
if (options.root !== undefined && relativeTo(options.root, `${directoryOf(context.filename)}/${source}`) === null)
|
|
76
|
+
context.report({ node, message: `"${source}" is outside the factory folder. Factory code imports only its own files, never the host repository.` });
|
|
77
|
+
return;
|
|
78
|
+
}
|
|
79
|
+
if (/^(?:node|bun):/u.test(source))
|
|
80
|
+
context.report({ node, message: `"${source}" is a runtime module. A step reaches its machine through Machine and Store; nothing else in factory code touches the host.` });
|
|
81
|
+
else if (packageOf(source) === "@thinair/factory")
|
|
82
|
+
context.report({ node, message: `"${source}" is not an authoring module. Factory code imports only ${[...modules].join(", ")} from the framework.` });
|
|
83
|
+
else if (!packages.has(packageOf(source)))
|
|
84
|
+
context.report({ node, message: `"${source}" is not one of the factory's own npm packages (${[...packages].join(", ")}). Add it to factory/package.json, or do without it.` });
|
|
85
|
+
};
|
|
86
|
+
return {
|
|
87
|
+
ImportDeclaration: check,
|
|
88
|
+
ExportNamedDeclaration: check,
|
|
89
|
+
ExportAllDeclaration: check,
|
|
90
|
+
ImportExpression(node) { context.report({ node, message: "Factory code imports statically: the program is what its imports reach." }); },
|
|
91
|
+
};
|
|
92
|
+
},
|
|
93
|
+
};
|
|
94
|
+
|
|
95
|
+
/** What reaches the network, the disk or the process. */
|
|
96
|
+
const unsealed = new Set([
|
|
97
|
+
"fetch", "XMLHttpRequest", "WebSocket", "EventSource", "navigator", "Request",
|
|
98
|
+
"process", "Bun", "Deno", "require", "module", "__dirname", "__filename", "globalThis", "global", "self", "window",
|
|
99
|
+
"eval", "Function", "Worker", "importScripts",
|
|
100
|
+
]);
|
|
101
|
+
|
|
102
|
+
const sealed: Rule = {
|
|
103
|
+
meta: { type: "problem", docs: { description: "Factory code reaches no network, no disk and no process." }, schema: [] },
|
|
104
|
+
create(context) {
|
|
105
|
+
return {
|
|
106
|
+
"Program:exit"(node) {
|
|
107
|
+
for (const reference of context.sourceCode.getScope(node).through) {
|
|
108
|
+
const name = reference.identifier["name"] as string;
|
|
109
|
+
if (unsealed.has(name))
|
|
110
|
+
context.report({ node: reference.identifier, message: `${name}: factory code never reaches the network, the disk or the process. A step reaches its machine through Machine and Store; outward writes are acts.` });
|
|
111
|
+
}
|
|
112
|
+
},
|
|
113
|
+
};
|
|
114
|
+
},
|
|
115
|
+
};
|
|
116
|
+
|
|
117
|
+
const oneDefaultExport: Rule = {
|
|
118
|
+
meta: { type: "problem", docs: { description: "factory.ts and each member file export one thing, the node it makes, as the default export." }, schema: optionsSchema },
|
|
119
|
+
create(context): Visitor {
|
|
120
|
+
const options = optionsOf(context);
|
|
121
|
+
const path = options.root === undefined ? null : relativeTo(options.root, context.filename);
|
|
122
|
+
if (path === null || !(options.members ?? []).includes(path)) return {};
|
|
123
|
+
let program: Node | null = null;
|
|
124
|
+
let defaults = 0;
|
|
125
|
+
return {
|
|
126
|
+
Program(node) { program = node; },
|
|
127
|
+
ExportNamedDeclaration(node) {
|
|
128
|
+
if (node["exportKind"] === "type") return;
|
|
129
|
+
context.report({ node, message: `${path} exports one thing, the node it makes, as its default export. Keep this local, or move it to a file of its own.` });
|
|
130
|
+
},
|
|
131
|
+
ExportAllDeclaration(node) {
|
|
132
|
+
context.report({ node, message: `${path} exports one thing, the node it makes, as its default export. Remove this re-export.` });
|
|
133
|
+
},
|
|
134
|
+
ExportDefaultDeclaration() { defaults += 1; },
|
|
135
|
+
"Program:exit"() {
|
|
136
|
+
if (defaults === 0 && program !== null)
|
|
137
|
+
context.report({ node: program, message: `${path} exports the node it makes: add export default ${path === "factory.ts" ? "defineFactory({ ... })" : "<constructor>(...)"}.` });
|
|
138
|
+
},
|
|
139
|
+
};
|
|
140
|
+
},
|
|
141
|
+
};
|
|
142
|
+
|
|
143
|
+
export default {
|
|
144
|
+
meta: { name: "thinair-factory" },
|
|
145
|
+
rules: { imports, sealed, "one-default-export": oneDefaultExport },
|
|
146
|
+
};
|