@shivaedev/quality 0.57.1 → 0.58.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.
Files changed (127) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/README.md +11 -4
  3. package/dist/adapters/ImportAnalysisFailure.d.ts +10 -0
  4. package/dist/adapters/ImportAnalysisFailure.d.ts.map +1 -0
  5. package/dist/adapters/ImportAnalysisFailure.js +4 -0
  6. package/dist/adapters/ImportAnalysisFailure.js.map +1 -0
  7. package/dist/adapters/ImportCompiler.d.ts +2 -13
  8. package/dist/adapters/ImportCompiler.d.ts.map +1 -1
  9. package/dist/adapters/ImportCompiler.js +7 -13
  10. package/dist/adapters/ImportCompiler.js.map +1 -1
  11. package/dist/adapters/imports/analysisFailure.d.ts +3 -0
  12. package/dist/adapters/imports/analysisFailure.d.ts.map +1 -0
  13. package/dist/adapters/imports/analysisFailure.js +5 -0
  14. package/dist/adapters/imports/analysisFailure.js.map +1 -0
  15. package/dist/adapters/imports/analyzeDepartures.d.ts +5 -0
  16. package/dist/adapters/imports/analyzeDepartures.d.ts.map +1 -0
  17. package/dist/adapters/imports/analyzeDepartures.js +5 -0
  18. package/dist/adapters/imports/analyzeDepartures.js.map +1 -0
  19. package/dist/adapters/imports/analyzeGraph.d.ts +4 -0
  20. package/dist/adapters/imports/analyzeGraph.d.ts.map +1 -0
  21. package/dist/adapters/imports/analyzeGraph.js +6 -0
  22. package/dist/adapters/imports/analyzeGraph.js.map +1 -0
  23. package/dist/adapters/imports/checkBrowser.d.ts +4 -0
  24. package/dist/adapters/imports/checkBrowser.d.ts.map +1 -0
  25. package/dist/adapters/imports/checkBrowser.js +4 -0
  26. package/dist/adapters/imports/checkBrowser.js.map +1 -0
  27. package/dist/adapters/indirectServiceReferences.d.ts +3 -0
  28. package/dist/adapters/indirectServiceReferences.d.ts.map +1 -0
  29. package/dist/adapters/indirectServiceReferences.js +19 -0
  30. package/dist/adapters/indirectServiceReferences.js.map +1 -0
  31. package/dist/adapters/knip/entryPointFindings.d.ts +1 -1
  32. package/dist/adapters/knip/entryPointFindings.d.ts.map +1 -1
  33. package/dist/adapters/nativeTransactionFindings.d.ts +4 -0
  34. package/dist/adapters/nativeTransactionFindings.d.ts.map +1 -0
  35. package/dist/adapters/nativeTransactionFindings.js +98 -0
  36. package/dist/adapters/nativeTransactionFindings.js.map +1 -0
  37. package/dist/adapters/outsideImportFindings.d.ts +1 -1
  38. package/dist/adapters/outsideImportFindings.d.ts.map +1 -1
  39. package/dist/adapters/queueReadoutFindings.d.ts +1 -1
  40. package/dist/adapters/queueReadoutFindings.d.ts.map +1 -1
  41. package/dist/adapters/serviceAssemblyImports.d.ts +10 -0
  42. package/dist/adapters/serviceAssemblyImports.d.ts.map +1 -0
  43. package/dist/adapters/serviceAssemblyImports.js +71 -0
  44. package/dist/adapters/serviceAssemblyImports.js.map +1 -0
  45. package/dist/adapters/serviceAssemblySyntax.d.ts +10 -0
  46. package/dist/adapters/serviceAssemblySyntax.d.ts.map +1 -0
  47. package/dist/adapters/serviceAssemblySyntax.js +105 -0
  48. package/dist/adapters/serviceAssemblySyntax.js.map +1 -0
  49. package/dist/adapters/serviceDefinitionProblems.d.ts +7 -0
  50. package/dist/adapters/serviceDefinitionProblems.d.ts.map +1 -0
  51. package/dist/adapters/serviceDefinitionProblems.js +43 -0
  52. package/dist/adapters/serviceDefinitionProblems.js.map +1 -0
  53. package/dist/adapters/serviceIdFindings.d.ts.map +1 -1
  54. package/dist/adapters/serviceIdFindings.js +12 -7
  55. package/dist/adapters/serviceIdFindings.js.map +1 -1
  56. package/dist/adapters/transactionChanges.d.ts +3 -0
  57. package/dist/adapters/transactionChanges.d.ts.map +1 -0
  58. package/dist/adapters/transactionChanges.js +81 -0
  59. package/dist/adapters/transactionChanges.js.map +1 -0
  60. package/dist/imports/departures.d.ts +1 -1
  61. package/dist/imports/departures.d.ts.map +1 -1
  62. package/dist/imports/fences/check.d.ts +1 -1
  63. package/dist/imports/fences/check.d.ts.map +1 -1
  64. package/dist/imports/graph.d.ts +1 -1
  65. package/dist/imports/graph.d.ts.map +1 -1
  66. package/dist/rules/builtIn.d.ts +1 -1
  67. package/dist/rules/builtIn.d.ts.map +1 -1
  68. package/dist/rules/builtIn.js +4 -0
  69. package/dist/rules/builtIn.js.map +1 -1
  70. package/dist/rules/effect/serviceCatalog.d.ts +1 -1
  71. package/dist/rules/effect/serviceCatalog.d.ts.map +1 -1
  72. package/dist/rules/effect/serviceCatalog.js +4 -2
  73. package/dist/rules/effect/serviceCatalog.js.map +1 -1
  74. package/dist/rules/effect/serviceDefinitionAssembly.d.ts +2 -0
  75. package/dist/rules/effect/serviceDefinitionAssembly.d.ts.map +1 -0
  76. package/dist/rules/effect/serviceDefinitionAssembly.js +43 -0
  77. package/dist/rules/effect/serviceDefinitionAssembly.js.map +1 -0
  78. package/dist/rules/effect/serviceIds.js +1 -1
  79. package/dist/rules/effect/serviceIds.js.map +1 -1
  80. package/dist/rules/effect/serviceParameters.d.ts.map +1 -1
  81. package/dist/rules/effect/serviceParameters.js +12 -6
  82. package/dist/rules/effect/serviceParameters.js.map +1 -1
  83. package/dist/rules/effect/sqlTransact.d.ts +2 -0
  84. package/dist/rules/effect/sqlTransact.d.ts.map +1 -0
  85. package/dist/rules/effect/sqlTransact.js +9 -0
  86. package/dist/rules/effect/sqlTransact.js.map +1 -0
  87. package/dist/rules/stories/sources.d.ts +1 -1
  88. package/dist/rules/stories/sources.d.ts.map +1 -1
  89. package/dist/testing/adapters/cli.d.ts +2 -2
  90. package/dist/testing/adapters/cli.d.ts.map +1 -1
  91. package/dist/testing/adapters/cli.js +11 -14
  92. package/dist/testing/adapters/cli.js.map +1 -1
  93. package/dist/testing/adapters/git.d.ts +10 -0
  94. package/dist/testing/adapters/git.d.ts.map +1 -1
  95. package/dist/testing/adapters/git.js +6 -2
  96. package/dist/testing/adapters/git.js.map +1 -1
  97. package/dist/testing/adapters/hookRepository.d.ts.map +1 -1
  98. package/dist/testing/adapters/hookRepository.js +6 -2
  99. package/dist/testing/adapters/hookRepository.js.map +1 -1
  100. package/dist/testing/ruleStory.d.ts.map +1 -1
  101. package/dist/testing/ruleStory.js +1 -2
  102. package/dist/testing/ruleStory.js.map +1 -1
  103. package/package.json +5 -5
  104. package/src/adapters/ImportAnalysisFailure.ts +6 -0
  105. package/src/adapters/ImportCompiler.ts +7 -20
  106. package/src/adapters/imports/analysisFailure.ts +5 -0
  107. package/src/adapters/imports/analyzeDepartures.ts +9 -0
  108. package/src/adapters/imports/analyzeGraph.ts +9 -0
  109. package/src/adapters/imports/checkBrowser.ts +5 -0
  110. package/src/adapters/indirectServiceReferences.ts +25 -0
  111. package/src/adapters/nativeTransactionFindings.ts +108 -0
  112. package/src/adapters/outsideImportFindings.ts +1 -1
  113. package/src/adapters/serviceAssemblyImports.ts +93 -0
  114. package/src/adapters/serviceAssemblySyntax.ts +129 -0
  115. package/src/adapters/serviceDefinitionProblems.ts +63 -0
  116. package/src/adapters/serviceIdFindings.ts +16 -13
  117. package/src/adapters/transactionChanges.ts +85 -0
  118. package/src/rules/builtIn.ts +4 -0
  119. package/src/rules/effect/serviceCatalog.ts +4 -2
  120. package/src/rules/effect/serviceDefinitionAssembly.ts +46 -0
  121. package/src/rules/effect/serviceIds.ts +1 -1
  122. package/src/rules/effect/serviceParameters.ts +12 -6
  123. package/src/rules/effect/sqlTransact.ts +10 -0
  124. package/src/testing/adapters/cli.ts +22 -14
  125. package/src/testing/adapters/git.ts +7 -2
  126. package/src/testing/adapters/hookRepository.ts +6 -2
  127. package/src/testing/ruleStory.ts +1 -2
