@sshkeda/check 0.0.0-stage → 1.0.1

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.
Files changed (167) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +156 -2
  3. package/docs/how-to-make-check-pass.md +71 -0
  4. package/package.json +51 -4
  5. package/src/index.ts +8 -0
  6. package/src/internal/ban-abbreviated-words-in-declared-names.ts +165 -0
  7. package/src/internal/ban-checked-members-outside-calls.ts +151 -0
  8. package/src/internal/ban-comments.ts +23 -0
  9. package/src/internal/ban-comparing-or-switching-on-tag.ts +114 -0
  10. package/src/internal/ban-deadlines-inside-tests.ts +41 -0
  11. package/src/internal/ban-declared-values.ts +70 -0
  12. package/src/internal/ban-dropped-failures-detached-fibers-sleeps-and-untraced-functions.ts +67 -0
  13. package/src/internal/ban-failures-collected-as-results.ts +57 -0
  14. package/src/internal/ban-fallbacks-of-named-recoveries.ts +118 -0
  15. package/src/internal/ban-function-overloads.ts +107 -0
  16. package/src/internal/ban-global-error-in-failure-types.ts +146 -0
  17. package/src/internal/ban-instanceof-in-effect-recovery-callbacks.ts +63 -0
  18. package/src/internal/ban-let-and-effect-mutable-ref.ts +79 -0
  19. package/src/internal/ban-logic-in-index-files.ts +178 -0
  20. package/src/internal/ban-namespaces-used-without-a-member.ts +176 -0
  21. package/src/internal/ban-node-builtins-that-effect-replaces.ts +42 -0
  22. package/src/internal/ban-parsing-outside-data-without-a-schema.ts +299 -0
  23. package/src/internal/ban-re-exports.ts +172 -0
  24. package/src/internal/ban-reading-the-clock-and-sleeping-outside-effect.ts +239 -0
  25. package/src/internal/ban-retired-words-in-names.ts +49 -0
  26. package/src/internal/ban-scanning-directories-with-bun-glob.ts +79 -0
  27. package/src/internal/ban-shebang-lines.ts +26 -0
  28. package/src/internal/ban-timer-globals-and-the-global-object.ts +34 -0
  29. package/src/internal/ban-timer-schedules-without-deadlines.ts +240 -0
  30. package/src/internal/ban-type-and-interface-declarations.ts +48 -0
  31. package/src/internal/ban-type-predicates.ts +82 -0
  32. package/src/internal/ban-unknown-in-function-signatures.ts +143 -0
  33. package/src/internal/ban-vague-error-class-names.ts +28 -0
  34. package/src/internal/ban-vague-file-names.ts +51 -0
  35. package/src/internal/ban-what-a-file-is-not-granted.ts +512 -0
  36. package/src/internal/ban-while-do-while-and-for-loops.ts +27 -0
  37. package/src/internal/confine-service-declarations-to-granted-files.ts +116 -0
  38. package/src/internal/confine-the-stdio-service-to-terminal-output.ts +190 -0
  39. package/src/internal/define-the-lint-plugin-and-configs.ts +361 -0
  40. package/src/internal/describe-and-decode-rule-options.ts +22 -0
  41. package/src/internal/keep-assertions-in-the-test-home-and-ban-test-runners.ts +128 -0
  42. package/src/internal/keep-effect-testing-helpers-in-test-files.ts +157 -0
  43. package/src/internal/match-banned-modules-and-globals.ts +71 -0
  44. package/src/internal/match-effect-service-factories.ts +20 -0
  45. package/src/internal/require-a-named-const-for-compound-conditions.ts +44 -0
  46. package/src/internal/require-capital-snake-case-and-as-const-on-literal-constants.ts +141 -0
  47. package/src/internal/require-service-keys-to-end-with-their-class-name.ts +64 -0
  48. package/src/internal/resolve-what-an-expression-imports.ts +295 -0
  49. package/src/internal/sort-type-constituents.ts +82 -0
  50. package/src/internal/split-names-into-words.ts +12 -0
  51. package/src/internal/visit-every-declared-name.ts +264 -0
  52. package/src/lib/tasks/index.ts +1 -0
  53. package/src/lib/tasks/internal/declare-the-check-task.ts +29 -0
  54. package/src/lib/tasks/internal/declare-the-checker-queries-task.ts +41 -0
  55. package/src/lib/tasks/internal/declare-the-typed-checks-task.ts +25 -0
  56. package/src/lib/tasks/internal/run-checks-over-one-typescript-project.ts +68 -0
  57. package/src/lib/tasks/lib/check-effect-diagnostics-with-effect-tsgo/index.ts +15 -0
  58. package/src/lib/tasks/lib/check-effect-diagnostics-with-effect-tsgo/internal/check-effect-diagnostics-with-effect-tsgo.ts +211 -0
  59. package/src/lib/tasks/lib/check-effect-diagnostics-with-effect-tsgo/internal/read-effect-tsgo-json-report.ts +39 -0
  60. package/src/lib/tasks/lib/check-import-boundaries/index.ts +1 -0
  61. package/src/lib/tasks/lib/check-import-boundaries/internal/find-import-boundary-violations.ts +415 -0
  62. package/src/lib/tasks/lib/check-import-boundaries/internal/find-subpath-import-targets.ts +117 -0
  63. package/src/lib/tasks/lib/check-import-boundaries/internal/find-what-hides-an-import.ts +65 -0
  64. package/src/lib/tasks/lib/check-import-boundaries/internal/import-boundary-errors.ts +176 -0
  65. package/src/lib/tasks/lib/check-uses-by-their-declarations/index.ts +1 -0
  66. package/src/lib/tasks/lib/check-uses-by-their-declarations/internal/declared-use-errors.ts +32 -0
  67. package/src/lib/tasks/lib/check-uses-by-their-declarations/internal/find-declared-use-violations.ts +38 -0
  68. package/src/lib/tasks/lib/check-uses-by-their-declarations/internal/find-sync-calls.ts +23 -0
  69. package/src/lib/tasks/lib/check-uses-by-their-declarations/internal/find-type-only-schemas.ts +375 -0
  70. package/src/lib/tasks/lib/confine-layer-provides-to-program-starts/index.ts +1 -0
  71. package/src/lib/tasks/lib/confine-layer-provides-to-program-starts/internal/find-layer-provides-outside-program-starts.ts +648 -0
  72. package/src/lib/tasks/lib/confine-layer-provides-to-program-starts/internal/layer-provide-errors.ts +27 -0
  73. package/src/lib/tasks/lib/confine-layer-provides-to-program-starts/internal/resolve-imported-package-apis.ts +262 -0
  74. package/src/lib/tasks/lib/confine-stdio-to-granted-files/index.ts +1 -0
  75. package/src/lib/tasks/lib/confine-stdio-to-granted-files/internal/find-ungranted-stdio-uses.ts +219 -0
  76. package/src/lib/tasks/lib/confine-stdio-to-granted-files/internal/stdio-use-errors.ts +31 -0
  77. package/src/lib/tasks/lib/detect-inferrable-annotations/index.ts +1 -0
  78. package/src/lib/tasks/lib/detect-inferrable-annotations/internal/find-inferrable-annotations.ts +357 -0
  79. package/src/lib/tasks/lib/detect-inferrable-annotations/internal/inferrable-annotation-errors.ts +33 -0
  80. package/src/lib/tasks/lib/detect-repeated-service-yields/index.ts +1 -0
  81. package/src/lib/tasks/lib/detect-repeated-service-yields/internal/find-repeated-service-yields.ts +162 -0
  82. package/src/lib/tasks/lib/detect-repeated-service-yields/internal/repeated-service-yield-errors.ts +25 -0
  83. package/src/lib/tasks/lib/enforce-file-layout/index.ts +5 -0
  84. package/src/lib/tasks/lib/enforce-file-layout/internal/check-the-layout-of-each-package.ts +9 -0
  85. package/src/lib/tasks/lib/enforce-file-layout/internal/file-layout-errors.ts +417 -0
  86. package/src/lib/tasks/lib/enforce-file-layout/internal/find-export-path-mismatches.ts +83 -0
  87. package/src/lib/tasks/lib/enforce-file-layout/internal/find-file-layout-violations.ts +848 -0
  88. package/src/lib/tasks/lib/enforce-file-layout/internal/find-module-layout-violations.ts +82 -0
  89. package/src/lib/tasks/lib/enforce-file-layout/internal/resolve-task-imports.ts +178 -0
  90. package/src/lib/tasks/lib/enforce-file-types/index.ts +5 -0
  91. package/src/lib/tasks/lib/enforce-file-types/internal/file-type-errors.ts +21 -0
  92. package/src/lib/tasks/lib/enforce-file-types/internal/find-file-type-violations.ts +78 -0
  93. package/src/lib/tasks/lib/format-with-bun-fmt/index.ts +1 -0
  94. package/src/lib/tasks/lib/format-with-bun-fmt/internal/check-formatting-with-bun-fmt.ts +157 -0
  95. package/src/lib/tasks/lib/format-with-bun-fmt/internal/declare-the-formatting-task.ts +66 -0
  96. package/src/lib/tasks/lib/format-with-bun-fmt/internal/find-format-config-violations.ts +16 -0
  97. package/src/lib/tasks/lib/format-with-bun-fmt/internal/find-format-input-violations.ts +74 -0
  98. package/src/lib/tasks/lib/format-with-bun-fmt/internal/find-symbolic-links.ts +14 -0
  99. package/src/lib/tasks/lib/format-with-bun-fmt/internal/unformatted-file-errors.ts +12 -0
  100. package/src/lib/tasks/lib/judge-index-re-exports/index.ts +1 -0
  101. package/src/lib/tasks/lib/judge-index-re-exports/internal/find-index-re-export-violations.ts +353 -0
  102. package/src/lib/tasks/lib/judge-index-re-exports/internal/index-re-export-errors.ts +21 -0
  103. package/src/lib/tasks/lib/lint-with-oxlint/index.ts +15 -0
  104. package/src/lib/tasks/lib/lint-with-oxlint/internal/check-lint-rules-with-oxlint.ts +123 -0
  105. package/src/lib/tasks/lib/lint-with-oxlint/internal/check-unsafe-enum-assignments.ts +152 -0
  106. package/src/lib/tasks/lib/lint-with-oxlint/internal/find-tsgolint-executable.ts +21 -0
  107. package/src/lib/tasks/lib/lint-with-oxlint/internal/read-oxlint-json-report.ts +82 -0
  108. package/src/lib/tasks/lib/lint-with-oxlint/internal/read-tsgolint-rule-messages.ts +68 -0
  109. package/src/lib/tasks/lib/place-exports-in-the-narrowest-directory/index.ts +1 -0
  110. package/src/lib/tasks/lib/place-exports-in-the-narrowest-directory/internal/export-placement-errors.ts +135 -0
  111. package/src/lib/tasks/lib/place-exports-in-the-narrowest-directory/internal/find-export-placement-violations.ts +507 -0
  112. package/src/lib/tasks/lib/place-exports-in-the-narrowest-directory/internal/find-misplaced-files.ts +116 -0
  113. package/src/lib/tasks/lib/place-exports-in-the-narrowest-directory/internal/find-subdivided-directories.ts +29 -0
  114. package/src/lib/tasks/lib/place-exports-in-the-narrowest-directory/internal/find-the-importer-graph.ts +451 -0
  115. package/src/lib/tasks/lib/place-exports-in-the-narrowest-directory/internal/list-binding-names.ts +49 -0
  116. package/src/lib/tasks/lib/refuse-disable-directives/index.ts +15 -0
  117. package/src/lib/tasks/lib/refuse-disable-directives/internal/disable-directive-errors.ts +45 -0
  118. package/src/lib/tasks/lib/refuse-disable-directives/internal/find-disable-directives.ts +66 -0
  119. package/src/lib/tasks/lib/refuse-error-mappings-that-end-streams/index.ts +1 -0
  120. package/src/lib/tasks/lib/refuse-error-mappings-that-end-streams/internal/error-mapping-errors.ts +21 -0
  121. package/src/lib/tasks/lib/refuse-error-mappings-that-end-streams/internal/find-error-mappings-to-done.ts +135 -0
  122. package/src/lib/tasks/lib/require-separate-service-layers/index.ts +1 -0
  123. package/src/lib/tasks/lib/require-separate-service-layers/internal/find-service-layer-violations.ts +170 -0
  124. package/src/lib/tasks/lib/require-separate-service-layers/internal/service-layer-errors.ts +21 -0
  125. package/src/lib/tasks/lib/require-type-checking-every-linted-file/index.ts +14 -0
  126. package/src/lib/tasks/lib/require-type-checking-every-linted-file/internal/find-linted-files-not-type-checked.ts +117 -0
  127. package/src/lib/tasks/lib/require-type-checking-every-linted-file/internal/linted-file-errors.ts +51 -0
  128. package/src/lib/tasks/lib/type-check-with-bun-check/index.ts +11 -0
  129. package/src/lib/tasks/lib/type-check-with-bun-check/internal/check-types-with-bun-check.ts +54 -0
  130. package/src/lib/tasks/lib/type-check-with-bun-check/internal/read-bun-check-output.ts +73 -0
  131. package/src/lib/tasks/lib/type-check-with-bun-check/internal/type-check-errors.ts +10 -0
  132. package/src/lib/tasks/shared/check-each-nested-package.ts +79 -0
  133. package/src/lib/tasks/shared/classify-files-by-role.ts +115 -0
  134. package/src/lib/tasks/shared/count-the-line-of-an-offset.ts +2 -0
  135. package/src/lib/tasks/shared/create-the-module-resolver.ts +38 -0
  136. package/src/lib/tasks/shared/declare-lint-config-task.ts +13 -0
  137. package/src/lib/tasks/shared/declare-typescript-config-task.ts +18 -0
  138. package/src/lib/tasks/shared/encode-compact-json.ts +5 -0
  139. package/src/lib/tasks/shared/find-installed-package-binaries.ts +62 -0
  140. package/src/lib/tasks/shared/find-module-requests.ts +482 -0
  141. package/src/lib/tasks/shared/find-named-package-manifests.ts +94 -0
  142. package/src/lib/tasks/shared/find-unmet-typescript-config-requirements.ts +60 -0
  143. package/src/lib/tasks/shared/list-ignored-files-imported-by-source.ts +79 -0
  144. package/src/lib/tasks/shared/list-linted-files.ts +28 -0
  145. package/src/lib/tasks/shared/list-owned-files.ts +13 -0
  146. package/src/lib/tasks/shared/list-package-files.ts +66 -0
  147. package/src/lib/tasks/shared/load-the-lint-config.ts +176 -0
  148. package/src/lib/tasks/shared/match-granted-patch-files.ts +88 -0
  149. package/src/lib/tasks/shared/parse-config-files-that-import-from-check.ts +310 -0
  150. package/src/lib/tasks/shared/print-failures-and-keep-detail-in-the-trace.ts +99 -0
  151. package/src/lib/tasks/shared/project-config-and-tool-errors.ts +485 -0
  152. package/src/lib/tasks/shared/query-the-typescript-project.ts +635 -0
  153. package/src/lib/tasks/shared/read-named-package-manifests.ts +53 -0
  154. package/src/lib/tasks/shared/read-package-manifest-object.ts +28 -0
  155. package/src/lib/tasks/shared/resolve-absolute-paths.ts +4 -0
  156. package/src/lib/tasks/shared/resolve-module-requests.ts +121 -0
  157. package/src/lib/tasks/shared/run-tools-and-decode-their-reports.ts +98 -0
  158. package/src/lib/tasks/shared/tool-file-locations.ts +38 -0
  159. package/src/shared/bans-each-permission-lifts.ts +454 -0
  160. package/src/shared/config-file-names.ts +3 -0
  161. package/src/shared/find-retired-words.ts +17 -0
  162. package/src/shared/format-reported-failures.ts +31 -0
  163. package/src/shared/lint-rule-messages-and-patterns.ts +104 -0
  164. package/src/shared/match-file-names-and-path-prefixes.ts +18 -0
  165. package/src/shared/permission-grant-errors.ts +42 -0
  166. package/src/shared/record-and-grant-permissions-by-path.ts +419 -0
  167. package/src/shared/test-home-directories.ts +4 -0
