@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.
- package/LICENSE +21 -0
- package/README.md +156 -2
- package/docs/how-to-make-check-pass.md +71 -0
- package/package.json +51 -4
- package/src/index.ts +8 -0
- package/src/internal/ban-abbreviated-words-in-declared-names.ts +165 -0
- package/src/internal/ban-checked-members-outside-calls.ts +151 -0
- package/src/internal/ban-comments.ts +23 -0
- package/src/internal/ban-comparing-or-switching-on-tag.ts +114 -0
- package/src/internal/ban-deadlines-inside-tests.ts +41 -0
- package/src/internal/ban-declared-values.ts +70 -0
- package/src/internal/ban-dropped-failures-detached-fibers-sleeps-and-untraced-functions.ts +67 -0
- package/src/internal/ban-failures-collected-as-results.ts +57 -0
- package/src/internal/ban-fallbacks-of-named-recoveries.ts +118 -0
- package/src/internal/ban-function-overloads.ts +107 -0
- package/src/internal/ban-global-error-in-failure-types.ts +146 -0
- package/src/internal/ban-instanceof-in-effect-recovery-callbacks.ts +63 -0
- package/src/internal/ban-let-and-effect-mutable-ref.ts +79 -0
- package/src/internal/ban-logic-in-index-files.ts +178 -0
- package/src/internal/ban-namespaces-used-without-a-member.ts +176 -0
- package/src/internal/ban-node-builtins-that-effect-replaces.ts +42 -0
- package/src/internal/ban-parsing-outside-data-without-a-schema.ts +299 -0
- package/src/internal/ban-re-exports.ts +172 -0
- package/src/internal/ban-reading-the-clock-and-sleeping-outside-effect.ts +239 -0
- package/src/internal/ban-retired-words-in-names.ts +49 -0
- package/src/internal/ban-scanning-directories-with-bun-glob.ts +79 -0
- package/src/internal/ban-shebang-lines.ts +26 -0
- package/src/internal/ban-timer-globals-and-the-global-object.ts +34 -0
- package/src/internal/ban-timer-schedules-without-deadlines.ts +240 -0
- package/src/internal/ban-type-and-interface-declarations.ts +48 -0
- package/src/internal/ban-type-predicates.ts +82 -0
- package/src/internal/ban-unknown-in-function-signatures.ts +143 -0
- package/src/internal/ban-vague-error-class-names.ts +28 -0
- package/src/internal/ban-vague-file-names.ts +51 -0
- package/src/internal/ban-what-a-file-is-not-granted.ts +512 -0
- package/src/internal/ban-while-do-while-and-for-loops.ts +27 -0
- package/src/internal/confine-service-declarations-to-granted-files.ts +116 -0
- package/src/internal/confine-the-stdio-service-to-terminal-output.ts +190 -0
- package/src/internal/define-the-lint-plugin-and-configs.ts +361 -0
- package/src/internal/describe-and-decode-rule-options.ts +22 -0
- package/src/internal/keep-assertions-in-the-test-home-and-ban-test-runners.ts +128 -0
- package/src/internal/keep-effect-testing-helpers-in-test-files.ts +157 -0
- package/src/internal/match-banned-modules-and-globals.ts +71 -0
- package/src/internal/match-effect-service-factories.ts +20 -0
- package/src/internal/require-a-named-const-for-compound-conditions.ts +44 -0
- package/src/internal/require-capital-snake-case-and-as-const-on-literal-constants.ts +141 -0
- package/src/internal/require-service-keys-to-end-with-their-class-name.ts +64 -0
- package/src/internal/resolve-what-an-expression-imports.ts +295 -0
- package/src/internal/sort-type-constituents.ts +82 -0
- package/src/internal/split-names-into-words.ts +12 -0
- package/src/internal/visit-every-declared-name.ts +264 -0
- package/src/lib/tasks/index.ts +1 -0
- package/src/lib/tasks/internal/declare-the-check-task.ts +29 -0
- package/src/lib/tasks/internal/declare-the-checker-queries-task.ts +41 -0
- package/src/lib/tasks/internal/declare-the-typed-checks-task.ts +25 -0
- package/src/lib/tasks/internal/run-checks-over-one-typescript-project.ts +68 -0
- package/src/lib/tasks/lib/check-effect-diagnostics-with-effect-tsgo/index.ts +15 -0
- package/src/lib/tasks/lib/check-effect-diagnostics-with-effect-tsgo/internal/check-effect-diagnostics-with-effect-tsgo.ts +211 -0
- package/src/lib/tasks/lib/check-effect-diagnostics-with-effect-tsgo/internal/read-effect-tsgo-json-report.ts +39 -0
- package/src/lib/tasks/lib/check-import-boundaries/index.ts +1 -0
- package/src/lib/tasks/lib/check-import-boundaries/internal/find-import-boundary-violations.ts +415 -0
- package/src/lib/tasks/lib/check-import-boundaries/internal/find-subpath-import-targets.ts +117 -0
- package/src/lib/tasks/lib/check-import-boundaries/internal/find-what-hides-an-import.ts +65 -0
- package/src/lib/tasks/lib/check-import-boundaries/internal/import-boundary-errors.ts +176 -0
- package/src/lib/tasks/lib/check-uses-by-their-declarations/index.ts +1 -0
- package/src/lib/tasks/lib/check-uses-by-their-declarations/internal/declared-use-errors.ts +32 -0
- package/src/lib/tasks/lib/check-uses-by-their-declarations/internal/find-declared-use-violations.ts +38 -0
- package/src/lib/tasks/lib/check-uses-by-their-declarations/internal/find-sync-calls.ts +23 -0
- package/src/lib/tasks/lib/check-uses-by-their-declarations/internal/find-type-only-schemas.ts +375 -0
- package/src/lib/tasks/lib/confine-layer-provides-to-program-starts/index.ts +1 -0
- package/src/lib/tasks/lib/confine-layer-provides-to-program-starts/internal/find-layer-provides-outside-program-starts.ts +648 -0
- package/src/lib/tasks/lib/confine-layer-provides-to-program-starts/internal/layer-provide-errors.ts +27 -0
- package/src/lib/tasks/lib/confine-layer-provides-to-program-starts/internal/resolve-imported-package-apis.ts +262 -0
- package/src/lib/tasks/lib/confine-stdio-to-granted-files/index.ts +1 -0
- package/src/lib/tasks/lib/confine-stdio-to-granted-files/internal/find-ungranted-stdio-uses.ts +219 -0
- package/src/lib/tasks/lib/confine-stdio-to-granted-files/internal/stdio-use-errors.ts +31 -0
- package/src/lib/tasks/lib/detect-inferrable-annotations/index.ts +1 -0
- package/src/lib/tasks/lib/detect-inferrable-annotations/internal/find-inferrable-annotations.ts +357 -0
- package/src/lib/tasks/lib/detect-inferrable-annotations/internal/inferrable-annotation-errors.ts +33 -0
- package/src/lib/tasks/lib/detect-repeated-service-yields/index.ts +1 -0
- package/src/lib/tasks/lib/detect-repeated-service-yields/internal/find-repeated-service-yields.ts +162 -0
- package/src/lib/tasks/lib/detect-repeated-service-yields/internal/repeated-service-yield-errors.ts +25 -0
- package/src/lib/tasks/lib/enforce-file-layout/index.ts +5 -0
- package/src/lib/tasks/lib/enforce-file-layout/internal/check-the-layout-of-each-package.ts +9 -0
- package/src/lib/tasks/lib/enforce-file-layout/internal/file-layout-errors.ts +417 -0
- package/src/lib/tasks/lib/enforce-file-layout/internal/find-export-path-mismatches.ts +83 -0
- package/src/lib/tasks/lib/enforce-file-layout/internal/find-file-layout-violations.ts +848 -0
- package/src/lib/tasks/lib/enforce-file-layout/internal/find-module-layout-violations.ts +82 -0
- package/src/lib/tasks/lib/enforce-file-layout/internal/resolve-task-imports.ts +178 -0
- package/src/lib/tasks/lib/enforce-file-types/index.ts +5 -0
- package/src/lib/tasks/lib/enforce-file-types/internal/file-type-errors.ts +21 -0
- package/src/lib/tasks/lib/enforce-file-types/internal/find-file-type-violations.ts +78 -0
- package/src/lib/tasks/lib/format-with-bun-fmt/index.ts +1 -0
- package/src/lib/tasks/lib/format-with-bun-fmt/internal/check-formatting-with-bun-fmt.ts +157 -0
- package/src/lib/tasks/lib/format-with-bun-fmt/internal/declare-the-formatting-task.ts +66 -0
- package/src/lib/tasks/lib/format-with-bun-fmt/internal/find-format-config-violations.ts +16 -0
- package/src/lib/tasks/lib/format-with-bun-fmt/internal/find-format-input-violations.ts +74 -0
- package/src/lib/tasks/lib/format-with-bun-fmt/internal/find-symbolic-links.ts +14 -0
- package/src/lib/tasks/lib/format-with-bun-fmt/internal/unformatted-file-errors.ts +12 -0
- package/src/lib/tasks/lib/judge-index-re-exports/index.ts +1 -0
- package/src/lib/tasks/lib/judge-index-re-exports/internal/find-index-re-export-violations.ts +353 -0
- package/src/lib/tasks/lib/judge-index-re-exports/internal/index-re-export-errors.ts +21 -0
- package/src/lib/tasks/lib/lint-with-oxlint/index.ts +15 -0
- package/src/lib/tasks/lib/lint-with-oxlint/internal/check-lint-rules-with-oxlint.ts +123 -0
- package/src/lib/tasks/lib/lint-with-oxlint/internal/check-unsafe-enum-assignments.ts +152 -0
- package/src/lib/tasks/lib/lint-with-oxlint/internal/find-tsgolint-executable.ts +21 -0
- package/src/lib/tasks/lib/lint-with-oxlint/internal/read-oxlint-json-report.ts +82 -0
- package/src/lib/tasks/lib/lint-with-oxlint/internal/read-tsgolint-rule-messages.ts +68 -0
- package/src/lib/tasks/lib/place-exports-in-the-narrowest-directory/index.ts +1 -0
- package/src/lib/tasks/lib/place-exports-in-the-narrowest-directory/internal/export-placement-errors.ts +135 -0
- package/src/lib/tasks/lib/place-exports-in-the-narrowest-directory/internal/find-export-placement-violations.ts +507 -0
- package/src/lib/tasks/lib/place-exports-in-the-narrowest-directory/internal/find-misplaced-files.ts +116 -0
- package/src/lib/tasks/lib/place-exports-in-the-narrowest-directory/internal/find-subdivided-directories.ts +29 -0
- package/src/lib/tasks/lib/place-exports-in-the-narrowest-directory/internal/find-the-importer-graph.ts +451 -0
- package/src/lib/tasks/lib/place-exports-in-the-narrowest-directory/internal/list-binding-names.ts +49 -0
- package/src/lib/tasks/lib/refuse-disable-directives/index.ts +15 -0
- package/src/lib/tasks/lib/refuse-disable-directives/internal/disable-directive-errors.ts +45 -0
- package/src/lib/tasks/lib/refuse-disable-directives/internal/find-disable-directives.ts +66 -0
- package/src/lib/tasks/lib/refuse-error-mappings-that-end-streams/index.ts +1 -0
- package/src/lib/tasks/lib/refuse-error-mappings-that-end-streams/internal/error-mapping-errors.ts +21 -0
- package/src/lib/tasks/lib/refuse-error-mappings-that-end-streams/internal/find-error-mappings-to-done.ts +135 -0
- package/src/lib/tasks/lib/require-separate-service-layers/index.ts +1 -0
- package/src/lib/tasks/lib/require-separate-service-layers/internal/find-service-layer-violations.ts +170 -0
- package/src/lib/tasks/lib/require-separate-service-layers/internal/service-layer-errors.ts +21 -0
- package/src/lib/tasks/lib/require-type-checking-every-linted-file/index.ts +14 -0
- package/src/lib/tasks/lib/require-type-checking-every-linted-file/internal/find-linted-files-not-type-checked.ts +117 -0
- package/src/lib/tasks/lib/require-type-checking-every-linted-file/internal/linted-file-errors.ts +51 -0
- package/src/lib/tasks/lib/type-check-with-bun-check/index.ts +11 -0
- package/src/lib/tasks/lib/type-check-with-bun-check/internal/check-types-with-bun-check.ts +54 -0
- package/src/lib/tasks/lib/type-check-with-bun-check/internal/read-bun-check-output.ts +73 -0
- package/src/lib/tasks/lib/type-check-with-bun-check/internal/type-check-errors.ts +10 -0
- package/src/lib/tasks/shared/check-each-nested-package.ts +79 -0
- package/src/lib/tasks/shared/classify-files-by-role.ts +115 -0
- package/src/lib/tasks/shared/count-the-line-of-an-offset.ts +2 -0
- package/src/lib/tasks/shared/create-the-module-resolver.ts +38 -0
- package/src/lib/tasks/shared/declare-lint-config-task.ts +13 -0
- package/src/lib/tasks/shared/declare-typescript-config-task.ts +18 -0
- package/src/lib/tasks/shared/encode-compact-json.ts +5 -0
- package/src/lib/tasks/shared/find-installed-package-binaries.ts +62 -0
- package/src/lib/tasks/shared/find-module-requests.ts +482 -0
- package/src/lib/tasks/shared/find-named-package-manifests.ts +94 -0
- package/src/lib/tasks/shared/find-unmet-typescript-config-requirements.ts +60 -0
- package/src/lib/tasks/shared/list-ignored-files-imported-by-source.ts +79 -0
- package/src/lib/tasks/shared/list-linted-files.ts +28 -0
- package/src/lib/tasks/shared/list-owned-files.ts +13 -0
- package/src/lib/tasks/shared/list-package-files.ts +66 -0
- package/src/lib/tasks/shared/load-the-lint-config.ts +176 -0
- package/src/lib/tasks/shared/match-granted-patch-files.ts +88 -0
- package/src/lib/tasks/shared/parse-config-files-that-import-from-check.ts +310 -0
- package/src/lib/tasks/shared/print-failures-and-keep-detail-in-the-trace.ts +99 -0
- package/src/lib/tasks/shared/project-config-and-tool-errors.ts +485 -0
- package/src/lib/tasks/shared/query-the-typescript-project.ts +635 -0
- package/src/lib/tasks/shared/read-named-package-manifests.ts +53 -0
- package/src/lib/tasks/shared/read-package-manifest-object.ts +28 -0
- package/src/lib/tasks/shared/resolve-absolute-paths.ts +4 -0
- package/src/lib/tasks/shared/resolve-module-requests.ts +121 -0
- package/src/lib/tasks/shared/run-tools-and-decode-their-reports.ts +98 -0
- package/src/lib/tasks/shared/tool-file-locations.ts +38 -0
- package/src/shared/bans-each-permission-lifts.ts +454 -0
- package/src/shared/config-file-names.ts +3 -0
- package/src/shared/find-retired-words.ts +17 -0
- package/src/shared/format-reported-failures.ts +31 -0
- package/src/shared/lint-rule-messages-and-patterns.ts +104 -0
- package/src/shared/match-file-names-and-path-prefixes.ts +18 -0
- package/src/shared/permission-grant-errors.ts +42 -0
- package/src/shared/record-and-grant-permissions-by-path.ts +419 -0
- package/src/shared/test-home-directories.ts +4 -0
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { Result, Schema } from "effect";
|
|
2
|
+
|
|
3
|
+
import { JSON_TEXT } from "./encode-compact-json.ts";
|
|
4
|
+
import {
|
|
5
|
+
PackageManifestNotObject,
|
|
6
|
+
PackageManifestUnparsable,
|
|
7
|
+
} from "./project-config-and-tool-errors.ts";
|
|
8
|
+
|
|
9
|
+
export const JSON_OBJECT = Schema.Record(Schema.String, Schema.Json);
|
|
10
|
+
|
|
11
|
+
export const packageManifestObject = (
|
|
12
|
+
path: string,
|
|
13
|
+
text: string,
|
|
14
|
+
): Result.Result<typeof JSON_OBJECT.Type, PackageManifestNotObject | PackageManifestUnparsable> => {
|
|
15
|
+
const json = Schema.decodeResult(JSON_TEXT)(text);
|
|
16
|
+
if (Result.isFailure(json)) {
|
|
17
|
+
return Result.fail(
|
|
18
|
+
new PackageManifestUnparsable({ location: path, reason: json.failure.message }),
|
|
19
|
+
);
|
|
20
|
+
}
|
|
21
|
+
const object = Schema.decodeUnknownResult(JSON_OBJECT)(json.success);
|
|
22
|
+
if (Result.isFailure(object)) {
|
|
23
|
+
return Result.fail(
|
|
24
|
+
new PackageManifestNotObject({ location: path, reason: object.failure.message }),
|
|
25
|
+
);
|
|
26
|
+
}
|
|
27
|
+
return Result.succeed(object.success);
|
|
28
|
+
};
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
import { Effect, FileSystem, Option, Path, Result } from "effect";
|
|
2
|
+
|
|
3
|
+
import { moduleResolverFor } from "./create-the-module-resolver.ts";
|
|
4
|
+
import { withoutQuery } from "./find-module-requests.ts";
|
|
5
|
+
import {
|
|
6
|
+
directoriesAFailedResolutionReads,
|
|
7
|
+
enclosingPackageManifestsOf,
|
|
8
|
+
resolutionNamesNoFile,
|
|
9
|
+
} from "./find-named-package-manifests.ts";
|
|
10
|
+
import { ModuleRequestUnresolvable } from "./project-config-and-tool-errors.ts";
|
|
11
|
+
import { namedPackageManifestAt } from "./read-named-package-manifests.ts";
|
|
12
|
+
|
|
13
|
+
const HASH_AFTER_THE_FIRST_CHARACTER = /(?<!^)#/gu;
|
|
14
|
+
const HASH_THE_RESOLVER_READS_AS_A_CHARACTER = "\0#";
|
|
15
|
+
|
|
16
|
+
const UNNAMED_PACKAGE = { name: null, hasExports: false, realPath: null } as const;
|
|
17
|
+
|
|
18
|
+
const packagesByDirectory = new Map<
|
|
19
|
+
string,
|
|
20
|
+
{
|
|
21
|
+
readonly name: string | null;
|
|
22
|
+
readonly hasExports: boolean;
|
|
23
|
+
readonly realPath: string | null;
|
|
24
|
+
}
|
|
25
|
+
>();
|
|
26
|
+
|
|
27
|
+
const realPathOf = (file: string) =>
|
|
28
|
+
FileSystem.FileSystem.use((fileSystem) => fileSystem.realPath(file));
|
|
29
|
+
|
|
30
|
+
const namedManifestAt = (manifestFile: string) =>
|
|
31
|
+
namedPackageManifestAt(manifestFile).pipe(
|
|
32
|
+
Effect.map(
|
|
33
|
+
Option.match({
|
|
34
|
+
onNone: () => Result.failVoid,
|
|
35
|
+
onSome: (manifest) => Result.succeed({ manifestFile, manifest }),
|
|
36
|
+
}),
|
|
37
|
+
),
|
|
38
|
+
);
|
|
39
|
+
|
|
40
|
+
const namedPackageEnclosing = Effect.fn("namedPackageEnclosing")(function* (
|
|
41
|
+
directory: string,
|
|
42
|
+
projectDirectory: string,
|
|
43
|
+
) {
|
|
44
|
+
const key = `${projectDirectory}\0${directory}`;
|
|
45
|
+
const known = packagesByDirectory.get(key);
|
|
46
|
+
if (known !== undefined) {
|
|
47
|
+
return known;
|
|
48
|
+
}
|
|
49
|
+
const path = yield* Path.Path;
|
|
50
|
+
const named = yield* Effect.findFirstFilter(
|
|
51
|
+
enclosingPackageManifestsOf(directory, projectDirectory),
|
|
52
|
+
namedManifestAt,
|
|
53
|
+
);
|
|
54
|
+
const identity = Option.isNone(named)
|
|
55
|
+
? UNNAMED_PACKAGE
|
|
56
|
+
: {
|
|
57
|
+
name: named.value.manifest.name,
|
|
58
|
+
hasExports: named.value.manifest.hasExports,
|
|
59
|
+
realPath: yield* realPathOf(path.dirname(named.value.manifestFile)),
|
|
60
|
+
};
|
|
61
|
+
packagesByDirectory.set(key, identity);
|
|
62
|
+
return identity;
|
|
63
|
+
});
|
|
64
|
+
|
|
65
|
+
export const resolveModuleRequest = Effect.fn("resolveModuleRequest")(function* ({
|
|
66
|
+
request,
|
|
67
|
+
importingFile,
|
|
68
|
+
customConditions,
|
|
69
|
+
projectDirectory,
|
|
70
|
+
}: {
|
|
71
|
+
readonly request: string;
|
|
72
|
+
readonly importingFile: string;
|
|
73
|
+
readonly customConditions: readonly string[];
|
|
74
|
+
readonly projectDirectory: string;
|
|
75
|
+
}) {
|
|
76
|
+
const path = yield* Path.Path;
|
|
77
|
+
const unresolvable = (reason: string) =>
|
|
78
|
+
new ModuleRequestUnresolvable({ request, importingFile, reason });
|
|
79
|
+
const packageEnclosing = (directory: string) =>
|
|
80
|
+
namedPackageEnclosing(directory, projectDirectory).pipe(
|
|
81
|
+
Effect.catchTags({
|
|
82
|
+
PackageManifestUnreadable: (error) =>
|
|
83
|
+
Effect.fail(
|
|
84
|
+
unresolvable(`${path.relative(projectDirectory, error.location)} ${error.message}`),
|
|
85
|
+
),
|
|
86
|
+
PlatformError: (error) => Effect.fail(unresolvable(error.message)),
|
|
87
|
+
}),
|
|
88
|
+
);
|
|
89
|
+
const fileRequest = withoutQuery(request);
|
|
90
|
+
const resolverRequest = fileRequest.replaceAll(
|
|
91
|
+
HASH_AFTER_THE_FIRST_CHARACTER,
|
|
92
|
+
HASH_THE_RESOLVER_READS_AS_A_CHARACTER,
|
|
93
|
+
);
|
|
94
|
+
const resolved = yield* Effect.tryPromise({
|
|
95
|
+
try: () => moduleResolverFor(customConditions).resolveFileAsync(importingFile, resolverRequest),
|
|
96
|
+
catch: (cause) => unresolvable(String(cause)),
|
|
97
|
+
});
|
|
98
|
+
const resolvedFile = resolved.path;
|
|
99
|
+
if (resolvedFile === undefined) {
|
|
100
|
+
yield* Effect.forEach(
|
|
101
|
+
directoriesAFailedResolutionReads({ importingFile, request: fileRequest }),
|
|
102
|
+
packageEnclosing,
|
|
103
|
+
{ discard: true },
|
|
104
|
+
);
|
|
105
|
+
const reason = resolved.error ?? "the resolver returned no file and no error";
|
|
106
|
+
const namesNoFile = resolutionNamesNoFile(resolved, reason);
|
|
107
|
+
if (namesNoFile) {
|
|
108
|
+
return;
|
|
109
|
+
}
|
|
110
|
+
return yield* unresolvable(reason);
|
|
111
|
+
}
|
|
112
|
+
const identity = yield* packageEnclosing(path.dirname(resolvedFile));
|
|
113
|
+
return {
|
|
114
|
+
file: yield* realPathOf(resolvedFile).pipe(
|
|
115
|
+
Effect.mapError((error) => unresolvable(error.message)),
|
|
116
|
+
),
|
|
117
|
+
packageName: identity.name,
|
|
118
|
+
packageHasExports: identity.hasExports,
|
|
119
|
+
packageRoot: identity.realPath,
|
|
120
|
+
};
|
|
121
|
+
});
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
import type { Array as Arrays, Schema } from "effect";
|
|
2
|
+
import { Effect, Stream } from "effect";
|
|
3
|
+
import { ChildProcess } from "effect/process";
|
|
4
|
+
|
|
5
|
+
import { ToolExited, ToolReportUndecodable } from "./project-config-and-tool-errors.ts";
|
|
6
|
+
|
|
7
|
+
const LINE_BREAK = "\n";
|
|
8
|
+
|
|
9
|
+
const KIBIBYTES_PER_RUN_A_QUARTER_OF_THE_MACOS_ARGUMENT_MAX = 256;
|
|
10
|
+
const BYTES_PER_KIBIBYTE = 1024;
|
|
11
|
+
const ARGUMENT_BYTES_PER_RUN_A_QUARTER_OF_THE_MACOS_ARGUMENT_MAX =
|
|
12
|
+
KIBIBYTES_PER_RUN_A_QUARTER_OF_THE_MACOS_ARGUMENT_MAX * BYTES_PER_KIBIBYTE;
|
|
13
|
+
|
|
14
|
+
export const linesOf = (text: string) => text.split(LINE_BREAK).filter((line) => line !== "");
|
|
15
|
+
|
|
16
|
+
const bytesOnTheCommandLine = (toolArgument: string) => Buffer.byteLength(toolArgument) + 1;
|
|
17
|
+
|
|
18
|
+
export const argumentsInRunsOfBoundedSize = (toolArguments: readonly string[]) => {
|
|
19
|
+
const runs: { readonly toolArguments: string[]; bytes: number }[] = [];
|
|
20
|
+
for (const toolArgument of toolArguments) {
|
|
21
|
+
const bytes = bytesOnTheCommandLine(toolArgument);
|
|
22
|
+
const lastRun = runs.at(-1);
|
|
23
|
+
const fitsTheLastRun =
|
|
24
|
+
lastRun !== undefined &&
|
|
25
|
+
lastRun.bytes + bytes <= ARGUMENT_BYTES_PER_RUN_A_QUARTER_OF_THE_MACOS_ARGUMENT_MAX;
|
|
26
|
+
if (fitsTheLastRun) {
|
|
27
|
+
lastRun.toolArguments.push(toolArgument);
|
|
28
|
+
lastRun.bytes += bytes;
|
|
29
|
+
} else {
|
|
30
|
+
runs.push({ toolArguments: [toolArgument], bytes });
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
return runs.map((run) => run.toolArguments);
|
|
34
|
+
};
|
|
35
|
+
|
|
36
|
+
export const mergedExit = (exits: Arrays.NonEmptyReadonlyArray<ToolExited>) => {
|
|
37
|
+
const [firstExit] = exits;
|
|
38
|
+
const highestCode = Math.max(...exits.map(({ code }) => code));
|
|
39
|
+
const exitWithTheHighestCode = exits.find(({ code }) => code === highestCode) ?? firstExit;
|
|
40
|
+
return new ToolExited({
|
|
41
|
+
program: firstExit.program,
|
|
42
|
+
command: exitWithTheHighestCode.command,
|
|
43
|
+
code: exitWithTheHighestCode.code,
|
|
44
|
+
standardOutput: exits.map(({ standardOutput }) => standardOutput).join(LINE_BREAK),
|
|
45
|
+
standardError: [...new Set(exits.map(({ standardError }) => standardError))]
|
|
46
|
+
.filter((standardError) => standardError !== "")
|
|
47
|
+
.join(LINE_BREAK),
|
|
48
|
+
});
|
|
49
|
+
};
|
|
50
|
+
|
|
51
|
+
export const runTool = (
|
|
52
|
+
program: string,
|
|
53
|
+
binary: string,
|
|
54
|
+
toolArguments: readonly string[],
|
|
55
|
+
workingDirectory?: string,
|
|
56
|
+
environment?: Record<string, string>,
|
|
57
|
+
) =>
|
|
58
|
+
Effect.scoped(
|
|
59
|
+
Effect.gen(function* () {
|
|
60
|
+
const child = yield* ChildProcess.make(binary, toolArguments, {
|
|
61
|
+
...(workingDirectory === undefined ? {} : { cwd: workingDirectory }),
|
|
62
|
+
extendEnv: true,
|
|
63
|
+
env: environment,
|
|
64
|
+
stdin: "ignore",
|
|
65
|
+
stderr: "pipe",
|
|
66
|
+
});
|
|
67
|
+
const [standardOutput, standardError, code] = yield* Effect.all(
|
|
68
|
+
[
|
|
69
|
+
Stream.mkString(Stream.decodeText(child.stdout)),
|
|
70
|
+
Stream.mkString(Stream.decodeText(child.stderr)),
|
|
71
|
+
child.exitCode,
|
|
72
|
+
],
|
|
73
|
+
{ concurrency: "unbounded" },
|
|
74
|
+
);
|
|
75
|
+
if (code !== 0) {
|
|
76
|
+
return yield* new ToolExited({
|
|
77
|
+
program,
|
|
78
|
+
command: [binary, ...toolArguments].join(" "),
|
|
79
|
+
code,
|
|
80
|
+
standardOutput,
|
|
81
|
+
standardError: standardError.trim(),
|
|
82
|
+
});
|
|
83
|
+
}
|
|
84
|
+
return { standardOutput, standardError };
|
|
85
|
+
}),
|
|
86
|
+
);
|
|
87
|
+
|
|
88
|
+
export const decodedReport = <Report, Requirements>(
|
|
89
|
+
program: string,
|
|
90
|
+
decode: (standardOutput: string) => Effect.Effect<Report, Schema.SchemaError, Requirements>,
|
|
91
|
+
standardOutput: string,
|
|
92
|
+
) =>
|
|
93
|
+
decode(standardOutput).pipe(
|
|
94
|
+
Effect.mapError(
|
|
95
|
+
(error) =>
|
|
96
|
+
new ToolReportUndecodable({ program, reason: error.message, report: standardOutput }),
|
|
97
|
+
),
|
|
98
|
+
);
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import { fileNameOf } from "../../../shared/match-file-names-and-path-prefixes.ts";
|
|
2
|
+
|
|
3
|
+
const TOOL_FILES = [
|
|
4
|
+
{
|
|
5
|
+
names: ["README.md", "package.json", ".gitignore", "tsconfig.json", "tsconfig.build.json"],
|
|
6
|
+
directories: undefined,
|
|
7
|
+
allowsFileType: true,
|
|
8
|
+
},
|
|
9
|
+
{
|
|
10
|
+
names: [
|
|
11
|
+
"LICENSE",
|
|
12
|
+
"bun.lock",
|
|
13
|
+
"bunfig.toml",
|
|
14
|
+
"oxlint.config.ts",
|
|
15
|
+
"oxfmt.config.ts",
|
|
16
|
+
"vite.config.ts",
|
|
17
|
+
],
|
|
18
|
+
directories: [""],
|
|
19
|
+
allowsFileType: true,
|
|
20
|
+
},
|
|
21
|
+
{
|
|
22
|
+
names: ["Dockerfile"],
|
|
23
|
+
directories: [""],
|
|
24
|
+
allowsFileType: false,
|
|
25
|
+
},
|
|
26
|
+
] as const;
|
|
27
|
+
|
|
28
|
+
export const toolFileOf = (path: string) =>
|
|
29
|
+
TOOL_FILES.find(({ names }) => names.some((name) => name === fileNameOf(path)));
|
|
30
|
+
|
|
31
|
+
export const toolFileIsPlaced = (path: string) => {
|
|
32
|
+
const tool = toolFileOf(path);
|
|
33
|
+
const directory = path.split("/").slice(0, -1).join("/");
|
|
34
|
+
return (
|
|
35
|
+
tool !== undefined &&
|
|
36
|
+
(tool.directories === undefined || tool.directories.some((allowed) => allowed === directory))
|
|
37
|
+
);
|
|
38
|
+
};
|