@@ -1,35 +1,41 @@
1
1
  import { join } from "node:path";
2
+ import { Effect } from "effect";
3
+ import { readPackageManifest } from "#adapters/manifestInventory.ts";
4
+ import { packageOf, workspacePackages } from "#imports/workspace.ts";
2
5
  import { defineRule, type Finding, type RuleInputs } from "#rule.ts";
3
6
  import { effectProgram } from "#rules/effect/program.ts";
4
7
  import { serviceCatalog } from "#rules/effect/serviceCatalog.ts";
5
8
  import { serviceFindings } from "#rules/effect/serviceFindings.ts";
6
9
 
7
10
  export const serviceParameters = defineRule({
8
- check: (inputs) => {
11
+ check: Effect.fn("Services.check")(function* (inputs: RuleInputs) {
12
+ const packages = yield* Effect.promise(() => workspacePackages(inputs));
13
+ const root = yield* Effect.promise(() => readPackageManifest(inputs.readText, "package.json"));
14
+ const names = [...packages.map((owner) => owner.name), ...(root?.name === undefined ? [] : [root.name])];
9
15
  const groups = new Map<string, RuleInputs["sources"][number][]>();
10
16
  for (const source of inputs.sources) {
11
17
  if (/(?:^|\/)test-support\//u.test(source.path)) {
12
18
  continue;
13
19
  }
14
- const group = /^(?:packages|examples)\/[^/]+/u.exec(source.path)?.[0] ?? ".";
20
+ const group = packageOf(packages, source.path)?.directory ?? ".";
15
21
  const files = groups.get(group) ?? [];
16
22
  files.push(source);
17
23
  groups.set(group, files);
18
24
  }
19
- return [...groups.values()].flatMap((sources) => checkServices({ ...inputs, sources }));
20
- },
25
+ return [...groups.values()].flatMap((sources) => checkServices({ ...inputs, sources }, names));
26
+ }),
21
27
  description:
22
28
  "Exported functions and public methods take services from Effect's environment, including aliases, constraints, inferred/destructured parameters and factory returns. Service keys/classes, non-empty Contexts and implementation shapes are services; Effect/Stream requirements are computations. Service implementation methods and Layer constructors are accepted. Only test-support/ folders are exempt. The fixed adapters/ convention bridges outside libraries to Effect values; adapters still follow this rule and ambient runtime bans. No config exceptions or inline suppressions; baseline existing debt.",
23
29
  id: "effect/service-parameters",
24
30
  registrable: false,
25
31
  });
