@aiready/contract-enforcement 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.turbo/turbo-build.log +18 -0
- package/.turbo/turbo-test.log +16 -0
- package/dist/index.d.mts +69 -0
- package/dist/index.d.ts +69 -0
- package/dist/index.js +484 -0
- package/dist/index.mjs +456 -0
- package/package.json +35 -0
- package/src/__tests__/detector.test.ts +148 -0
- package/src/__tests__/provider.test.ts +26 -0
- package/src/__tests__/scoring.test.ts +58 -0
- package/src/analyzer.ts +80 -0
- package/src/detector.ts +373 -0
- package/src/index.ts +17 -0
- package/src/provider.ts +40 -0
- package/src/scoring.ts +94 -0
- package/src/types.ts +82 -0
- package/tsconfig.json +9 -0
package/src/types.ts
ADDED
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
import type { Issue, IssueType } from '@aiready/core';
|
|
2
|
+
|
|
3
|
+
export type DefensivePattern =
|
|
4
|
+
| 'as-any'
|
|
5
|
+
| 'as-unknown'
|
|
6
|
+
| 'deep-optional-chain'
|
|
7
|
+
| 'nullish-literal-default'
|
|
8
|
+
| 'swallowed-error'
|
|
9
|
+
| 'env-fallback'
|
|
10
|
+
| 'unnecessary-guard'
|
|
11
|
+
| 'any-parameter'
|
|
12
|
+
| 'any-return';
|
|
13
|
+
|
|
14
|
+
export interface ContractEnforcementIssue extends Issue {
|
|
15
|
+
type: IssueType.ContractGap;
|
|
16
|
+
pattern: DefensivePattern;
|
|
17
|
+
context: string;
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
export interface PatternCounts {
|
|
21
|
+
'as-any': number;
|
|
22
|
+
'as-unknown': number;
|
|
23
|
+
'deep-optional-chain': number;
|
|
24
|
+
'nullish-literal-default': number;
|
|
25
|
+
'swallowed-error': number;
|
|
26
|
+
'env-fallback': number;
|
|
27
|
+
'unnecessary-guard': number;
|
|
28
|
+
'any-parameter': number;
|
|
29
|
+
'any-return': number;
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
export const ZERO_COUNTS: PatternCounts = {
|
|
33
|
+
'as-any': 0,
|
|
34
|
+
'as-unknown': 0,
|
|
35
|
+
'deep-optional-chain': 0,
|
|
36
|
+
'nullish-literal-default': 0,
|
|
37
|
+
'swallowed-error': 0,
|
|
38
|
+
'env-fallback': 0,
|
|
39
|
+
'unnecessary-guard': 0,
|
|
40
|
+
'any-parameter': 0,
|
|
41
|
+
'any-return': 0,
|
|
42
|
+
};
|
|
43
|
+
|
|
44
|
+
export interface ContractEnforcementOptions {
|
|
45
|
+
rootDir: string;
|
|
46
|
+
include?: string[];
|
|
47
|
+
exclude?: string[];
|
|
48
|
+
onProgress?: (processed: number, total: number, message: string) => void;
|
|
49
|
+
minChainDepth?: number;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
export interface DetectionResult {
|
|
53
|
+
issues: ContractEnforcementIssue[];
|
|
54
|
+
counts: PatternCounts;
|
|
55
|
+
totalLines: number;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
export interface ScoreResult {
|
|
59
|
+
score: number;
|
|
60
|
+
rating: string;
|
|
61
|
+
dimensions: Record<string, number>;
|
|
62
|
+
recommendations: string[];
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
export interface ContractEnforcementReport {
|
|
66
|
+
summary: {
|
|
67
|
+
sourceFiles: number;
|
|
68
|
+
totalDefensivePatterns: number;
|
|
69
|
+
defensiveDensity: number;
|
|
70
|
+
score: number;
|
|
71
|
+
rating: string;
|
|
72
|
+
dimensions: {
|
|
73
|
+
typeEscapeHatchScore: number;
|
|
74
|
+
fallbackCascadeScore: number;
|
|
75
|
+
errorTransparencyScore: number;
|
|
76
|
+
boundaryValidationScore: number;
|
|
77
|
+
};
|
|
78
|
+
};
|
|
79
|
+
issues: ContractEnforcementIssue[];
|
|
80
|
+
rawData: PatternCounts & { sourceFiles: number; totalLines: number };
|
|
81
|
+
recommendations: string[];
|
|
82
|
+
}
|