@@ -0,0 +1,512 @@
1
+ import { defineRule } from "@oxlint/plugins";
2
+ import type { Context, ESTree, SourceCode, Visitor } from "@oxlint/plugins";
3
+ import { Schema } from "effect";
4
+
5
+ import {
6
+ BANS_NO_GRANT_LIFTS,
7
+ bansNoGrantLifts,
8
+ CREATE_REQUIRE_VALUE_USAGE,
9
+ CREATED_REQUIRE_USAGE,
10
+ IMPORT_META,
11
+ moduleSpecifiersOfGlobalObject,
12
+ PERMISSION_BANS,
13
+ } from "../shared/bans-each-permission-lifts.ts";
14
+ import type { importsBan } from "../shared/bans-each-permission-lifts.ts";
15
+ import { decodeRuleOptions, ruleOptionsJsonSchema } from "./describe-and-decode-rule-options.ts";
16
+ import {
17
+ bansByKind,
18
+ importBansEquivalentToGlobalMembers,
19
+ isBannedByANodeBuiltinRule,
20
+ moduleBansMatcher,
21
+ modulePatternMatcher,
22
+ } from "./match-banned-modules-and-globals.ts";
23
+ import {
24
+ effectModuleReference,
25
+ DEFAULT_EXPORT,
26
+ importedExpression,
27
+ importsOnlyTypes,
28
+ isGlobalReference,
29
+ isMemberExpressionObject,
30
+ isReferencePosition,
31
+ isValueOperandOfTypeScriptOrExport,
32
+ memberName,
33
+ moduleExportName,
34
+ propertyKeyName,
35
+ resolvedVariable,
36
+ staticKeyName,
37
+ unwrappedExpression,
38
+ } from "./resolve-what-an-expression-imports.ts";
39
+
40
+ const importBansMatcher = (importBans: readonly ReturnType<typeof importsBan>[]) => {
41
+ const entries = importBans.map((ban) => ({
42
+ matchesModule: modulePatternMatcher(ban.modulePattern),
43
+ importNames: ban.importNames,
44
+ }));
45
+ return (specifier: string, name: string) =>
46
+ entries.find((entry) => entry.importNames.includes(name) && entry.matchesModule(specifier));
47
+ };
48
+
49
+ const dottedPath = (path: readonly string[]) => path.join(".");
50
+
51
+ const specifierImportedName = (specifier: ESTree.ImportDeclaration["specifiers"][number]) => {
52
+ if (specifier.type !== "ImportSpecifier") {
53
+ return;
54
+ }
55
+ return moduleExportName(specifier.imported);
56
+ };
57
+
58
+ const WHOLE_MODULE_IMPORTS = new Set(["ImportDefaultSpecifier", "ImportNamespaceSpecifier"]);
59
+
60
+ const isWholeModuleImportOf = (
61
+ node: ESTree.Node,
62
+ sourceCode: SourceCode,
63
+ moduleSpecifiers: readonly string[],
64
+ ) => {
65
+ const definition = resolvedVariable(node, sourceCode)?.defs[0]?.node;
66
+ if (definition?.parent?.type !== "ImportDeclaration") {
67
+ return false;
68
+ }
69
+ const importsWholeModule =
70
+ WHOLE_MODULE_IMPORTS.has(definition.type) ||
71
+ (definition.type === "ImportSpecifier" && specifierImportedName(definition) === DEFAULT_EXPORT);
72
+ return importsWholeModule && moduleSpecifiers.includes(definition.parent.source.value);
73
+ };
74
+
75
+ const isImportMeta = (node: ESTree.Node) =>
76
+ node.type === "MetaProperty" && node.meta.name === "import" && node.property.name === "meta";
77
+
78
+ const constantInitializer = (node: ESTree.Node, sourceCode: SourceCode) => {
79
+ const definitions = resolvedVariable(node, sourceCode)?.defs ?? [];
80
+ const declarator = definitions.length === 1 ? definitions[0]?.node : undefined;
81
+ const isConstantDeclarator =
82
+ declarator?.type === "VariableDeclarator" &&
83
+ declarator.id.type === "Identifier" &&
84
+ declarator.parent.type === "VariableDeclaration" &&
85
+ declarator.parent.kind === "const";
86
+ return isConstantDeclarator ? (declarator.init ?? undefined) : undefined;
87
+ };
88
+
89
+ const constantKeyName = (
90
+ key: ESTree.Node,
91
+ sourceCode: SourceCode,
92
+ followedAliases: Set<ESTree.Node> = new Set(),
93
+ ): string | undefined => {
94
+ const unwrapped = unwrappedExpression(key);
95
+ if (unwrapped.type !== "Identifier") {
96
+ return staticKeyName(unwrapped);
97
+ }
98
+ const initializer = constantInitializer(unwrapped, sourceCode);
99
+ const isFollowedOrMissing = initializer === undefined || followedAliases.has(initializer);
100
+ if (isFollowedOrMissing) {
101
+ return;
102
+ }
103
+ followedAliases.add(initializer);
104
+ return constantKeyName(initializer, sourceCode, followedAliases);
105
+ };
106
+
107
+ const memberNameOrConstantKey = (node: ESTree.MemberExpression, sourceCode: SourceCode) =>
108
+ memberName(node) ?? (node.computed ? constantKeyName(node.property, sourceCode) : undefined);
109
+
110
+ const propertyKeyNameOrConstantKey = (property: ESTree.Node, sourceCode: SourceCode) => {
111
+ const name = propertyKeyName(property);
112
+ const isComputedProperty =
113
+ name === undefined && property.type === "Property" && property.computed;
114
+ return isComputedProperty ? constantKeyName(property.key, sourceCode) : name;
115
+ };
116
+
117
+ const isGlobalObjectReference = (
118
+ expression: ESTree.Node,
119
+ sourceCode: SourceCode,
120
+ globalObject: string,
121
+ followedAliases: Set<ESTree.Node> = new Set(),
122
+ ): boolean => {
123
+ const node = unwrappedExpression(expression);
124
+ if (globalObject === IMPORT_META) {
125
+ return isImportMeta(node);
126
+ }
127
+ if (isGlobalReference(node, sourceCode, globalObject)) {
128
+ return true;
129
+ }
130
+ const moduleSpecifiers = moduleSpecifiersOfGlobalObject(globalObject);
131
+ const isWholeModuleImport =
132
+ moduleSpecifiers.length > 0 &&
133
+ node.type === "Identifier" &&
134
+ isWholeModuleImportOf(node, sourceCode, moduleSpecifiers);
135
+ if (isWholeModuleImport) {
136
+ return true;
137
+ }
138
+ const aliased = constantInitializer(node, sourceCode);
139
+ const isUnfollowedAlias = aliased !== undefined && !followedAliases.has(aliased);
140
+ return (
141
+ isUnfollowedAlias &&
142
+ isGlobalObjectReference(
143
+ aliased,
144
+ sourceCode,
145
+ globalObject,
146
+ new Set([...followedAliases, aliased]),
147
+ )
148
+ );
149
+ };
150
+
151
+ const mergedVisitors = (visitors: readonly Visitor[]): Visitor => {
152
+ const handlers = new Map<string, ((node: never) => void)[]>();
153
+ for (const visitor of visitors) {
154
+ for (const [key, handler] of Object.entries(visitor)) {
155
+ if (handler !== undefined) {
156
+ handlers.set(key, [...(handlers.get(key) ?? []), handler]);
157
+ }
158
+ }
159
+ }
160
+ return Object.fromEntries(
161
+ Array.from(handlers, ([key, keyHandlers]) => [
162
+ key,
163
+ (node: never) => {
164
+ for (const handler of keyHandlers) {
165
+ handler(node);
166
+ }
167
+ },
168
+ ]),
169
+ );
170
+ };
171
+
172
+ const TYPESCRIPT_WRAPPERS: ReadonlySet<string> = new Set([
173
+ "TSAsExpression",
174
+ "TSSatisfiesExpression",
175
+ "TSNonNullExpression",
176
+ "TSTypeAssertion",
177
+ ]);
178
+
179
+ const outermostTypeScriptWrapper = (node: ESTree.Node): ESTree.Node => {
180
+ const { parent } = node;
181
+ const isWrapped =
182
+ parent !== null &&
183
+ TYPESCRIPT_WRAPPERS.has(parent.type) &&
184
+ "expression" in parent &&
185
+ parent.expression === node;
186
+ return isWrapped ? outermostTypeScriptWrapper(parent) : node;
187
+ };
188
+
189
+ const createdRequireVisitors = (
190
+ context: Context,
191
+ createdRequires: readonly {
192
+ readonly matchesModule: (specifier: string) => boolean;
193
+ readonly importNames: readonly string[];
194
+ readonly exceptMemberNames: readonly string[];
195
+ }[],
196
+ report: (node: ESTree.Node, usage: string) => void,
197
+ ): Visitor => {
198
+ const { sourceCode } = context;
199
+ const createdRequireBanOf = (node: ESTree.Node) => {
200
+ const imported = importedExpression(node, sourceCode);
201
+ if (imported === undefined) {
202
+ return;
203
+ }
204
+ const name = dottedPath(imported.members);
205
+ return createdRequires.find(
206
+ (ban) => ban.importNames.includes(name) && ban.matchesModule(imported.module),
207
+ );
208
+ };
209
+ const isExceptedMemberOf = (
210
+ node: ESTree.Node,
211
+ ban: NonNullable<ReturnType<typeof createdRequireBanOf>>,
212
+ ) => {
213
+ const outer = outermostTypeScriptWrapper(node);
214
+ const { parent } = outer;
215
+ const isObjectOfAMember = parent?.type === "MemberExpression" && parent.object === outer;
216
+ if (!isObjectOfAMember) {
217
+ return false;
218
+ }
219
+ const name = memberNameOrConstantKey(parent, sourceCode);
220
+ return name !== undefined && ban.exceptMemberNames.includes(name);
221
+ };
222
+ const usesOnlyExceptedMembers = (
223
+ call: ESTree.Node,
224
+ ban: NonNullable<ReturnType<typeof createdRequireBanOf>>,
225
+ ) => {
226
+ if (isExceptedMemberOf(call, ban)) {
227
+ return true;
228
+ }
229
+ const declarator = outermostTypeScriptWrapper(call).parent;
230
+ const isUnexportedConstantBinding =
231
+ declarator?.type === "VariableDeclarator" &&
232
+ declarator.id.type === "Identifier" &&
233
+ declarator.parent.type === "VariableDeclaration" &&
234
+ declarator.parent.kind === "const" &&
235
+ declarator.parent.parent.type !== "ExportNamedDeclaration";
236
+ if (!isUnexportedConstantBinding) {
237
+ return false;
238
+ }
239
+ const declared = sourceCode.getDeclaredVariables(declarator)[0];
240
+ return (declared?.references ?? [])
241
+ .filter((reference) => reference.identifier !== declarator.id)
242
+ .every((reference) => isExceptedMemberOf(reference.identifier, ban));
243
+ };
244
+ const checkReference = (node: ESTree.Node) => {
245
+ const ban = createdRequireBanOf(node);
246
+ if (ban === undefined) {
247
+ return;
248
+ }
249
+ const outer = outermostTypeScriptWrapper(node);
250
+ const call = outer.parent;
251
+ const isCalled = call?.type === "CallExpression" && call.callee === outer;
252
+ if (!isCalled) {
253
+ report(node, CREATE_REQUIRE_VALUE_USAGE);
254
+ return;
255
+ }
256
+ if (!usesOnlyExceptedMembers(call, ban)) {
257
+ report(call, CREATED_REQUIRE_USAGE);
258
+ }
259
+ };
260
+ return createdRequires.length === 0
261
+ ? {}
262
+ : {
263
+ Identifier(node) {
264
+ const isValueReference =
265
+ isReferencePosition(node) ||
266
+ isMemberExpressionObject(node) ||
267
+ isValueOperandOfTypeScriptOrExport(node, node.parent);
268
+ if (isValueReference) {
269
+ checkReference(node);
270
+ }
271
+ },
272
+ MemberExpression(node) {
273
+ checkReference(node);
274
+ },
275
+ };
276
+ };
277
+
278
+ const compiledBans = (bans: Parameters<typeof bansByKind>[0]) => {
279
+ const bansOfEachKind = bansByKind(bans);
280
+ const createdRequires = bansOfEachKind.createdRequire.map((ban) => ({
281
+ matchesModule: modulePatternMatcher(ban.modulePattern),
282
+ importNames: ban.importNames,
283
+ exceptMemberNames: ban.exceptMemberNames,
284
+ }));
285
+ const isBannedModule = moduleBansMatcher(bansOfEachKind.module);
286
+ const bannedImport = importBansMatcher([
287
+ ...bansOfEachKind.imports,
288
+ ...importBansEquivalentToGlobalMembers(bans),
289
+ ]);
290
+ const globalMembers = bansOfEachKind.globalMembers.flatMap((ban) =>
291
+ ban.memberNames.map((name) => ({ globalObject: ban.globalObject, memberName: name })),
292
+ );
293
+ const effectMemberBans = bansOfEachKind.effectMembers.flatMap((ban) =>
294
+ ban.memberPathPrefixes.map((memberPathPrefix) => ({
295
+ effectModule: memberPathPrefix[0],
296
+ dottedPrefix: dottedPath(memberPathPrefix),
297
+ dottedExceptions: ban.exceptExactMemberPaths.map(dottedPath),
298
+ })),
299
+ );
300
+ const effectModules = [...new Set(effectMemberBans.map((ban) => ban.effectModule))];
301
+ const bansDynamicImports = bansOfEachKind.dynamicImport.length > 0;
302
+ const bannedMemberNames = new Set(bansOfEachKind.memberNames.flatMap((ban) => ban.memberNames));
303
+
304
+ const isBannedEffectUsage = (usage: string | undefined) =>
305
+ usage !== undefined &&
306
+ effectMemberBans.some(
307
+ (ban) =>
308
+ (usage === ban.dottedPrefix || usage.startsWith(`${ban.dottedPrefix}.`)) &&
309
+ !ban.dottedExceptions.includes(usage),
310
+ );
311
+
312
+ return {
313
+ isBannedModule,
314
+ bannedImport,
315
+ globalMembers,
316
+ effectModules,
317
+ bansDynamicImports,
318
+ bannedMemberNames,
319
+ isBannedEffectUsage,
320
+ createdRequires,
321
+ };
322
+ };
323
+
324
+ const banVisitors = (
325
+ context: Context,
326
+ {
327
+ isBannedModule,
328
+ bannedImport,
329
+ globalMembers,
330
+ effectModules,
331
+ bansDynamicImports,
332
+ bannedMemberNames,
333
+ isBannedEffectUsage,
334
+ createdRequires,
335
+ }: ReturnType<typeof compiledBans>,
336
+ messageId: "banned" | "bannedEvenWhenGranted",
337
+ ): Visitor => {
338
+ const report = (node: ESTree.Node, usage: string) => {
339
+ context.report({ node, messageId, data: { usage } });
340
+ };
341
+
342
+ const reportImport = (node: ESTree.Node, specifier: string, name: string) => {
343
+ const ban = bannedImport(specifier, name);
344
+ if (ban === undefined) {
345
+ return false;
346
+ }
347
+ report(node, `${name} from ${specifier}`);
348
+ return true;
349
+ };
350
+
351
+ const globalMemberUsage = (object: ESTree.Node, property: string) =>
352
+ globalMembers.find(
353
+ (member) =>
354
+ member.memberName === property &&
355
+ isGlobalObjectReference(object, context.sourceCode, member.globalObject),
356
+ );
357
+
358
+ const effectReference = (node: ESTree.Node) => {
359
+ const usage = effectModules
360
+ .map((effectModule) => effectModuleReference(node, context.sourceCode, effectModule))
361
+ .find((candidate) => isBannedEffectUsage(candidate));
362
+ if (usage !== undefined) {
363
+ report(node, usage);
364
+ }
365
+ return usage !== undefined;
366
+ };
367
+
368
+ const checkSource = (
369
+ source: ESTree.StringLiteral,
370
+ names: readonly { readonly node: ESTree.Node; readonly name: string | undefined }[],
371
+ ) => {
372
+ if (
373
+ isBannedModule(
374
+ source.value,
375
+ names.map(({ name }) => name),
376
+ )
377
+ ) {
378
+ report(source, source.value);
379
+ return;
380
+ }
381
+ for (const { node, name } of names) {
382
+ if (name !== undefined) {
383
+ reportImport(node, source.value, name);
384
+ }
385
+ }
386
+ };
387
+
388
+ const importAndMemberVisitors = {
389
+ ImportDeclaration(node) {
390
+ const valueSpecifiers = node.specifiers.filter(
391
+ (specifier) => specifier.type !== "ImportSpecifier" || specifier.importKind !== "type",
392
+ );
393
+ if (importsOnlyTypes(node, context.sourceCode)) {
394
+ return;
395
+ }
396
+ checkSource(
397
+ node.source,
398
+ valueSpecifiers.map((specifier) => ({
399
+ node: specifier,
400
+ name: specifierImportedName(specifier),
401
+ })),
402
+ );
403
+ },
404
+ ImportExpression(node) {
405
+ const source = staticKeyName(node.source);
406
+ const loadsBannedModule = source !== undefined && isBannedModule(source, []);
407
+ if (loadsBannedModule) {
408
+ report(node.source, source);
409
+ }
410
+ const isLeftToTheModuleBan = source !== undefined && isBannedByANodeBuiltinRule(source);
411
+ const reportsDynamicImport = bansDynamicImports && !isLeftToTheModuleBan;
412
+ if (reportsDynamicImport) {
413
+ report(node, "dynamic import()");
414
+ }
415
+ },
416
+ Identifier(node) {
417
+ effectReference(node);
418
+ },
419
+ MemberExpression(node) {
420
+ if (effectReference(node)) {
421
+ return;
422
+ }
423
+ const property = memberNameOrConstantKey(node, context.sourceCode);
424
+ if (property === undefined) {
425
+ return;
426
+ }
427
+ const member = globalMemberUsage(node.object, property);
428
+ if (member !== undefined) {
429
+ report(node, `${member.globalObject}.${member.memberName}`);
430
+ return;
431
+ }
432
+ const imported = importedExpression(node, context.sourceCode);
433
+ const reportedImport =
434
+ imported !== undefined && reportImport(node, imported.module, dottedPath(imported.members));
435
+ const isUnreportedBannedMemberName = !reportedImport && bannedMemberNames.has(property);
436
+ if (isUnreportedBannedMemberName) {
437
+ report(node, property);
438
+ }
439
+ },
440
+ ObjectPattern(node) {
441
+ const declarator = node.parent;
442
+ const isDestructuredInDeclaration =
443
+ declarator.type === "VariableDeclarator" && declarator.id === node;
444
+ const declaredFrom = isDestructuredInDeclaration ? declarator.init : null;
445
+ const imported =
446
+ declaredFrom === null ? undefined : importedExpression(declaredFrom, context.sourceCode);
447
+ for (const property of node.properties) {
448
+ const key = propertyKeyNameOrConstantKey(property, context.sourceCode);
449
+ if (key === undefined) {
450
+ continue;
451
+ }
452
+ const member = declaredFrom === null ? undefined : globalMemberUsage(declaredFrom, key);
453
+ if (member !== undefined) {
454
+ report(property, `${member.globalObject}.${member.memberName}`);
455
+ continue;
456
+ }
457
+ const reportedImport =
458
+ imported !== undefined &&
459
+ reportImport(property, imported.module, dottedPath([...imported.members, key]));
460
+ const isUnreportedBannedMemberName =
461
+ declaredFrom !== null && !reportedImport && bannedMemberNames.has(key);
462
+ if (isUnreportedBannedMemberName) {
463
+ report(property, key);
464
+ }
465
+ }
466
+ },
467
+ } satisfies Visitor;
468
+ return mergedVisitors([
469
+ createdRequireVisitors(context, createdRequires, report),
470
+ importAndMemberVisitors,
471
+ ]);
472
+ };
473
+
474
+ const BAN_OPTIONS = Schema.Struct({
475
+ bans: Schema.optionalKey(Schema.Literals(["all", BANS_NO_GRANT_LIFTS])),
476
+ });
477
+
478
+ export const permissionBanRule = (permission: keyof typeof PERMISSION_BANS) => {
479
+ const entry = PERMISSION_BANS[permission];
480
+ const { description, message } = entry;
481
+ const liftedByAGrant = compiledBans(entry.bans);
482
+ const liftedByNoGrant = compiledBans(bansNoGrantLifts(permission));
483
+ const liftedByNoGrantBeyondTheGrantableImports = compiledBans(
484
+ bansNoGrantLifts(permission).filter((ban) => ban.kind !== "created-require"),
485
+ );
486
+ const messageEvenWhenGranted =
487
+ "bannedEvenWhenGranted" in entry ? entry.bannedEvenWhenGranted.message : message;
488
+
489
+ return defineRule({
490
+ meta: {
491
+ type: "problem",
492
+ docs: { description },
493
+ messages: {
494
+ banned: message,
495
+ bannedEvenWhenGranted: messageEvenWhenGranted,
496
+ },
497
+ schema: ruleOptionsJsonSchema(BAN_OPTIONS),
498
+ },
499
+ create(context) {
500
+ const isGranted =
501
+ decodeRuleOptions(BAN_OPTIONS, context.options)?.bans === BANS_NO_GRANT_LIFTS;
502
+ return mergedVisitors([
503
+ ...(isGranted ? [] : [banVisitors(context, liftedByAGrant, "banned")]),
504
+ banVisitors(
505
+ context,
506
+ isGranted ? liftedByNoGrant : liftedByNoGrantBeyondTheGrantableImports,
507
+ "bannedEvenWhenGranted",
508
+ ),
509
+ ]);
510
+ },
511
+ });
512
+ };
@@ -0,0 +1,27 @@
1
+ import { defineRule } from "@oxlint/plugins";
2
+
3
+ export const noWhile = defineRule({
4
+ meta: {
5
+ type: "suggestion",
6
+ docs: {
7
+ description:
8
+ "Write loops as for...of over a known sequence, so no loop runs on a condition or counter that outside state must change.",
9
+ },
10
+ messages: {
11
+ conditionLoop: "{{loop}} loops on a condition or counter that outside state must change",
12
+ },
13
+ },
14
+ create(context) {
15
+ return {
16
+ WhileStatement(node) {
17
+ context.report({ node, messageId: "conditionLoop", data: { loop: "while" } });
18
+ },
19
+ DoWhileStatement(node) {
20
+ context.report({ node, messageId: "conditionLoop", data: { loop: "do...while" } });
21
+ },
22
+ ForStatement(node) {
23
+ context.report({ node, messageId: "conditionLoop", data: { loop: "for" } });
24
+ },
25
+ };
26
+ },
27
+ });
@@ -0,0 +1,116 @@
1
+ import { defineRule } from "@oxlint/plugins";
2
+ import type { ESTree } from "@oxlint/plugins";
3
+ import { Schema } from "effect";
4
+
5
+ import { decodeRuleOptions, ruleOptionsJsonSchema } from "./describe-and-decode-rule-options.ts";
6
+ import { serviceFactoryOf } from "./match-effect-service-factories.ts";
7
+
8
+ const SERVICE_OPTIONS = Schema.Struct({
9
+ services: Schema.optionalKey(Schema.Array(Schema.String)),
10
+ });
11
+
12
+ const serviceNameAbove = (
13
+ child: ESTree.Node,
14
+ ancestor: ESTree.Node | null | undefined,
15
+ ): string | undefined => {
16
+ if (!ancestor) {
17
+ return undefined;
18
+ }
19
+ const isClass = ancestor.type === "ClassDeclaration" || ancestor.type === "ClassExpression";
20
+ if (isClass) {
21
+ if (ancestor.superClass === child) {
22
+ return ancestor.id?.name;
23
+ }
24
+ return undefined;
25
+ }
26
+ if (ancestor.type === "VariableDeclarator") {
27
+ return ancestor.id.type === "Identifier" ? ancestor.id.name : undefined;
28
+ }
29
+ const passesTheFactoryThrough =
30
+ ancestor.type === "CallExpression" ||
31
+ ancestor.type === "MemberExpression" ||
32
+ ancestor.type === "TSInstantiationExpression";
33
+ if (!passesTheFactoryThrough) {
34
+ return undefined;
35
+ }
36
+ return serviceNameAbove(ancestor, ancestor.parent);
37
+ };
38
+
39
+ const declaredServiceName = (factory: ESTree.Node) => serviceNameAbove(factory, factory.parent);
40
+
41
+ const grantedServices = (options: readonly unknown[]) =>
42
+ decodeRuleOptions(SERVICE_OPTIONS, options)?.services;
43
+
44
+ export const noServiceDeclarations = defineRule({
45
+ meta: {
46
+ type: "problem",
47
+ docs: {
48
+ description:
49
+ "Declare Effect services only in files granted them by exact name with lintConfig({ [file]: { services: [names] } }).",
50
+ },
51
+ messages: {
52
+ service: "Context.{{factory}} declares service {{name}} outside a services file",
53
+ anonymousService: "Context.{{factory}} declares a service outside a services file",
54
+ unlisted: "Context.{{factory}} declares unlisted service {{name}}",
55
+ unnamed: "Context.{{factory}} declares a service without a class name",
56
+ },
57
+ schema: ruleOptionsJsonSchema(SERVICE_OPTIONS),
58
+ },
59
+ create(context) {
60
+ const granted = grantedServices(context.options);
61
+ const checkFactory = (node: ESTree.Node) => {
62
+ const factory = serviceFactoryOf(node, context.sourceCode);
63
+ if (factory === undefined) {
64
+ return;
65
+ }
66
+ const name = declaredServiceName(node);
67
+ if (granted === undefined) {
68
+ context.report(
69
+ name === undefined
70
+ ? { node, messageId: "anonymousService", data: { factory } }
71
+ : { node, messageId: "service", data: { factory, name } },
72
+ );
73
+ } else if (name === undefined) {
74
+ context.report({ node, messageId: "unnamed", data: { factory } });
75
+ } else if (!granted.includes(name)) {
76
+ context.report({ node, messageId: "unlisted", data: { factory, name } });
77
+ }
78
+ };
79
+ return { MemberExpression: checkFactory, Identifier: checkFactory };
80
+ },
81
+ });
82
+
83
+ export const noUnusedServiceGrants = defineRule({
84
+ meta: {
85
+ type: "problem",
86
+ docs: {
87
+ description: "Declare every service a file is granted in lintConfig.",
88
+ },
89
+ messages: {
90
+ missing: "granted service {{name}} is not declared here",
91
+ },
92
+ schema: ruleOptionsJsonSchema(SERVICE_OPTIONS),
93
+ },
94
+ create(context) {
95
+ const granted = grantedServices(context.options) ?? [];
96
+ const declared = new Set<string>();
97
+ const recordFactory = (node: ESTree.Node) => {
98
+ const name =
99
+ serviceFactoryOf(node, context.sourceCode) === undefined
100
+ ? undefined
101
+ : declaredServiceName(node);
102
+ if (name !== undefined) {
103
+ declared.add(name);
104
+ }
105
+ };
106
+ return {
107
+ MemberExpression: recordFactory,
108
+ Identifier: recordFactory,
109
+ "Program:exit"(node) {
110
+ for (const name of granted.filter((candidate) => !declared.has(candidate))) {
111
+ context.report({ node, messageId: "missing", data: { name } });
112
+ }
113
+ },
114
+ };
115
+ },
116
+ });