26
32
 
27
- function checkServices(inputs: RuleInputs): readonly Finding[] {
33
+ function checkServices(inputs: RuleInputs, packages: readonly string[]): readonly Finding[] {
28
34
  const program = effectProgram(inputs);
29
35
  const checker = program.getTypeChecker();
30
36
  const sources = inputs.sources.flatMap((file) => {
31
37
  const source = program.getSourceFile(join(inputs.root, file.path));
32
38
  return source === undefined ? [] : [source];
33
39
  });
34
- return serviceFindings(inputs.root, sources, checker, serviceCatalog(program, checker));
40
+ return serviceFindings(inputs.root, sources, checker, serviceCatalog(program, checker, packages));
35
41
  }
@@ -0,0 +1,10 @@
1
+ import { nativeTransactionFindings } from "#adapters/nativeTransactionFindings.ts";
2
+ import { defineRule } from "#rule.ts";
3
+
4
+ export const sqlTransact = defineRule({
5
+ check: nativeTransactionFindings,
6
+ description:
7
+ "Repository writes and change announcements use transact for their outer transaction instead of native sql.withTransaction. Native transactions containing only reads or raw SQL remain supported.",
8
+ id: "effect/sql-transact",
9
+ registrable: false,
10
+ });
@@ -2,10 +2,10 @@ import { spawnSync } from "node:child_process";
2
2
  import { realpathSync } from "node:fs";
3
3
  import { fileURLToPath } from "node:url";
4
4
  import { format } from "node:util";
5
- import { Config, Console, Effect, Option } from "effect";
5
+ import { Config, ConfigProvider, Console, Effect, Option } from "effect";
6
6
  import { program } from "#cli/program.ts";
7
7
  import { exitCode, explained, services } from "#cli/runMain.ts";
8
- import { ISOLATED_ENV } from "#testing/adapters/git.ts";
8
+ import { ISOLATED_ENV, isolatedEnvironment } from "#testing/adapters/git.ts";
9
9
 
10
10
  export interface Run {
11
11
  readonly status: number | null;
@@ -84,21 +84,29 @@ export function capturing(output: Output): Console.Console {
84
84
  }
85
85
 
86
86
  // Runs the executable's program in this process, which imports each config path once: after a command rewrites the config, spawn `quality`.
87
- export async function runQuality(root: string, ...args: readonly string[]): Promise<Run> {
88
- const output: Output = { stderr: "", stdout: "" };
89
- const captured = capturing(output);
90
- const command = program(args, { cwd: realpathSync(root), launch: { options: OPTIONS, script: CLI } });
91
- const restore = await isolateGit();
92
- try {
93
- const exit = await Effect.runPromiseExit(explained(command).pipe(Effect.provideService(Console.Console, captured), Effect.provide(services)));
94
- return { status: exitCode(exit), ...output };
95
- } finally {
96
- restore();
97
- }
87
+ export function runQuality(root: string, ...args: readonly string[]): Effect.Effect<Run> {
88
+ return Effect.scoped(
89
+ Effect.gen(function* () {
90
+ const output: Output = { stderr: "", stdout: "" };
91
+ const command = program(args, { cwd: realpathSync(root), launch: { options: OPTIONS, script: CLI } });
92
+ const environment = ConfigProvider.orElse(
93
+ ConfigProvider.fromEnv({ env: { "HEAVY_PROCESS_LOCK": isolatedEnvironment(root).HEAVY_PROCESS_LOCK } }),
94
+ yield* ConfigProvider.ConfigProvider,
95
+ );
96
+ yield* Effect.acquireRelease(Effect.promise(isolateGit), (restore) => Effect.sync(restore));
97
+ const exit = yield* explained(command).pipe(
98
+ Effect.provideService(ConfigProvider.ConfigProvider, environment),
99
+ Effect.provideService(Console.Console, capturing(output)),
100
+ Effect.provide(services),
101
+ Effect.exit,
102
+ );
103
+ return { status: exitCode(exit), ...output };
104
+ }),
105
+ );
98
106
  }
99
107
 
100
108
  export function quality(root: string, ...args: readonly string[]): Run {
101
- const result = spawnSync("node", qualityArgs(args), { cwd: root, encoding: "utf8", env: ISOLATED_ENV });
109
+ const result = spawnSync("node", qualityArgs(args), { cwd: root, encoding: "utf8", env: isolatedEnvironment(root) });
102
110
  return { status: result.status, stderr: result.stderr, stdout: result.stdout };
103
111
  }
104
112
 
@@ -1,4 +1,5 @@
1
1
  import { execFileSync, spawnSync } from "node:child_process";
2
+ import { resolve } from "node:path";
2
3
  import { Config, Effect, Option } from "effect";
3
4
 
4
5
  const HEAVY_ENV = Object.fromEntries(
@@ -20,6 +21,10 @@ export const ISOLATED_ENV = {
20
21
  "PATH": Effect.runSync(Config.String("PATH")),
21
22
  };
22
23
 
24
+ export function isolatedEnvironment(root: string) {
25
+ return { ...ISOLATED_ENV, "HEAVY_PROCESS_LOCK": resolve(root, "heavy.lock") };
26
+ }
27
+
23
28
  const SETTINGS = [
24
29
  "user.name=Quality",
25
30
  "user.email=quality@example.invalid",
@@ -32,7 +37,7 @@ export function git(root: string, ...args: readonly string[]): string {
32
37
  return execFileSync("git", [...SETTINGS.flatMap((setting) => ["-c", setting]), ...args], {
33
38
  cwd: root,
34
39
  encoding: "utf8",
35
- env: ISOLATED_ENV,
40
+ env: isolatedEnvironment(root),
36
41
  stdio: ["ignore", "pipe", "pipe"],
37
42
  });
38
43
  }
@@ -46,7 +51,7 @@ export function mergeBranch(root: string, branch: string): "merged" | "conflicte
46
51
  const result = spawnSync("git", [...SETTINGS.flatMap((setting) => ["-c", setting]), "merge", "--quiet", "--no-edit", branch], {
47
52
  cwd: root,
48
53
  encoding: "utf8",
49
- env: ISOLATED_ENV,
54
+ env: isolatedEnvironment(root),
50
55
  });
51
56
  if (result.status !== 0 && result.status !== 1) {
52
57
  throw new Error(`git merge failed: ${result.error ?? result.stderr}`);
@@ -4,7 +4,7 @@ import { dirname, join } from "node:path";
4
4
  import sortPackageJson from "sort-package-json";
5
5
  import { shellWords } from "#hooks/command.ts";
6
6
  import { qualityArgs, type Run } from "./cli.ts";
7
- import { commitAll, git, ISOLATED_ENV } from "./git.ts";
7
+ import { commitAll, git, isolatedEnvironment } from "./git.ts";
8
8
  import { formatTree } from "./qualityTree.ts";
9
9
  import { DEFAULT_FILES, linkPackage, type SeedFile, seedTree } from "./tree.ts";
10
10
 
@@ -121,7 +121,11 @@ export function withWorktree(repository: HookRepository, name: string, at?: stri
121
121
  }
122
122
 
123
123
  export function commits(cwd: string, message: string): Run {
124
- const result = spawnSync("git", ["commit", "--quiet", "--allow-empty", "--message", message], { cwd, encoding: "utf8", env: ISOLATED_ENV });
124
+ const result = spawnSync("git", ["commit", "--quiet", "--allow-empty", "--message", message], {
125
+ cwd,
126
+ encoding: "utf8",
127
+ env: isolatedEnvironment(cwd),
128
+ });
125
129
  return { status: result.status, stderr: result.stderr, stdout: result.stdout };
126
130
  }
127
131
 
@@ -60,7 +60,6 @@ function outcomeOf({ status }: Run): string {
60
60
 
61
61
  export function makeRuleStory() {
62
62
  const ruleStory = storyKit({
63
- clock: "live",
64
63
  create: () =>
65
64
  Effect.gen(function* () {
66
65
  const fs = yield* FileSystem.FileSystem;
@@ -87,7 +86,7 @@ export function makeRuleStory() {
87
86
  findings: () => checked(engine),
88
87
  gate: Effect.fn("RuleStory.gate")(function* () {
89
88
  story.tell("quality runs the repository gate");
90
- engine.answer = yield* Effect.promise(() => runQuality(engine.root, "lint"));
89
+ engine.answer = yield* runQuality(engine.root, "lint");
91
90
  }),
92
91
  gateOutcome: () => Effect.map(answered(engine), outcomeOf),
93
92
  gateReport: () => Effect.map(answered(engine), (answer) => answer.stdout + answer.stderr),