@shivaedev/quality 0.70.1 → 0.70.3
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/CHANGELOG.md +16 -0
- package/README.md +14 -14
- package/dist/adapters/bundlerEntries.d.ts.map +1 -1
- package/dist/adapters/bundlerEntries.js +16 -2
- package/dist/adapters/bundlerEntries.js.map +1 -1
- package/dist/adapters/bundlerSources.js +2 -2
- package/dist/adapters/bundlerSources.js.map +1 -1
- package/dist/adapters/foreignCallback.d.ts +5 -0
- package/dist/adapters/foreignCallback.d.ts.map +1 -0
- package/dist/adapters/foreignCallback.js +29 -0
- package/dist/adapters/foreignCallback.js.map +1 -0
- package/dist/adapters/foreignResources.d.ts.map +1 -1
- package/dist/adapters/foreignResources.js +9 -34
- package/dist/adapters/foreignResources.js.map +1 -1
- package/dist/adapters/frameworkCallback.d.ts.map +1 -1
- package/dist/adapters/frameworkCallback.js +9 -2
- package/dist/adapters/frameworkCallback.js.map +1 -1
- package/dist/adapters/mappedBuildBindings.d.ts +4 -0
- package/dist/adapters/mappedBuildBindings.d.ts.map +1 -0
- package/dist/adapters/mappedBuildBindings.js +18 -0
- package/dist/adapters/mappedBuildBindings.js.map +1 -0
- package/dist/adapters/nonEmptyContext.d.ts +3 -0
- package/dist/adapters/nonEmptyContext.d.ts.map +1 -0
- package/dist/adapters/nonEmptyContext.js +11 -0
- package/dist/adapters/nonEmptyContext.js.map +1 -0
- package/dist/adapters/outsideImportFindings.d.ts.map +1 -1
- package/dist/adapters/outsideImportFindings.js +1 -0
- package/dist/adapters/outsideImportFindings.js.map +1 -1
- package/dist/adapters/ownedServiceParameters.d.ts +3 -0
- package/dist/adapters/ownedServiceParameters.d.ts.map +1 -0
- package/dist/adapters/ownedServiceParameters.js +24 -0
- package/dist/adapters/ownedServiceParameters.js.map +1 -0
- package/dist/adapters/parameterOrigins.d.ts +3 -0
- package/dist/adapters/parameterOrigins.d.ts.map +1 -0
- package/dist/adapters/parameterOrigins.js +53 -0
- package/dist/adapters/parameterOrigins.js.map +1 -0
- package/dist/baseline/update.d.ts +1 -1
- package/dist/baseline/update.d.ts.map +1 -1
- package/dist/baseline/update.js +4 -7
- package/dist/baseline/update.js.map +1 -1
- package/dist/cli/args.d.ts +0 -2
- package/dist/cli/args.d.ts.map +1 -1
- package/dist/cli/args.js +0 -2
- package/dist/cli/args.js.map +1 -1
- package/dist/cli/baseline.d.ts +1 -1
- package/dist/cli/baseline.d.ts.map +1 -1
- package/dist/cli/baseline.js +12 -26
- package/dist/cli/baseline.js.map +1 -1
- package/dist/cli/misplaced.d.ts +0 -7
- package/dist/cli/misplaced.d.ts.map +1 -1
- package/dist/cli/misplaced.js +2 -4
- package/dist/cli/misplaced.js.map +1 -1
- package/dist/cli/program.js +1 -1
- package/dist/cli/program.js.map +1 -1
- package/dist/cli/reportBaselineWrite.d.ts +4 -0
- package/dist/cli/reportBaselineWrite.d.ts.map +1 -0
- package/dist/cli/reportBaselineWrite.js +19 -0
- package/dist/cli/reportBaselineWrite.js.map +1 -0
- package/dist/cli/usage.d.ts +1 -1
- package/dist/cli/usage.d.ts.map +1 -1
- package/dist/cli/usage.js +3 -3
- package/dist/rules/effect/adapterImports.js +1 -1
- package/dist/rules/effect/adapterImports.js.map +1 -1
- package/dist/rules/effect/serviceFindings.d.ts.map +1 -1
- package/dist/rules/effect/serviceFindings.js +3 -0
- package/dist/rules/effect/serviceFindings.js.map +1 -1
- package/dist/rules/effect/serviceParameters.js +1 -1
- package/dist/rules/effect/serviceParameters.js.map +1 -1
- package/dist/rules/effect/serviceTypes.d.ts.map +1 -1
- package/dist/rules/effect/serviceTypes.js +12 -8
- package/dist/rules/effect/serviceTypes.js.map +1 -1
- package/docs/debt-and-hooks.md +5 -7
- package/package.json +1 -1
- package/src/adapters/bundlerEntries.ts +17 -2
- package/src/adapters/bundlerSources.ts +2 -2
- package/src/adapters/foreignCallback.ts +35 -0
- package/src/adapters/foreignResources.ts +11 -35
- package/src/adapters/frameworkCallback.ts +10 -2
- package/src/adapters/mappedBuildBindings.ts +18 -0
- package/src/adapters/nonEmptyContext.ts +11 -0
- package/src/adapters/outsideImportFindings.ts +1 -0
- package/src/adapters/ownedServiceParameters.ts +25 -0
- package/src/adapters/parameterOrigins.ts +60 -0
- package/src/baseline/update.ts +3 -9
- package/src/cli/args.ts +0 -4
- package/src/cli/baseline.ts +10 -28
- package/src/cli/misplaced.ts +2 -4
- package/src/cli/program.ts +1 -1
- package/src/cli/reportBaselineWrite.ts +26 -0
- package/src/cli/usage.ts +3 -3
- package/src/rules/effect/adapterImports.ts +1 -1
- package/src/rules/effect/serviceFindings.ts +3 -0
- package/src/rules/effect/serviceParameters.ts +1 -1
- package/src/rules/effect/serviceTypes.ts +14 -8
package/src/cli/program.ts
CHANGED
|
@@ -48,7 +48,7 @@ export const program = Effect.fn("Cli.program")(function* (args: readonly string
|
|
|
48
48
|
case "BaselineInstallDriver":
|
|
49
49
|
return yield* installDriver(cwd, launch);
|
|
50
50
|
case "BaselineWrite":
|
|
51
|
-
return yield* writeBaseline(cwd, command.config, command.rules
|
|
51
|
+
return yield* writeBaseline(cwd, command.config, command.rules);
|
|
52
52
|
case "BaselinePrune":
|
|
53
53
|
return yield* pruneBaseline(cwd, command.config, command.against);
|
|
54
54
|
case "BaselineTighten":
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { Console, Effect } from "effect";
|
|
2
|
+
import type { BaselineEntry } from "#baseline/format.ts";
|
|
3
|
+
import { covers, groupBy } from "#engine/violation.ts";
|
|
4
|
+
import { plural } from "#report/plural.ts";
|
|
5
|
+
|
|
6
|
+
export const reportBaselineWrite = Effect.fn("Cli.reportBaselineWrite")(function* (
|
|
7
|
+
before: readonly BaselineEntry[],
|
|
8
|
+
after: readonly BaselineEntry[],
|
|
9
|
+
rules: readonly string[],
|
|
10
|
+
) {
|
|
11
|
+
const recorded = after.filter((entry) => rules.length === 0 || rules.some((rule) => covers(rule, entry.rule)));
|
|
12
|
+
const previousRules = new Set(before.map((entry) => entry.rule));
|
|
13
|
+
yield* Console.log("First, fix every finding you can fix instead of recording it. Run `quality baseline tighten` after repairs.");
|
|
14
|
+
yield* Console.log(
|
|
15
|
+
"Then, for rules new since the previous baseline, review each recorded case and judge whether the rule reads the code correctly. Report any misread to Platform with the file, lines and what Quality would need instead of leaving it as debt.",
|
|
16
|
+
);
|
|
17
|
+
yield* Console.log("Recorded findings by rule:");
|
|
18
|
+
for (const [rule, entries] of [...groupBy(recorded, (entry) => entry.rule)].sort(([left], [right]) => left.localeCompare(right))) {
|
|
19
|
+
const count = entries.reduce((total, entry) => total + entry.count, 0);
|
|
20
|
+
const added = previousRules.has(rule) ? "" : " (new since previous baseline)";
|
|
21
|
+
yield* Console.log(` ${rule}: ${plural(count, "finding", "findings")}${added}`);
|
|
22
|
+
}
|
|
23
|
+
if (recorded.length === 0) {
|
|
24
|
+
yield* Console.log(" none");
|
|
25
|
+
}
|
|
26
|
+
});
|
package/src/cli/usage.ts
CHANGED
|
@@ -6,7 +6,7 @@ export const USAGE = `Usage:
|
|
|
6
6
|
quality exceptions migrate [--config <file>] [--from <registry>]
|
|
7
7
|
quality baseline merge <ancestor> <current> <other>
|
|
8
8
|
quality baseline install-driver
|
|
9
|
-
quality baseline write [--config <file>] [--rule <id>]...
|
|
9
|
+
quality baseline write [--config <file>] [--rule <id>]...
|
|
10
10
|
quality baseline prune [--config <file>] [--against <ref>]
|
|
11
11
|
quality baseline tighten [--config <file>] [--staged]
|
|
12
12
|
quality baseline migrate [--config <file>] [--from <file>]
|
|
@@ -24,8 +24,8 @@ fix Sort every package.json, apply Biome's lint fixes, unsafe ones
|
|
|
24
24
|
exceptions migrate Move legacy registry entries and Biome declarations into quality.config.ts exceptions and remove matching root overrides.
|
|
25
25
|
baseline merge Merge Git baseline versions into <current>: deletions win and counts take the minimum.
|
|
26
26
|
baseline install-driver Configure only the repository-local merge.quality-baseline.driver setting.
|
|
27
|
-
baseline write
|
|
28
|
-
|
|
27
|
+
baseline write Record every current finding, or only the named --rule ids, including findings in unchanged files.
|
|
28
|
+
Fix what you can first; review each case of new rules and report misreads to Platform.
|
|
29
29
|
baseline prune Drop fixed debt, lower entries to what is left and carry entries to files git saw move. Never adds or raises an entry.
|
|
30
30
|
baseline tighten Prune only the entries of files changed since HEAD, or with --staged, in the index.
|
|
31
31
|
baseline migrate Move a JSON or JSON Lines baseline (--from, quality/baseline.json by default) into root and package shards.
|
|
@@ -4,7 +4,7 @@ import { defineRule } from "#rule.ts";
|
|
|
4
4
|
export const adapterImports = defineRule({
|
|
5
5
|
check: outsideImportFindings,
|
|
6
6
|
description:
|
|
7
|
-
"Keep value imports of non-Effect runtime dependencies, peers, optional dependencies and Node builtins in adapters/. Type-only imports, workspace modules, test-support/ kits, Effect and @shivaedev packages, supported UI, routing and styling libraries in client/ folders and Vitest in unit tests are accepted. Libraries that perform I/O or manage external state still need adapters/. Move integrations into adapters/ and expose Effect values. No config exceptions or inline suppressions; baseline existing debt.",
|
|
7
|
+
"Keep value imports of non-Effect runtime dependencies, peers, optional dependencies and Node builtins in adapters/. Type-only imports, workspace modules, test-support/ kits, Effect and @shivaedev packages, supported UI, routing and styling libraries in client/ folders and Vitest in unit tests are accepted. Recharts is the stack's charting library, accepted in client/ folders; build charts with shadcn's Chart component (ChartContainer and friends) rather than raw recharts primitives where shadcn covers the case. Libraries that perform I/O or manage external state still need adapters/. Move integrations into adapters/ and expose Effect values. No config exceptions or inline suppressions; baseline existing debt.",
|
|
8
8
|
id: "effect/adapter-imports",
|
|
9
9
|
registrable: false,
|
|
10
10
|
});
|
|
@@ -3,6 +3,7 @@ import ts from "typescript";
|
|
|
3
3
|
import { foreignResources } from "#adapters/foreignResources.ts";
|
|
4
4
|
import { frameworkCallback, parameterSite } from "#adapters/frameworkCallback.ts";
|
|
5
5
|
import { localFunctions } from "#adapters/localFunctions.ts";
|
|
6
|
+
import { ownedServiceParameters } from "#adapters/ownedServiceParameters.ts";
|
|
6
7
|
import { reactComponent, reactPropParameters } from "#adapters/reactComponent.ts";
|
|
7
8
|
import type { Finding } from "#rule.ts";
|
|
8
9
|
import { layerConstructor } from "#rules/effect/layerConstructor.ts";
|
|
@@ -30,6 +31,7 @@ export function serviceFindings(
|
|
|
30
31
|
services: ReturnType<typeof serviceTypes>,
|
|
31
32
|
): readonly Finding[] {
|
|
32
33
|
const resource = foreignResources(checker, sources);
|
|
34
|
+
const owned = ownedServiceParameters(checker, sources);
|
|
33
35
|
const props = reactPropParameters(checker, sources);
|
|
34
36
|
const findings = new Map<ts.ParameterDeclaration, Finding>();
|
|
35
37
|
const visited = new Set<ts.Type>();
|
|
@@ -44,6 +46,7 @@ export function serviceFindings(
|
|
|
44
46
|
!(ts.isParameter(parameter) && local.has(parameter.getSourceFile()))
|
|
45
47
|
|| implementationParameter(checker, parameter, services)
|
|
46
48
|
|| resource(parameter)
|
|
49
|
+
|| owned(parameter)
|
|
47
50
|
|| frameworkCallback(checker, parameter.parent, local)
|
|
48
51
|
|| reactComponent(checker, parameter.parent)
|
|
49
52
|
|| props.has(parameter)
|
|
@@ -34,7 +34,7 @@ export const serviceParameters = defineRule({
|
|
|
34
34
|
});
|
|
35
35
|
}),
|
|
36
36
|
description:
|
|
37
|
-
"Exported and local 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, framework callbacks, module-level React components and their props, owned foreign adapter resources and Layer constructors are accepted. Within Effect code, 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.",
|
|
37
|
+
"Exported and local 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, framework callbacks, module-level React components and their props, owned initializer state, foreign host object methods, owned foreign adapter resources and Layer constructors are accepted. Within Effect code, 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.",
|
|
38
38
|
id: "effect/service-parameters",
|
|
39
39
|
registrable: false,
|
|
40
40
|
});
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import ts from "typescript";
|
|
2
2
|
import { browserLibraryType } from "#adapters/browserLibraryType.ts";
|
|
3
3
|
import { callerContextData } from "#adapters/callerContextData.ts";
|
|
4
|
+
import { nonEmptyContext } from "#adapters/nonEmptyContext.ts";
|
|
4
5
|
|
|
5
6
|
const SERVICE = "~effect/Context/Service";
|
|
6
7
|
const CONTEXT = "~effect/Context";
|
|
@@ -72,14 +73,18 @@ export function serviceTypes(checker: ts.TypeChecker, initializerState = false)
|
|
|
72
73
|
const contextual = declaration !== undefined && ts.isObjectLiteralExpression(declaration) ? checker.getContextualType(declaration) : undefined;
|
|
73
74
|
return contextual !== undefined && shapes.has(contextual);
|
|
74
75
|
}
|
|
75
|
-
function
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
if (parameter === undefined) {
|
|
79
|
-
return false;
|
|
76
|
+
function serviceReturn(type: ts.Type): boolean {
|
|
77
|
+
if (type.isUnionOrIntersection()) {
|
|
78
|
+
return type.types.some(serviceReturn);
|
|
80
79
|
}
|
|
81
|
-
const
|
|
82
|
-
return
|
|
80
|
+
const context = propertyType(type, CONTEXT);
|
|
81
|
+
return (
|
|
82
|
+
type.getProperty(SERVICE) !== undefined
|
|
83
|
+
|| (!computation(type) && (implementation(type) || (context !== undefined && nonEmptyContext(checker, context))))
|
|
84
|
+
);
|
|
85
|
+
}
|
|
86
|
+
function factoryService(type: ts.Type): boolean {
|
|
87
|
+
return !initializerState && type.getCallSignatures().some((signature) => serviceReturn(signature.getReturnType()));
|
|
83
88
|
}
|
|
84
89
|
function carries(type: ts.Type, seen = new Set<ts.Type>()): boolean {
|
|
85
90
|
if (
|
|
@@ -107,7 +112,7 @@ export function serviceTypes(checker: ts.TypeChecker, initializerState = false)
|
|
|
107
112
|
}
|
|
108
113
|
const context = propertyType(type, CONTEXT);
|
|
109
114
|
if (context !== undefined) {
|
|
110
|
-
return nonEmptyContext(context);
|
|
115
|
+
return nonEmptyContext(checker, context);
|
|
111
116
|
}
|
|
112
117
|
if (computation(type)) {
|
|
113
118
|
return false;
|
|
@@ -118,6 +123,7 @@ export function serviceTypes(checker: ts.TypeChecker, initializerState = false)
|
|
|
118
123
|
}
|
|
119
124
|
return (
|
|
120
125
|
implementation(type)
|
|
126
|
+
|| factoryService(type)
|
|
121
127
|
|| checker.getIndexInfosOfType(type).some((index) => carries(index.type, seen))
|
|
122
128
|
|| type.getProperties().some((property) => !(property.flags & ts.SymbolFlags.Method) && carries(checker.getTypeOfSymbol(property), seen))
|
|
123
129
|
);
|