@systemfsoftware/oxlint-plugin-cell-vocabulary 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +203 -0
- package/README.md +40 -0
- package/dist/index.d.ts +18 -0
- package/dist/index.mjs +208 -0
- package/dist/oxlint-plugin-cell-vocabulary.d.ts +20 -0
- package/package.json +78 -0
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
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# @systemfsoftware/oxlint-plugin-cell-vocabulary
|
|
2
|
+
|
|
3
|
+
Oxlint rules that decide the phase purity and I/O-cell vocabulary of a Cell description by walking Cell.vocabulary, and report I/O reached from the body of a phase whose kind forbids it.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
pnpm add @systemfsoftware/oxlint-plugin-cell-vocabulary 'effect@4.0.0-rc.108' 'typescript@>=5.0.0'
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Those are peer dependencies: this package declares them but does not install them, so one copy is shared with the rest of your project.
|
|
12
|
+
|
|
13
|
+
## Entry points
|
|
14
|
+
|
|
15
|
+
- `@systemfsoftware/oxlint-plugin-cell-vocabulary`
|
|
16
|
+
|
|
17
|
+
## Use
|
|
18
|
+
|
|
19
|
+
Register the plugin and enable what it recommends:
|
|
20
|
+
|
|
21
|
+
```ts
|
|
22
|
+
// oxlint.config.ts
|
|
23
|
+
import plugin from '@systemfsoftware/oxlint-plugin-cell-vocabulary'
|
|
24
|
+
import { defineConfig } from 'oxlint'
|
|
25
|
+
|
|
26
|
+
export default defineConfig({
|
|
27
|
+
jsPlugins: [import.meta.resolve('@systemfsoftware/oxlint-plugin-cell-vocabulary')],
|
|
28
|
+
rules: { ...plugin.configs.recommended.rules },
|
|
29
|
+
})
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
A rule configured without its plugin registered is reported as unknown and never runs, so both halves are required.
|
|
33
|
+
|
|
34
|
+
## API
|
|
35
|
+
|
|
36
|
+
The public surface is generated from the source and versioned with the package: [`etc/oxlint-plugin-cell-vocabulary.api.md`](./etc/oxlint-plugin-cell-vocabulary.api.md).
|
|
37
|
+
|
|
38
|
+
## License
|
|
39
|
+
|
|
40
|
+
Apache-2.0. Part of [systemfsoftware](https://github.com/systemfsoftware/systemfsoftware/tree/main/packages/oxlint-plugins/cell-vocabulary#readme).
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
//#region src/index.d.ts
|
|
2
|
+
declare const _default: {
|
|
3
|
+
meta: {
|
|
4
|
+
name: string;
|
|
5
|
+
};
|
|
6
|
+
rules: {
|
|
7
|
+
'no-io-in-phase-bodies': import("@oxlint/plugins").Rule;
|
|
8
|
+
};
|
|
9
|
+
configs: {
|
|
10
|
+
recommended: {
|
|
11
|
+
rules: {
|
|
12
|
+
readonly [x: string]: "error";
|
|
13
|
+
};
|
|
14
|
+
};
|
|
15
|
+
};
|
|
16
|
+
};
|
|
17
|
+
//#endregion
|
|
18
|
+
export { _default as default };
|
package/dist/index.mjs
ADDED
|
@@ -0,0 +1,208 @@
|
|
|
1
|
+
import { defineRule } from "@oxlint/plugins";
|
|
2
|
+
import { Array, Schema } from "effect";
|
|
3
|
+
import { Cell } from "@systemfsoftware/effect-cell-types";
|
|
4
|
+
//#region src/rules/cell.ts
|
|
5
|
+
const PathSegments = Schema.NonEmptyArray(Schema.String);
|
|
6
|
+
const lastSegmentOf = (source) => Array.lastNonEmpty(Schema.decodeUnknownSync(PathSegments)(source.split("/")));
|
|
7
|
+
const MODULE_EXTENSIONS = [
|
|
8
|
+
".js",
|
|
9
|
+
".ts",
|
|
10
|
+
".mjs",
|
|
11
|
+
".mts"
|
|
12
|
+
];
|
|
13
|
+
const stripExtension = (segment) => {
|
|
14
|
+
const extension = MODULE_EXTENSIONS.find((candidate) => segment.endsWith(candidate));
|
|
15
|
+
return extension === void 0 ? segment : segment.slice(0, -extension.length);
|
|
16
|
+
};
|
|
17
|
+
/**
|
|
18
|
+
* The cell a module source belongs to, restricted to the walked I/O cells: a source
|
|
19
|
+
* whose last segment ends in one of those cell suffixes is an I/O module, and a
|
|
20
|
+
* binding imported from it is an I/O binding. The suffix set rides the import edge
|
|
21
|
+
* and is never inferred from an identifier's spelling (EE1).
|
|
22
|
+
*/
|
|
23
|
+
const cellOf = (source, cells) => {
|
|
24
|
+
const stem = stripExtension(lastSegmentOf(source));
|
|
25
|
+
return cells.find((cell) => stem.endsWith(`.${cell}`)) ?? null;
|
|
26
|
+
};
|
|
27
|
+
/** `saveOrder(...)` -> `saveOrder`; `Store.save(...)` -> `Store`. */
|
|
28
|
+
const calleeRootName = (callee) => {
|
|
29
|
+
if (callee.type === "Identifier") return callee.name;
|
|
30
|
+
if (callee.type !== "MemberExpression") return null;
|
|
31
|
+
return calleeRootName(callee.object);
|
|
32
|
+
};
|
|
33
|
+
//#endregion
|
|
34
|
+
//#region src/rules/no-io-in-phase-bodies.config.ts
|
|
35
|
+
const Options = Schema.Struct({});
|
|
36
|
+
/**
|
|
37
|
+
* The export name of the description vocabulary on its own module. A description is
|
|
38
|
+
* recognised by an import from `Cell.vocabulary.module`; among that module's exports
|
|
39
|
+
* only this one carries the phase constructors, so a named import of any other export
|
|
40
|
+
* (Policy, Workflow) must not be treated as a description namespace.
|
|
41
|
+
*/
|
|
42
|
+
const DESCRIPTION_NAMESPACE = "Cell";
|
|
43
|
+
/**
|
|
44
|
+
* The phases whose kind forbids I/O, read off the walked vocabulary's own partition by
|
|
45
|
+
* kind. Purity is not inferred here: deriving it from the invocation shape is a different
|
|
46
|
+
* axis, and it disagrees the moment a pure phase is given an effectful shape or an impure
|
|
47
|
+
* one is not.
|
|
48
|
+
*/
|
|
49
|
+
const PURE_PHASE_NAMES = Cell.vocabulary.byKind.pure;
|
|
50
|
+
/** The pure phase names as one string, for the message's {{phases}} slot. */
|
|
51
|
+
const PURE_PHASE_LIST = PURE_PHASE_NAMES.join(", ");
|
|
52
|
+
/** The description package's own module name, walked off the vocabulary. */
|
|
53
|
+
const MODULE_SOURCE = Cell.vocabulary.module;
|
|
54
|
+
/** The cells whose calls are I/O, walked off the vocabulary. */
|
|
55
|
+
const IO_CELLS = Cell.vocabulary.ioCells.cells;
|
|
56
|
+
/** The non-cell module sources whose calls are I/O, walked off the vocabulary. */
|
|
57
|
+
const IO_SOURCES = Cell.vocabulary.ioCells.sources;
|
|
58
|
+
if (PURE_PHASE_NAMES.length === 0) throw new Error(`${DESCRIPTION_NAMESPACE}: the walked vocabulary reports no pure phase, so this rule would decide nothing`);
|
|
59
|
+
if (IO_CELLS.length === 0 && IO_SOURCES.length === 0) throw new Error(`${DESCRIPTION_NAMESPACE}: the walked I/O classification is empty, so this rule would decide nothing`);
|
|
60
|
+
const SKIPPED_WALK_KEYS = [
|
|
61
|
+
"parent",
|
|
62
|
+
"range",
|
|
63
|
+
"loc",
|
|
64
|
+
"start",
|
|
65
|
+
"end"
|
|
66
|
+
];
|
|
67
|
+
const IO_IN_PHASE_BODY_EXPECTED = "a {{phases}} phase body that only transforms the value it receives, with no I/O call written inside it or in a module-level helper it calls";
|
|
68
|
+
const IO_IN_PHASE_BODY_ACTUAL = "an I/O call written inside the body of a {{phases}} phase — at any depth within that body, or in a module-level helper the body calls";
|
|
69
|
+
const IO_IN_PHASE_BODY_FIX = "hoist the I/O into a phase whose kind permits it and pass the value in as the body receives it; when nothing consumes the call, delete it";
|
|
70
|
+
const meta = {
|
|
71
|
+
type: "problem",
|
|
72
|
+
docs: { description: "Report an I/O call reached from the body of a phase whose kind forbids it, in a file that imports the description vocabulary — directly, or through a locally-declared helper the phase body calls. The phase set, the I/O-cell classification and the description module are all walked off Cell.vocabulary, never restated." },
|
|
73
|
+
schema: [Options],
|
|
74
|
+
messages: { ioInPhaseBody: "{{name}} is forbidden. Expected: {{expected}}. Actual: {{actual}}. Fix: {{fix}}." }
|
|
75
|
+
};
|
|
76
|
+
//#endregion
|
|
77
|
+
//#region src/rules/no-io-in-phase-bodies.ts
|
|
78
|
+
const isWalkable = (value) => typeof value === "object" && value !== null;
|
|
79
|
+
const nodeType = (node) => String(node["type"]);
|
|
80
|
+
const walk = (value, visit) => {
|
|
81
|
+
if (!isWalkable(value)) return;
|
|
82
|
+
visit(value);
|
|
83
|
+
for (const key of Object.keys(value)) {
|
|
84
|
+
if (SKIPPED_WALK_KEYS.some((skipped) => skipped === key)) continue;
|
|
85
|
+
walk(value[key], visit);
|
|
86
|
+
}
|
|
87
|
+
};
|
|
88
|
+
const isCallExpression = (value) => nodeType(value) === "CallExpression";
|
|
89
|
+
/**
|
|
90
|
+
* The pure phase a call targets, or null when the callee is not one. The object must
|
|
91
|
+
* be a local binding of the description module's `Cell` export — never a name that
|
|
92
|
+
* merely spells like one, and never another export of the same module.
|
|
93
|
+
*/
|
|
94
|
+
const purePhaseNameOf = (callee, namespaces) => {
|
|
95
|
+
if (callee.type !== "MemberExpression") return null;
|
|
96
|
+
const object = callee.object;
|
|
97
|
+
if (object.type !== "Identifier") return null;
|
|
98
|
+
if (!namespaces.has(object.name)) return null;
|
|
99
|
+
const property = callee.property;
|
|
100
|
+
const propertyName = property.type === "Identifier" ? property.name : null;
|
|
101
|
+
return PURE_PHASE_NAMES.some((phase) => phase === propertyName) ? propertyName : null;
|
|
102
|
+
};
|
|
103
|
+
const noIoInPhaseBodies = defineRule({
|
|
104
|
+
meta,
|
|
105
|
+
create(context) {
|
|
106
|
+
const descriptionNamespaces = /* @__PURE__ */ new Set();
|
|
107
|
+
const ioNames = /* @__PURE__ */ new Set();
|
|
108
|
+
const localHelpers = /* @__PURE__ */ new Map();
|
|
109
|
+
/**
|
|
110
|
+
* Reports every I/O call reachable from a pure phase body: directly, or through a
|
|
111
|
+
* locally-declared helper the body calls, whose own body is walked the same way.
|
|
112
|
+
* The closure branch follows the local binding to its declaration in the same
|
|
113
|
+
* file; a helper already visited is not re-walked, so mutual recursion terminates.
|
|
114
|
+
*/
|
|
115
|
+
const reportIoInBody = (body, visited) => {
|
|
116
|
+
walk(body, (inner) => {
|
|
117
|
+
if (!isCallExpression(inner)) return;
|
|
118
|
+
const innerRoot = calleeRootName(inner.callee);
|
|
119
|
+
if (innerRoot === null) return;
|
|
120
|
+
if (ioNames.has(innerRoot)) {
|
|
121
|
+
context.report({
|
|
122
|
+
node: inner,
|
|
123
|
+
messageId: "ioInPhaseBody",
|
|
124
|
+
data: {
|
|
125
|
+
name: innerRoot,
|
|
126
|
+
expected: IO_IN_PHASE_BODY_EXPECTED.replace("{{phases}}", PURE_PHASE_LIST),
|
|
127
|
+
actual: IO_IN_PHASE_BODY_ACTUAL.replace("{{phases}}", PURE_PHASE_LIST),
|
|
128
|
+
fix: IO_IN_PHASE_BODY_FIX
|
|
129
|
+
}
|
|
130
|
+
});
|
|
131
|
+
return;
|
|
132
|
+
}
|
|
133
|
+
const helper = localHelpers.get(innerRoot);
|
|
134
|
+
if (helper === void 0 || visited.has(helper)) return;
|
|
135
|
+
const next = new Set(visited);
|
|
136
|
+
next.add(helper);
|
|
137
|
+
reportIoInBody(helper, next);
|
|
138
|
+
});
|
|
139
|
+
};
|
|
140
|
+
/**
|
|
141
|
+
* Imports are classified here rather than in an `ImportDeclaration` listener. Listeners fire in
|
|
142
|
+
* document order, so a phase call written above its own import would be judged against empty
|
|
143
|
+
* sets — and with no I/O name registered the rule reports nothing at all. That is a silent pass
|
|
144
|
+
* decided by line order, which is the one failure a guard must not have. `Program` sees every
|
|
145
|
+
* top-level statement before any call is visited, so the sets are complete when the first call
|
|
146
|
+
* is judged.
|
|
147
|
+
*/
|
|
148
|
+
const classifyImport = (node) => {
|
|
149
|
+
const source = node.source.value;
|
|
150
|
+
if (source === MODULE_SOURCE) {
|
|
151
|
+
for (const specifier of node.specifiers) if (specifier.type === "ImportNamespaceSpecifier") descriptionNamespaces.add(specifier.local.name);
|
|
152
|
+
else if (specifier.type === "ImportSpecifier" && specifier.imported.type === "Identifier" && specifier.imported.name === "Cell") descriptionNamespaces.add(specifier.local.name);
|
|
153
|
+
return;
|
|
154
|
+
}
|
|
155
|
+
if (IO_SOURCES.some((ioSource) => ioSource === source)) {
|
|
156
|
+
for (const specifier of node.specifiers) ioNames.add(specifier.local.name);
|
|
157
|
+
return;
|
|
158
|
+
}
|
|
159
|
+
if (cellOf(source, IO_CELLS) === null) return;
|
|
160
|
+
for (const specifier of node.specifiers) ioNames.add(specifier.local.name);
|
|
161
|
+
};
|
|
162
|
+
return {
|
|
163
|
+
Program(node) {
|
|
164
|
+
for (const statement of node.body) {
|
|
165
|
+
if (statement.type === "ImportDeclaration") {
|
|
166
|
+
classifyImport(statement);
|
|
167
|
+
continue;
|
|
168
|
+
}
|
|
169
|
+
const declaration = statement.type === "ExportNamedDeclaration" || statement.type === "ExportDefaultDeclaration" ? statement.declaration : statement;
|
|
170
|
+
if (declaration === null) continue;
|
|
171
|
+
if (declaration.type === "FunctionDeclaration") {
|
|
172
|
+
if (declaration.id !== null) localHelpers.set(declaration.id.name, declaration);
|
|
173
|
+
} else if (declaration.type === "VariableDeclaration") for (const inner of declaration.declarations) {
|
|
174
|
+
const init = inner.init;
|
|
175
|
+
if (init === null) continue;
|
|
176
|
+
if (init.type !== "ArrowFunctionExpression" && init.type !== "FunctionExpression") continue;
|
|
177
|
+
if (inner.id.type !== "Identifier") continue;
|
|
178
|
+
localHelpers.set(inner.id.name, init);
|
|
179
|
+
}
|
|
180
|
+
}
|
|
181
|
+
},
|
|
182
|
+
CallExpression(node) {
|
|
183
|
+
if (purePhaseNameOf(node.callee, descriptionNamespaces) === null) return;
|
|
184
|
+
for (const argument of node.arguments) {
|
|
185
|
+
if (argument.type === "ArrowFunctionExpression" || argument.type === "FunctionExpression") {
|
|
186
|
+
reportIoInBody(argument, /* @__PURE__ */ new Set());
|
|
187
|
+
continue;
|
|
188
|
+
}
|
|
189
|
+
if (argument.type !== "Identifier") continue;
|
|
190
|
+
const helper = localHelpers.get(argument.name);
|
|
191
|
+
if (helper !== void 0) reportIoInBody(helper, /* @__PURE__ */ new Set([helper]));
|
|
192
|
+
}
|
|
193
|
+
}
|
|
194
|
+
};
|
|
195
|
+
}
|
|
196
|
+
});
|
|
197
|
+
//#endregion
|
|
198
|
+
//#region src/index.ts
|
|
199
|
+
const PLUGIN_NAME = "@systemfsoftware/oxlint-plugin-cell-vocabulary";
|
|
200
|
+
const rule = (name) => `${PLUGIN_NAME}/${name}`;
|
|
201
|
+
const recommendedRules = { [rule("no-io-in-phase-bodies")]: "error" };
|
|
202
|
+
var src_default = {
|
|
203
|
+
meta: { name: PLUGIN_NAME },
|
|
204
|
+
rules: { "no-io-in-phase-bodies": noIoInPhaseBodies },
|
|
205
|
+
configs: { recommended: { rules: recommendedRules } }
|
|
206
|
+
};
|
|
207
|
+
//#endregion
|
|
208
|
+
export { src_default as default };
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { Rule } from '@oxlint/plugins';
|
|
2
|
+
|
|
3
|
+
declare const _default: {
|
|
4
|
+
meta: {
|
|
5
|
+
name: string;
|
|
6
|
+
};
|
|
7
|
+
rules: {
|
|
8
|
+
'no-io-in-phase-bodies': Rule;
|
|
9
|
+
};
|
|
10
|
+
configs: {
|
|
11
|
+
recommended: {
|
|
12
|
+
rules: {
|
|
13
|
+
readonly [x: string]: "error";
|
|
14
|
+
};
|
|
15
|
+
};
|
|
16
|
+
};
|
|
17
|
+
};
|
|
18
|
+
export default _default;
|
|
19
|
+
|
|
20
|
+
export { }
|
package/package.json
ADDED
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@systemfsoftware/oxlint-plugin-cell-vocabulary",
|
|
3
|
+
"license": "Apache-2.0",
|
|
4
|
+
"version": "1.0.0",
|
|
5
|
+
"author": "Ryan Lee <drdgvhbh@gmail.com>",
|
|
6
|
+
"repository": {
|
|
7
|
+
"type": "git",
|
|
8
|
+
"url": "git+https://github.com/systemfsoftware/systemfsoftware.git",
|
|
9
|
+
"directory": "packages/oxlint-plugins/cell-vocabulary"
|
|
10
|
+
},
|
|
11
|
+
"homepage": "https://github.com/systemfsoftware/systemfsoftware/tree/main/packages/oxlint-plugins/cell-vocabulary#readme",
|
|
12
|
+
"bugs": "https://github.com/systemfsoftware/systemfsoftware/issues",
|
|
13
|
+
"description": "Oxlint rules that decide the phase purity and I/O-cell vocabulary of a Cell description by walking Cell.vocabulary, and report I/O reached from the body of a phase whose kind forbids it.",
|
|
14
|
+
"keywords": [
|
|
15
|
+
"oxlint",
|
|
16
|
+
"oxlint-plugin",
|
|
17
|
+
"oxc",
|
|
18
|
+
"lint",
|
|
19
|
+
"linter",
|
|
20
|
+
"lint-rules",
|
|
21
|
+
"effect",
|
|
22
|
+
"effect-ts",
|
|
23
|
+
"cell",
|
|
24
|
+
"description",
|
|
25
|
+
"vocabulary",
|
|
26
|
+
"typescript"
|
|
27
|
+
],
|
|
28
|
+
"type": "module",
|
|
29
|
+
"files": [
|
|
30
|
+
"dist"
|
|
31
|
+
],
|
|
32
|
+
"exports": {
|
|
33
|
+
".": {
|
|
34
|
+
"types": "./dist/oxlint-plugin-cell-vocabulary.d.ts",
|
|
35
|
+
"default": "./dist/index.mjs"
|
|
36
|
+
},
|
|
37
|
+
"./package.json": "./package.json"
|
|
38
|
+
},
|
|
39
|
+
"dependencies": {
|
|
40
|
+
"@oxc-project/types": "^0.140.0",
|
|
41
|
+
"@oxlint/plugins": "^1.77.0",
|
|
42
|
+
"@systemfsoftware/effect-cell-types": "^1.0.1"
|
|
43
|
+
},
|
|
44
|
+
"devDependencies": {
|
|
45
|
+
"@microsoft/api-extractor": "^7.58.7",
|
|
46
|
+
"@systemfsoftware/arethetypeswrong-cli": "^1.1.1",
|
|
47
|
+
"@types/node": "^24",
|
|
48
|
+
"@vitest/coverage-v8": "^4",
|
|
49
|
+
"effect": "4.0.0-rc.108",
|
|
50
|
+
"oxlint": "^1.77.0",
|
|
51
|
+
"rimraf": "^6.1.3",
|
|
52
|
+
"tsdown": "^0.22.14",
|
|
53
|
+
"typescript": "^7",
|
|
54
|
+
"vitest": "^4.1.10",
|
|
55
|
+
"@systemfsoftware/tsconfig": "^1.3.1",
|
|
56
|
+
"@systemfsoftware/vitest-config": "^0.1.0"
|
|
57
|
+
},
|
|
58
|
+
"peerDependencies": {
|
|
59
|
+
"effect": "4.0.0-rc.108",
|
|
60
|
+
"typescript": ">=5.0.0"
|
|
61
|
+
},
|
|
62
|
+
"publishConfig": {
|
|
63
|
+
"provenance": true
|
|
64
|
+
},
|
|
65
|
+
"scripts": {
|
|
66
|
+
"build": "tsdown && pnpm api:check",
|
|
67
|
+
"clean": "rimraf dist",
|
|
68
|
+
"typecheck": "tsc --noEmit --incremental",
|
|
69
|
+
"test": "vitest run",
|
|
70
|
+
"test:run": "vitest run --coverage",
|
|
71
|
+
"mutation": "stryker run",
|
|
72
|
+
"mutation:full": "stryker run --force",
|
|
73
|
+
"lint": "f=${OXLINT_FORMAT:-${AGENT:+agent}}; oxlint . --format=${f:-default}",
|
|
74
|
+
"attw": "attw --pack .",
|
|
75
|
+
"api:check": "api-extractor run",
|
|
76
|
+
"api:update": "api-extractor run --local"
|
|
77
|
+
}
|
|
78
|
+
}
|