@starci/eslint-canon-be 3.18.3 → 3.19.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/CHANGELOG.md +8 -0
- package/dist/comments.js +1 -1
- package/dist/explicit-surface.js +1 -1
- package/dist/index.js +1 -1
- package/dist/jwt-alg.js +1 -1
- package/dist/lib/edition.d.ts +1 -1
- package/dist/lib/edition.js +1 -1
- package/dist/lib/hfs.d.ts +0 -6
- package/dist/lib/hfs.js +7 -5
- package/dist/lib/runtime-root.d.ts +6 -1
- package/dist/lib/runtime-root.js +8 -2
- package/dist/lib/subject-values.js +1 -1
- package/dist/module-layering.js +2 -2
- package/dist/project-graph.js +1 -1
- package/dist/third-party-owner.js +1 -1
- package/package.json +3 -1
- package/runtime/bundle.json +1 -190
- package/runtime/scripts/api/git/recorded-lines.mjs +5 -5
- package/runtime/scripts/hfs/project-graph.mjs +6 -6
- package/runtime/scripts/hfs/project-rule.mjs +3 -3
- package/runtime/config.example.yaml +0 -194
- package/runtime/engine/by-code-unit.mjs +0 -12
- package/runtime/engine/config.mjs +0 -461
- package/runtime/engine/invalid-config.mjs +0 -15
- package/runtime/engine/model-config.mjs +0 -112
- package/runtime/engine/orca-config.mjs +0 -34
- package/runtime/engine/plain-object.mjs +0 -5
- package/runtime/engine/release-config.mjs +0 -32
- package/runtime/engine/removed-vocabulary.mjs +0 -27
- package/runtime/engine/resources-config.mjs +0 -59
- package/runtime/engine/runtime-root.mjs +0 -138
- package/runtime/engine/secrets.mjs +0 -202
- package/runtime/engine/sonar-config.mjs +0 -24
- package/runtime/engine/temp-root.mjs +0 -26
- package/runtime/engine/yaml.mjs +0 -161
- package/runtime/knowledge/grammars/index.yaml +0 -114
- package/runtime/knowledge/hfs/canon-pins.yaml +0 -716
- package/runtime/knowledge/hfs/fe-stack.yaml +0 -272
- package/runtime/knowledge/hfs/rules.yaml +0 -6760
- package/runtime/knowledge/hfs/slots.yaml +0 -2783
- package/runtime/knowledge/patterns/fe/folder.yaml +0 -425
- package/runtime/knowledge/sonar-gate.yaml +0 -151
- package/runtime/modules/kernel/removed-vocabulary.yaml +0 -458
- package/runtime/modules/models/registry.yaml +0 -221
- package/runtime/modules/models/runtimes.yaml +0 -556
- package/runtime/modules/models/tiers.yaml +0 -66
- package/runtime/scripts/api/git/cat-file.mjs +0 -4
- package/runtime/scripts/api/git/config-get.mjs +0 -9
- package/runtime/scripts/api/git/diff.mjs +0 -4
- package/runtime/scripts/api/git/lib.mjs +0 -80
- package/runtime/scripts/api/git/ls-files.mjs +0 -5
- package/runtime/scripts/api/git/ls-tree.mjs +0 -4
- package/runtime/scripts/api/git/merge-base.mjs +0 -8
- package/runtime/scripts/api/git/remote.mjs +0 -4
- package/runtime/scripts/api/git/rev-parse-query.mjs +0 -4
- package/runtime/scripts/api/git/show.mjs +0 -5
- package/runtime/scripts/api/git/tag.mjs +0 -4
- package/runtime/scripts/hfs/allows.mjs +0 -77
- package/runtime/scripts/hfs/architecture/ast-walks.mjs +0 -250
- package/runtime/scripts/hfs/architecture/automatic-gates.mjs +0 -103
- package/runtime/scripts/hfs/architecture/backend-app-files.mjs +0 -114
- package/runtime/scripts/hfs/architecture/backend.mjs +0 -462
- package/runtime/scripts/hfs/architecture/background-unowned.mjs +0 -254
- package/runtime/scripts/hfs/architecture/canon-clones.mjs +0 -291
- package/runtime/scripts/hfs/architecture/canon-jsx-clones.mjs +0 -224
- package/runtime/scripts/hfs/architecture/client-reaches-server.mjs +0 -102
- package/runtime/scripts/hfs/architecture/clones.mjs +0 -287
- package/runtime/scripts/hfs/architecture/component-tiers.mjs +0 -161
- package/runtime/scripts/hfs/architecture/config-unread.mjs +0 -16
- package/runtime/scripts/hfs/architecture/config.mjs +0 -407
- package/runtime/scripts/hfs/architecture/connection-map.mjs +0 -350
- package/runtime/scripts/hfs/architecture/constructor-deps.mjs +0 -115
- package/runtime/scripts/hfs/architecture/context-coupling.mjs +0 -117
- package/runtime/scripts/hfs/architecture/context-map.mjs +0 -355
- package/runtime/scripts/hfs/architecture/context-owner.mjs +0 -102
- package/runtime/scripts/hfs/architecture/context-platform-tables.mjs +0 -65
- package/runtime/scripts/hfs/architecture/context-transaction.mjs +0 -75
- package/runtime/scripts/hfs/architecture/contract-bounds.mjs +0 -72
- package/runtime/scripts/hfs/architecture/contract-fixture-guard.mjs +0 -177
- package/runtime/scripts/hfs/architecture/contracts-readonly.mjs +0 -360
- package/runtime/scripts/hfs/architecture/contracts.mjs +0 -489
- package/runtime/scripts/hfs/architecture/cross-app-duplicate.mjs +0 -81
- package/runtime/scripts/hfs/architecture/dead-exports-bindings.mjs +0 -173
- package/runtime/scripts/hfs/architecture/dead-exports.mjs +0 -420
- package/runtime/scripts/hfs/architecture/default-deny.mjs +0 -175
- package/runtime/scripts/hfs/architecture/doc-language.mjs +0 -45
- package/runtime/scripts/hfs/architecture/entity-registry.mjs +0 -51
- package/runtime/scripts/hfs/architecture/entrypoint.mjs +0 -75
- package/runtime/scripts/hfs/architecture/error-codes.mjs +0 -54
- package/runtime/scripts/hfs/architecture/error-masked.mjs +0 -78
- package/runtime/scripts/hfs/architecture/fe-slot-allows.mjs +0 -44
- package/runtime/scripts/hfs/architecture/feature-shape.mjs +0 -60
- package/runtime/scripts/hfs/architecture/framework-pinned.mjs +0 -41
- package/runtime/scripts/hfs/architecture/frontend-block-render.mjs +0 -112
- package/runtime/scripts/hfs/architecture/frontend-grammar.mjs +0 -193
- package/runtime/scripts/hfs/architecture/frontend-routing.mjs +0 -198
- package/runtime/scripts/hfs/architecture/frontend-world-render.mjs +0 -368
- package/runtime/scripts/hfs/architecture/frontend-world.mjs +0 -374
- package/runtime/scripts/hfs/architecture/frontend.mjs +0 -248
- package/runtime/scripts/hfs/architecture/function-spec-providers.mjs +0 -185
- package/runtime/scripts/hfs/architecture/hfs-graph.mjs +0 -77
- package/runtime/scripts/hfs/architecture/hfs.mjs +0 -394
- package/runtime/scripts/hfs/architecture/hooks-are-hooks.mjs +0 -118
- package/runtime/scripts/hfs/architecture/i18n-keys.mjs +0 -213
- package/runtime/scripts/hfs/architecture/identity.mjs +0 -121
- package/runtime/scripts/hfs/architecture/index.mjs +0 -402
- package/runtime/scripts/hfs/architecture/injection-token-exported.mjs +0 -69
- package/runtime/scripts/hfs/architecture/jwt-ast.mjs +0 -231
- package/runtime/scripts/hfs/architecture/machine-ast.mjs +0 -232
- package/runtime/scripts/hfs/architecture/managed-scripts.mjs +0 -32
- package/runtime/scripts/hfs/architecture/module-per-transport.mjs +0 -237
- package/runtime/scripts/hfs/architecture/next-data-contract.mjs +0 -126
- package/runtime/scripts/hfs/architecture/next-data-inference.mjs +0 -192
- package/runtime/scripts/hfs/architecture/next-data-key.mjs +0 -374
- package/runtime/scripts/hfs/architecture/next-data-symbols.mjs +0 -26
- package/runtime/scripts/hfs/architecture/next-data.mjs +0 -425
- package/runtime/scripts/hfs/architecture/operation-contract-roots.mjs +0 -55
- package/runtime/scripts/hfs/architecture/owners.mjs +0 -142
- package/runtime/scripts/hfs/architecture/package-shape.mjs +0 -92
- package/runtime/scripts/hfs/architecture/presentation.mjs +0 -173
- package/runtime/scripts/hfs/architecture/reachability.mjs +0 -330
- package/runtime/scripts/hfs/architecture/register-once.mjs +0 -212
- package/runtime/scripts/hfs/architecture/registration.mjs +0 -372
- package/runtime/scripts/hfs/architecture/render-graph.mjs +0 -449
- package/runtime/scripts/hfs/architecture/render-prop-across-server.mjs +0 -58
- package/runtime/scripts/hfs/architecture/required-files.mjs +0 -237
- package/runtime/scripts/hfs/architecture/root-packages.mjs +0 -78
- package/runtime/scripts/hfs/architecture/route-files-thin.mjs +0 -133
- package/runtime/scripts/hfs/architecture/schema-owner.mjs +0 -288
- package/runtime/scripts/hfs/architecture/server-action.mjs +0 -78
- package/runtime/scripts/hfs/architecture/side-boundary.mjs +0 -13
- package/runtime/scripts/hfs/architecture/source-names-shape.mjs +0 -320
- package/runtime/scripts/hfs/architecture/source-names.mjs +0 -393
- package/runtime/scripts/hfs/architecture/sql-keys.mjs +0 -344
- package/runtime/scripts/hfs/architecture/sql-owner.mjs +0 -291
- package/runtime/scripts/hfs/architecture/sql-returning.mjs +0 -76
- package/runtime/scripts/hfs/architecture/sql-token-forms.mjs +0 -117
- package/runtime/scripts/hfs/architecture/sql-tokens.mjs +0 -587
- package/runtime/scripts/hfs/architecture/staged-consumers.mjs +0 -42
- package/runtime/scripts/hfs/architecture/surface-nesting.mjs +0 -127
- package/runtime/scripts/hfs/architecture/surface.mjs +0 -88
- package/runtime/scripts/hfs/architecture/symbols.mjs +0 -273
- package/runtime/scripts/hfs/architecture/test-world-files.mjs +0 -263
- package/runtime/scripts/hfs/architecture/tiers.mjs +0 -256
- package/runtime/scripts/hfs/architecture/transport-owner.mjs +0 -248
- package/runtime/scripts/hfs/architecture/type-context.mjs +0 -335
- package/runtime/scripts/hfs/architecture/typescript.mjs +0 -477
- package/runtime/scripts/hfs/architecture/unit-spec-providers.mjs +0 -165
- package/runtime/scripts/hfs/declaration-shape.mjs +0 -196
- package/runtime/scripts/hfs/declaration-slots.mjs +0 -89
- package/runtime/scripts/hfs/edition-slots.mjs +0 -80
- package/runtime/scripts/hfs/explicit-surface-rule.mjs +0 -59
- package/runtime/scripts/hfs/linear-text.mjs +0 -30
- package/runtime/scripts/hfs/manifest-shape.mjs +0 -474
- package/runtime/scripts/hfs/param-names.mjs +0 -13
- package/runtime/scripts/hfs/path-findings.mjs +0 -167
- package/runtime/scripts/hfs/repo-identity.mjs +0 -89
- package/runtime/scripts/hfs/rule-catalog.mjs +0 -458
- package/runtime/scripts/hfs/rule-params-shape.mjs +0 -103
- package/runtime/scripts/hfs/rules/database-constants.mjs +0 -25
- package/runtime/scripts/hfs/rules/database-migrations.mjs +0 -684
- package/runtime/scripts/hfs/rules/fe-no-tests.mjs +0 -68
- package/runtime/scripts/hfs/rules/read.mjs +0 -45
- package/runtime/scripts/hfs/rules/secrets.mjs +0 -79
- package/runtime/scripts/hfs/rules/spec-placement.mjs +0 -28
- package/runtime/scripts/hfs/slot-app-view.mjs +0 -97
- package/runtime/scripts/hfs/slot-classify.mjs +0 -69
- package/runtime/scripts/hfs/slot-errors.mjs +0 -12
- package/runtime/scripts/hfs/slot-imports.mjs +0 -98
- package/runtime/scripts/hfs/slot-manifest-shape.mjs +0 -111
- package/runtime/scripts/hfs/slot-match.mjs +0 -164
- package/runtime/scripts/hfs/slot-path.mjs +0 -6
- package/runtime/scripts/hfs/slot-required.mjs +0 -95
- package/runtime/scripts/hfs/slot-semantic-problems.mjs +0 -175
- package/runtime/scripts/hfs/slot-side-problems.mjs +0 -32
- package/runtime/scripts/hfs/slots.mjs +0 -306
- package/runtime/scripts/hfs/test-world-slot.mjs +0 -5
- package/runtime/scripts/hfs/trailing-slashes.mjs +0 -8
- package/runtime/scripts/hfs/typescript-programs.mjs +0 -95
- package/runtime/scripts/hfs/view.mjs +0 -180
- package/runtime/scripts/lib/declaration-surface.mjs +0 -166
- package/runtime/scripts/lib/dockerfile.mjs +0 -164
- package/runtime/scripts/lib/env.mjs +0 -18
- package/runtime/scripts/lib/event-contract.mjs +0 -102
- package/runtime/scripts/lib/git-hooks-dir.mjs +0 -30
- package/runtime/scripts/lib/git.mjs +0 -35
- package/runtime/scripts/lib/glob.mjs +0 -32
- package/runtime/scripts/lib/grammar-lint.mjs +0 -57
- package/runtime/scripts/lib/i18n.mjs +0 -82
- package/runtime/scripts/lib/in-order.mjs +0 -90
- package/runtime/scripts/lib/json-clone.mjs +0 -70
- package/runtime/scripts/lib/json.mjs +0 -44
- package/runtime/scripts/lib/language.mjs +0 -233
- package/runtime/scripts/lib/list.mjs +0 -26
- package/runtime/scripts/lib/mutation-fence.mjs +0 -20
- package/runtime/scripts/lib/package-at.mjs +0 -62
- package/runtime/scripts/lib/path-key.mjs +0 -124
- package/runtime/scripts/lib/read-text.mjs +0 -47
- package/runtime/scripts/lib/regex.mjs +0 -3
- package/runtime/scripts/lib/rule-packs.mjs +0 -243
- package/runtime/scripts/lib/same-text.mjs +0 -4
- package/runtime/scripts/lib/secret-patterns.mjs +0 -230
- package/runtime/scripts/lib/sops-envelope.mjs +0 -212
- package/runtime/scripts/lib/stack-services.mjs +0 -191
- package/runtime/scripts/lib/ts-analysis.mjs +0 -39
- package/runtime/scripts/lib/ts-ast.mjs +0 -63
- package/runtime/scripts/lib/walk.mjs +0 -45
- package/runtime/scripts/lib/yaml-cached.mjs +0 -14
|
@@ -1,393 +0,0 @@
|
|
|
1
|
-
import path from 'node:path';
|
|
2
|
-
import { isInside } from './config.mjs';
|
|
3
|
-
import { relativePath, unwrapExpression } from './typescript.mjs';
|
|
4
|
-
import { commonJsRequireReasons, constructedDecoratorKind, decoratorCallee, moduleExportsOf, mutableDecoratorKind, nodeDecorators, normalizedSymbol, normalizedSymbolValue, programSourcesOf, returnedExpressions, selectedNode, valueSymbol, violation } from './ast-walks.mjs';
|
|
5
|
-
import { createBackendSourceShapeChecker } from './source-names-shape.mjs';
|
|
6
|
-
import { byCodeUnit } from '../../lib/list.mjs';
|
|
7
|
-
const SOURCE_LAYOUT_RULE_ID = 'BE_FEATURE_LAYOUT_INVALID';
|
|
8
|
-
const SOURCE_NAME_RULE_ID = 'BE_SOURCE_FORM';
|
|
9
|
-
const FRAMEWORK_EXPORTS = new Map([
|
|
10
|
-
['@nestjs/graphql', new Set(['Args', 'ArgsType', 'InputType', 'Mutation', 'ObjectType', 'Query', 'Subscription', 'registerEnumType'])],
|
|
11
|
-
['typeorm', new Set(['Entity', 'EntitySchema', 'MigrationInterface', 'ViewEntity'])],
|
|
12
|
-
]);
|
|
13
|
-
const APPLICATION_ROLES = new Set(['command', 'contracts', 'handler', 'query']);
|
|
14
|
-
const TRANSPORT_ROLES = new Set(['args', 'cli', 'consumer', 'controller', 'gateway', 'input', 'processor', 'request', 'resolver', 'response', 'type']);
|
|
15
|
-
const APPLICATION_LAYER_ROLES = new Set([...APPLICATION_ROLES, 'mapper']);
|
|
16
|
-
const TRANSPORT_LAYER_ROLES = new Set([...TRANSPORT_ROLES, 'enum', 'filter', 'guard', 'interceptor', 'mapper']);
|
|
17
|
-
// Class-bearing roles of the CLOSED suffix list of BE-CONVENTION 1.15 (class name = PascalCase of file + role). A role that is
|
|
18
|
-
// not in that list (adapter, exception, provider, repository, strategy, use-case) is never an allowed role here.
|
|
19
|
-
const CLASS_ROLE_SUFFIX = new Map([
|
|
20
|
-
['args', 'Args'], ['cli', 'Cli'], ['client', 'Client'], ['command', 'Command'], ['consumer', 'Consumer'],
|
|
21
|
-
['controller', 'Controller'], ['entity', 'Entity'], ['error', 'Error'], ['filter', 'Filter'], ['gateway', 'Gateway'],
|
|
22
|
-
['guard', 'Guard'], ['handler', 'Handler'], ['input', 'Input'], ['interceptor', 'Interceptor'], ['processor', 'Processor'], ['event', 'Event'], ['queue', 'Queue'],
|
|
23
|
-
['projection', 'Projection'], ['projection-entity', 'ProjectionEntity'], ['step', 'Step'], ['mapper', 'Mapper'], ['module', 'Module'], ['module-definition', 'Module'], ['policy', 'Policy'], ['query', 'Query'],
|
|
24
|
-
['request', 'Request'], ['resolver', 'Resolver'], ['response', 'Response'], ['service', 'Service'], ['type', 'Type'],
|
|
25
|
-
]);
|
|
26
|
-
// Transport object contracts (interfaces and object aliases) named by their file role: <Action>Input in *.input.ts,
|
|
27
|
-
// <Action>Request in *.request.ts, <Name>Row in *.rows.ts ... Domain values in *.contracts.ts and *.options.ts carry no suffix.
|
|
28
|
-
const TRANSPORT_OBJECT_SUFFIX = new Map([
|
|
29
|
-
['args', 'Args'], ['input', 'Input'], ['request', 'Request'], ['response', 'Response'], ['rows', 'Row'], ['type', 'Type'],
|
|
30
|
-
]);
|
|
31
|
-
// A class that implements an interface declared in a file with one of these roles may be named <Qualifier><InterfaceName>.
|
|
32
|
-
const PORT_DECLARATION_ROLES = new Set(['contracts', 'port']);
|
|
33
|
-
const NON_CLASS_ROLES = new Set(['constants', 'contracts', 'decorators', 'enum', 'providers', 'types']);
|
|
34
|
-
const KNOWN_HYPHEN_ROLES = [...CLASS_ROLE_SUFFIX.keys()].sort((a, b) => b.length - a.length);
|
|
35
|
-
const SPECIAL_BASENAMES = new Set(['config', 'configuration', 'constants', 'decorators', 'env', 'environment', 'index', 'main', 'types']);
|
|
36
|
-
const NO_PROGRAM_CHECKER = 'a TypeScript program checker could not be associated with its source';
|
|
37
|
-
const SOURCE_EXTENSION = /\.[cm]?[jt]sx?$/i;
|
|
38
|
-
/** A node that carries a name (a declaration, a member, a parameter). */
|
|
39
|
-
const hasName = (node) => 'name' in node && Boolean(node.name);
|
|
40
|
-
/** The framework kind a symbol is bound to, or null. */
|
|
41
|
-
const kindOfSymbol = (targets, symbol) => (symbol ? targets.get(symbol) ?? null : null);
|
|
42
|
-
function absoluteRoots(root, relatives) {
|
|
43
|
-
return relatives.map(relative => path.resolve(root, ...relative.split('/')));
|
|
44
|
-
}
|
|
45
|
-
function canonical(file) {
|
|
46
|
-
return path.resolve(file);
|
|
47
|
-
}
|
|
48
|
-
function addFrameworkTargets(config, context, checker, sourceFile, statement, bySymbol, reasons) {
|
|
49
|
-
const bound = moduleExportsOf(context.ts, checker, statement);
|
|
50
|
-
const selected = bound ? FRAMEWORK_EXPORTS.get(bound.specifier) : undefined;
|
|
51
|
-
if (!bound || !selected)
|
|
52
|
-
return;
|
|
53
|
-
if (!bound.symbol) {
|
|
54
|
-
reasons.push(`${relativePath(config.root, sourceFile.fileName)} cannot resolve ${bound.specifier}`);
|
|
55
|
-
return;
|
|
56
|
-
}
|
|
57
|
-
for (const [name, target] of bound.exports)
|
|
58
|
-
if (selected.has(name) && target)
|
|
59
|
-
bySymbol.set(target, name);
|
|
60
|
-
}
|
|
61
|
-
function frameworkTargets(config, context, checker, localFiles) {
|
|
62
|
-
const reasons = [];
|
|
63
|
-
const bySymbol = new Map();
|
|
64
|
-
const files = programSourcesOf(context, checker, localFiles);
|
|
65
|
-
if (!files)
|
|
66
|
-
return { bySymbol, reasons: [NO_PROGRAM_CHECKER] };
|
|
67
|
-
for (const sourceFile of files) {
|
|
68
|
-
for (const statement of sourceFile.statements) {
|
|
69
|
-
addFrameworkTargets(config, context, checker, sourceFile, statement, bySymbol, reasons);
|
|
70
|
-
}
|
|
71
|
-
commonJsRequireReasons(context.ts, checker, sourceFile, (specifier) => FRAMEWORK_EXPORTS.has(specifier), reasons, relativePath(config.root, sourceFile.fileName), 'binding whose source role cannot be proved');
|
|
72
|
-
}
|
|
73
|
-
return { bySymbol, reasons };
|
|
74
|
-
}
|
|
75
|
-
function decoratorKind(ts, checker, decorator, targets) {
|
|
76
|
-
const selected = selectedNode(ts, decoratorCallee(ts, decorator));
|
|
77
|
-
return selected ? kindOfSymbol(targets, valueSymbol(ts, checker, selected)) : null;
|
|
78
|
-
}
|
|
79
|
-
/* This module's trace descends `new X()` callees too; the framework map keys symbols directly. */
|
|
80
|
-
const TRACE_NEW = { newExpression: true };
|
|
81
|
-
function hasModifier(ts, node, kind) {
|
|
82
|
-
// a TypeScript older than canHaveModifiers keeps the modifiers on the node itself
|
|
83
|
-
return (ts.canHaveModifiers(node) ? ts.getModifiers(node) ?? [] : node.modifiers ?? []).some(modifier => modifier.kind === kind);
|
|
84
|
-
}
|
|
85
|
-
function sourceRole(ts, sourceFile) {
|
|
86
|
-
const file = path.basename(sourceFile.fileName).replace(SOURCE_EXTENSION, '');
|
|
87
|
-
const base = file.replace(/\.(?:int-)?spec$/i, '');
|
|
88
|
-
const segments = base.split('.');
|
|
89
|
-
if (segments.length > 1)
|
|
90
|
-
return { base, role: segments.at(-1)?.toLowerCase() ?? null, spec: base !== file };
|
|
91
|
-
const lower = base.toLowerCase();
|
|
92
|
-
const known = KNOWN_HYPHEN_ROLES.find(role => lower === role || lower.endsWith(`-${role}`));
|
|
93
|
-
if (known)
|
|
94
|
-
return { base, role: known, spec: base !== file };
|
|
95
|
-
const topLevel = sourceFile.statements;
|
|
96
|
-
if (topLevel.some(statement => ts.isEnumDeclaration(statement)))
|
|
97
|
-
return { base, role: 'enum', spec: base !== file };
|
|
98
|
-
return { base, role: null, spec: base !== file };
|
|
99
|
-
}
|
|
100
|
-
function kebabSourceBase(base) {
|
|
101
|
-
return /^[a-z0-9]+(?:-[a-z0-9]+)*(?:\.[a-z0-9]+(?:-[a-z0-9]+)*)*$/.test(base);
|
|
102
|
-
}
|
|
103
|
-
function exportedDeclarations(ts, checker, sourceFile) {
|
|
104
|
-
const exported = new Set();
|
|
105
|
-
const moduleSymbol = checker.getSymbolAtLocation(sourceFile);
|
|
106
|
-
for (const symbol of moduleSymbol ? checker.getExportsOfModule(moduleSymbol) : []) {
|
|
107
|
-
const target = normalizedSymbolValue(ts, checker, symbol);
|
|
108
|
-
for (const declaration of target?.getDeclarations?.() ?? [])
|
|
109
|
-
if (declaration.getSourceFile() === sourceFile)
|
|
110
|
-
exported.add(declaration);
|
|
111
|
-
}
|
|
112
|
-
return exported;
|
|
113
|
-
}
|
|
114
|
-
function combineClassValue(results) {
|
|
115
|
-
if (results.some(result => result.status === 'unavailable'))
|
|
116
|
-
return { status: 'unavailable', names: [] };
|
|
117
|
-
const classes = results.filter(result => result.status === 'class');
|
|
118
|
-
if (!classes.length)
|
|
119
|
-
return { status: 'not-class', names: [] };
|
|
120
|
-
if (classes.length !== results.length)
|
|
121
|
-
return { status: 'unavailable', names: [] };
|
|
122
|
-
return { status: 'class', names: [...new Set(classes.flatMap(result => result.names))] };
|
|
123
|
-
}
|
|
124
|
-
function pushReturnedClassStatuses(ts, checker, results, container, nextSeen, depth) {
|
|
125
|
-
for (const returned of returnedExpressions(ts, container))
|
|
126
|
-
results.push(classValueStatus(ts, checker, returned, nextSeen, depth + 1));
|
|
127
|
-
}
|
|
128
|
-
function classDeclarationResults(ts, checker, expression, declaration, nextSeen, depth) {
|
|
129
|
-
const results = [];
|
|
130
|
-
if (ts.isClassDeclaration(declaration))
|
|
131
|
-
results.push({ status: 'class', names: declaration.name ? [declaration.name.text] : [] });
|
|
132
|
-
if (ts.isVariableDeclaration(declaration) && declaration.initializer) {
|
|
133
|
-
if (ts.isCallExpression(expression)
|
|
134
|
-
&& (ts.isArrowFunction(declaration.initializer) || ts.isFunctionExpression(declaration.initializer))) {
|
|
135
|
-
pushReturnedClassStatuses(ts, checker, results, declaration.initializer, nextSeen, depth);
|
|
136
|
-
}
|
|
137
|
-
else
|
|
138
|
-
results.push(classValueStatus(ts, checker, declaration.initializer, nextSeen, depth + 1));
|
|
139
|
-
}
|
|
140
|
-
if (ts.isCallExpression(expression))
|
|
141
|
-
pushReturnedClassStatuses(ts, checker, results, declaration, nextSeen, depth);
|
|
142
|
-
return results;
|
|
143
|
-
}
|
|
144
|
-
function classSymbolStatus(ts, checker, expression, seen, depth) {
|
|
145
|
-
const selected = selectedNode(ts, ts.isCallExpression(expression) ? expression.expression : expression);
|
|
146
|
-
const symbol = selected ? normalizedSymbol(ts, checker, selected) : null;
|
|
147
|
-
if (!symbol || seen.has(symbol))
|
|
148
|
-
return { status: 'not-class', names: [] };
|
|
149
|
-
const nextSeen = new Set(seen).add(symbol);
|
|
150
|
-
const results = [];
|
|
151
|
-
for (const declaration of symbol.getDeclarations?.() ?? [])
|
|
152
|
-
results.push(...classDeclarationResults(ts, checker, expression, declaration, nextSeen, depth));
|
|
153
|
-
return results.length ? combineClassValue(results) : { status: 'not-class', names: [] };
|
|
154
|
-
}
|
|
155
|
-
function classValueStatus(ts, checker, expression, seen = new Set(), depth = 0) {
|
|
156
|
-
if (!expression)
|
|
157
|
-
return { status: 'not-class', names: [] };
|
|
158
|
-
if (depth > 10)
|
|
159
|
-
return { status: 'unavailable', names: [] };
|
|
160
|
-
const unwrapped = unwrapExpression(ts, expression);
|
|
161
|
-
if (ts.isClassExpression(unwrapped))
|
|
162
|
-
return { status: 'class', names: unwrapped.name ? [unwrapped.name.text] : [] };
|
|
163
|
-
if (ts.isConditionalExpression(unwrapped))
|
|
164
|
-
return combineClassValue([
|
|
165
|
-
classValueStatus(ts, checker, unwrapped.whenTrue, seen, depth + 1),
|
|
166
|
-
classValueStatus(ts, checker, unwrapped.whenFalse, seen, depth + 1),
|
|
167
|
-
]);
|
|
168
|
-
return classSymbolStatus(ts, checker, unwrapped, seen, depth);
|
|
169
|
-
}
|
|
170
|
-
function combineObjectStatus(statuses) {
|
|
171
|
-
if (statuses.includes('object'))
|
|
172
|
-
return 'object';
|
|
173
|
-
if (statuses.includes('unavailable'))
|
|
174
|
-
return 'unavailable';
|
|
175
|
-
return 'not-object';
|
|
176
|
-
}
|
|
177
|
-
function declarationObjectStatus(ts, checker, declaration, seen, depth) {
|
|
178
|
-
if (ts.isInterfaceDeclaration(declaration))
|
|
179
|
-
return 'object';
|
|
180
|
-
if (ts.isTypeAliasDeclaration(declaration))
|
|
181
|
-
return objectTypeStatus(ts, checker, declaration.type, seen, depth + 1);
|
|
182
|
-
if (ts.isTypeParameterDeclaration(declaration) || ts.isClassDeclaration(declaration))
|
|
183
|
-
return 'unavailable';
|
|
184
|
-
return 'not-object';
|
|
185
|
-
}
|
|
186
|
-
function typeReferenceStatus(ts, checker, node, seen, depth) {
|
|
187
|
-
const symbol = normalizedSymbol(ts, checker, node.typeName);
|
|
188
|
-
if (!symbol || seen.has(symbol))
|
|
189
|
-
return 'unavailable';
|
|
190
|
-
const nextSeen = new Set(seen).add(symbol);
|
|
191
|
-
const declarations = symbol.getDeclarations?.() ?? [];
|
|
192
|
-
if (!declarations.length)
|
|
193
|
-
return 'unavailable';
|
|
194
|
-
return combineObjectStatus(declarations.map(declaration => declarationObjectStatus(ts, checker, declaration, nextSeen, depth)));
|
|
195
|
-
}
|
|
196
|
-
function objectTypeStatus(ts, checker, node, seen = new Set(), depth = 0) {
|
|
197
|
-
if (!node || depth > 12)
|
|
198
|
-
return 'unavailable';
|
|
199
|
-
if (ts.isTypeLiteralNode(node) || ts.isMappedTypeNode(node))
|
|
200
|
-
return 'object';
|
|
201
|
-
if (ts.isParenthesizedTypeNode(node))
|
|
202
|
-
return objectTypeStatus(ts, checker, node.type, seen, depth + 1);
|
|
203
|
-
if (ts.isIntersectionTypeNode(node) || ts.isUnionTypeNode(node)) {
|
|
204
|
-
return combineObjectStatus(node.types.map(type => objectTypeStatus(ts, checker, type, seen, depth + 1)));
|
|
205
|
-
}
|
|
206
|
-
if (ts.isTypeReferenceNode(node))
|
|
207
|
-
return typeReferenceStatus(ts, checker, node, seen, depth);
|
|
208
|
-
if (ts.isConditionalTypeNode(node) || ts.isIndexedAccessTypeNode(node) || ts.isInferTypeNode(node) || ts.isTypeQueryNode(node))
|
|
209
|
-
return 'unavailable';
|
|
210
|
-
return 'not-object';
|
|
211
|
-
}
|
|
212
|
-
function objectContractStatus(ts, checker, node) {
|
|
213
|
-
if (ts.isInterfaceDeclaration(node))
|
|
214
|
-
return 'object';
|
|
215
|
-
return ts.isTypeAliasDeclaration(node) ? objectTypeStatus(ts, checker, node.type) : 'not-object';
|
|
216
|
-
}
|
|
217
|
-
function companionInterfaceAllowed(ts, sourceFile, name) {
|
|
218
|
-
if (!/^I[A-Z]/.test(name))
|
|
219
|
-
return false;
|
|
220
|
-
const companion = name.slice(1);
|
|
221
|
-
return sourceFile.statements.some(statement => ts.isClassDeclaration(statement) && statement.name?.text === companion
|
|
222
|
-
&& nodeDecorators(ts, statement).length > 0);
|
|
223
|
-
}
|
|
224
|
-
function camelCase(value) {
|
|
225
|
-
return /^[a-z][A-Za-z0-9]*$/.test(value);
|
|
226
|
-
}
|
|
227
|
-
function staticProperty(ts, object, name) {
|
|
228
|
-
if (!ts.isObjectLiteralExpression(object))
|
|
229
|
-
return { status: 'dynamic' };
|
|
230
|
-
const matching = object.properties.filter(property => {
|
|
231
|
-
if (!property.name)
|
|
232
|
-
return false;
|
|
233
|
-
if (ts.isIdentifier(property.name) || ts.isStringLiteralLike(property.name))
|
|
234
|
-
return property.name.text === name;
|
|
235
|
-
return false;
|
|
236
|
-
});
|
|
237
|
-
if (!matching.length)
|
|
238
|
-
return { status: 'missing' };
|
|
239
|
-
const [only] = matching;
|
|
240
|
-
if (matching.length !== 1 || !only || !ts.isPropertyAssignment(only))
|
|
241
|
-
return { status: 'dynamic', node: only };
|
|
242
|
-
const initializer = unwrapExpression(ts, only.initializer);
|
|
243
|
-
return ts.isStringLiteralLike(initializer)
|
|
244
|
-
? { status: 'literal', value: initializer.text, node: initializer }
|
|
245
|
-
: { status: 'dynamic', node: only.initializer };
|
|
246
|
-
}
|
|
247
|
-
function graphqlField({ config, context, sourceFile, node, decorator, kind, namingReasons, violations }) {
|
|
248
|
-
const call = decorator.expression;
|
|
249
|
-
if (!context.ts.isCallExpression(call)) {
|
|
250
|
-
namingReasons.push(`${relativePath(config.root, sourceFile.fileName)} has a non-call @${kind} decorator`);
|
|
251
|
-
return;
|
|
252
|
-
}
|
|
253
|
-
const options = call.arguments.find(argument => context.ts.isObjectLiteralExpression(unwrapExpression(context.ts, argument)));
|
|
254
|
-
const selected = options ? staticProperty(context.ts, unwrapExpression(context.ts, options), 'name') : { status: 'missing' };
|
|
255
|
-
if (selected.status === 'dynamic') {
|
|
256
|
-
namingReasons.push(`${relativePath(config.root, sourceFile.fileName)} has a dynamic @${kind} field name`);
|
|
257
|
-
return;
|
|
258
|
-
}
|
|
259
|
-
const declaredName = hasName(node) ? node.name : undefined;
|
|
260
|
-
const methodName = declaredName && (context.ts.isIdentifier(declaredName) || context.ts.isStringLiteralLike(declaredName)) ? declaredName.text : null;
|
|
261
|
-
const name = selected.status === 'literal' ? selected.value : methodName;
|
|
262
|
-
if (selected.status === 'literal') {
|
|
263
|
-
if (!methodName)
|
|
264
|
-
namingReasons.push(`${relativePath(config.root, sourceFile.fileName)} cannot prove the @${kind} method name`);
|
|
265
|
-
else if (selected.value !== methodName)
|
|
266
|
-
violations.push(violation(config, sourceFile, selected.node ?? node, SOURCE_NAME_RULE_ID, `GraphQL @${kind} field name ${selected.value} must equal its method name ${methodName}.`));
|
|
267
|
-
}
|
|
268
|
-
if (!name)
|
|
269
|
-
namingReasons.push(`${relativePath(config.root, sourceFile.fileName)} cannot prove the @${kind} field name`);
|
|
270
|
-
else if (!camelCase(name))
|
|
271
|
-
violations.push(violation(config, sourceFile, selected.node ?? declaredName ?? node, SOURCE_NAME_RULE_ID, `GraphQL field name ${name} must be camelCase.`));
|
|
272
|
-
}
|
|
273
|
-
function graphqlArgument(config, context, sourceFile, _node, decorator, namingReasons, violations) {
|
|
274
|
-
const call = decorator.expression;
|
|
275
|
-
const [argument] = context.ts.isCallExpression(call) ? call.arguments : [];
|
|
276
|
-
if (!context.ts.isCallExpression(call) || !argument) {
|
|
277
|
-
namingReasons.push(`${relativePath(config.root, sourceFile.fileName)} cannot prove the @Args input name`);
|
|
278
|
-
return;
|
|
279
|
-
}
|
|
280
|
-
const selected = unwrapExpression(context.ts, argument);
|
|
281
|
-
if (!context.ts.isStringLiteralLike(selected)) {
|
|
282
|
-
namingReasons.push(`${relativePath(config.root, sourceFile.fileName)} has a dynamic @Args input name`);
|
|
283
|
-
}
|
|
284
|
-
else if (selected.text !== 'input')
|
|
285
|
-
violations.push(violation(config, sourceFile, selected, SOURCE_NAME_RULE_ID, 'GraphQL request arguments use the literal name input.'));
|
|
286
|
-
}
|
|
287
|
-
function graphqlEnumRegistration(config, context, sourceFile, call, namingReasons, violations) {
|
|
288
|
-
const registration = call.arguments[1];
|
|
289
|
-
if (!registration) {
|
|
290
|
-
namingReasons.push(`${relativePath(config.root, sourceFile.fileName)} cannot prove the registered GraphQL enum name`);
|
|
291
|
-
return;
|
|
292
|
-
}
|
|
293
|
-
const selected = staticProperty(context.ts, unwrapExpression(context.ts, registration), 'name');
|
|
294
|
-
if (selected.status !== 'literal')
|
|
295
|
-
namingReasons.push(`${relativePath(config.root, sourceFile.fileName)} has a dynamic registered GraphQL enum name`);
|
|
296
|
-
else if (!/^[A-Z][A-Za-z0-9]*$/.test(selected.value ?? ''))
|
|
297
|
-
violations.push(violation(config, sourceFile, selected.node ?? call, SOURCE_NAME_RULE_ID, `Registered GraphQL enum name ${selected.value} must be PascalCase.`));
|
|
298
|
-
}
|
|
299
|
-
function selectedCallKind(ts, checker, call, targets) {
|
|
300
|
-
const selected = selectedNode(ts, call.expression);
|
|
301
|
-
return selected ? kindOfSymbol(targets, valueSymbol(ts, checker, selected)) : null;
|
|
302
|
-
}
|
|
303
|
-
function callsNamedHelper(ts, checker, call, name) {
|
|
304
|
-
const selected = selectedNode(ts, call.expression);
|
|
305
|
-
const symbol = selected ? normalizedSymbol(ts, checker, selected) : null;
|
|
306
|
-
return (symbol?.getDeclarations?.() ?? []).some(declaration => {
|
|
307
|
-
const declarationName = hasName(declaration) ? declaration.name : undefined;
|
|
308
|
-
return declarationName && (ts.isIdentifier(declarationName) || ts.isStringLiteralLike(declarationName)) && declarationName.text === name;
|
|
309
|
-
});
|
|
310
|
-
}
|
|
311
|
-
function implementsFramework(ts, checker, declaration, targets, name) {
|
|
312
|
-
return (declaration.heritageClauses ?? []).some(clause => clause.token === ts.SyntaxKind.ImplementsKeyword
|
|
313
|
-
&& clause.types.some(type => kindOfSymbol(targets, valueSymbol(ts, checker, type.expression)) === name));
|
|
314
|
-
}
|
|
315
|
-
/** Names of the interfaces a class implements that are declared in a *.port.ts or *.contracts.ts file (resolved by the type checker). */
|
|
316
|
-
function portNamesForImplementedType(ts, checker, type) {
|
|
317
|
-
const names = [];
|
|
318
|
-
const symbol = normalizedSymbol(ts, checker, type.expression);
|
|
319
|
-
for (const target of symbol?.getDeclarations?.() ?? []) {
|
|
320
|
-
if (!ts.isInterfaceDeclaration(target) && !ts.isTypeAliasDeclaration(target))
|
|
321
|
-
continue;
|
|
322
|
-
const declaredRole = path.basename(target.getSourceFile().fileName).replace(SOURCE_EXTENSION, '').split('.').at(-1);
|
|
323
|
-
if (declaredRole !== undefined && PORT_DECLARATION_ROLES.has(declaredRole))
|
|
324
|
-
names.push(target.name.text);
|
|
325
|
-
}
|
|
326
|
-
return names;
|
|
327
|
-
}
|
|
328
|
-
function implementedPortNames(ts, checker, declaration) {
|
|
329
|
-
return (declaration.heritageClauses ?? []).filter(clause => clause.token === ts.SyntaxKind.ImplementsKeyword)
|
|
330
|
-
.flatMap(clause => clause.types.flatMap(type => portNamesForImplementedType(ts, checker, type)));
|
|
331
|
-
}
|
|
332
|
-
function locatedRoot(roots, fileName) {
|
|
333
|
-
return roots.find(root => isInside(root, fileName)) ?? null;
|
|
334
|
-
}
|
|
335
|
-
/** Check the adopted domain-first backend source layout without inferring semantic ownership from folder names alone. */
|
|
336
|
-
const checkBackendSourceShapeImpl = createBackendSourceShapeChecker({
|
|
337
|
-
absoluteRoots, canonical, frameworkTargets, locatedRoot, sourceRole, kebabSourceBase, exportedDeclarations,
|
|
338
|
-
classValueStatus, objectContractStatus, companionInterfaceAllowed, hasModifier, graphqlField, graphqlArgument,
|
|
339
|
-
graphqlEnumRegistration, selectedCallKind, callsNamedHelper, implementsFramework, implementedPortNames, decoratorKind,
|
|
340
|
-
SOURCE_LAYOUT_RULE_ID, SOURCE_NAME_RULE_ID, APPLICATION_ROLES, TRANSPORT_ROLES, APPLICATION_LAYER_ROLES,
|
|
341
|
-
TRANSPORT_LAYER_ROLES, CLASS_ROLE_SUFFIX, TRANSPORT_OBJECT_SUFFIX, NON_CLASS_ROLES, SPECIAL_BASENAMES,
|
|
342
|
-
TRACE_NEW,
|
|
343
|
-
});
|
|
344
|
-
function inspectSubscriptionSource({ config, context, sourceFile, checker, framework, configuredRoot, namingReasons, violations }) {
|
|
345
|
-
const visit = (node) => {
|
|
346
|
-
for (const decorator of nodeDecorators(context.ts, node)) {
|
|
347
|
-
const kind = decoratorKind(context.ts, checker, decorator, framework.bySymbol);
|
|
348
|
-
if (kind === 'Subscription')
|
|
349
|
-
graphqlField({ config, context, sourceFile, node, decorator, kind, namingReasons, violations });
|
|
350
|
-
else if (!kind && !configuredRoot) {
|
|
351
|
-
const dynamic = mutableDecoratorKind(context.ts, checker, decorator, framework.bySymbol)
|
|
352
|
-
?? constructedDecoratorKind(context.ts, checker, decorator, framework.bySymbol, TRACE_NEW);
|
|
353
|
-
if (dynamic !== null && ['Subscription', 'multiple framework', 'unproven framework'].includes(dynamic)) {
|
|
354
|
-
namingReasons.push(`${relativePath(config.root, sourceFile.fileName)} uses a mutable or constructed ${dynamic} decorator identity`);
|
|
355
|
-
}
|
|
356
|
-
}
|
|
357
|
-
}
|
|
358
|
-
context.ts.forEachChild(node, visit);
|
|
359
|
-
};
|
|
360
|
-
visit(sourceFile);
|
|
361
|
-
}
|
|
362
|
-
export function checkBackendSourceShape(config, context) {
|
|
363
|
-
const result = checkBackendSourceShapeImpl(config, context);
|
|
364
|
-
const roots = absoluteRoots(config.root, [...config.backend.features, ...config.backend.modules]);
|
|
365
|
-
const localFiles = new Set(context.files.map(file => canonical(file.fileName)));
|
|
366
|
-
const frameworkByChecker = new Map();
|
|
367
|
-
const namingReasons = [];
|
|
368
|
-
// The shared shape walk dispatches Query and Mutation; subscriptions use the same naming relation here.
|
|
369
|
-
for (const sourceFile of context.files) {
|
|
370
|
-
const fileName = canonical(sourceFile.fileName);
|
|
371
|
-
const configuredRoot = locatedRoot(roots, fileName);
|
|
372
|
-
const owner = config.hfs?.ownerOf?.(relativePath(config.root, fileName));
|
|
373
|
-
const slot = owner ? config.hfs.slot(owner.slot) : null;
|
|
374
|
-
if (!configuredRoot && !(slot?.tier === 'feature' && slot.profiles?.includes('be')))
|
|
375
|
-
continue;
|
|
376
|
-
const checker = context.checkerFor(fileName);
|
|
377
|
-
if (!checker)
|
|
378
|
-
continue;
|
|
379
|
-
let framework = frameworkByChecker.get(checker);
|
|
380
|
-
if (!framework) {
|
|
381
|
-
framework = frameworkTargets(config, context, checker, localFiles);
|
|
382
|
-
frameworkByChecker.set(checker, framework);
|
|
383
|
-
}
|
|
384
|
-
inspectSubscriptionSource({ config, context, sourceFile, checker, framework, configuredRoot, namingReasons, violations: result.violations });
|
|
385
|
-
}
|
|
386
|
-
if (namingReasons.length)
|
|
387
|
-
result.coverage.naming = {
|
|
388
|
-
status: 'unavailable', reason: 'one or more backend source naming relations are not statically proved',
|
|
389
|
-
details: [...new Set([...(result.coverage.naming.details ?? []), ...namingReasons])].sort(byCodeUnit),
|
|
390
|
-
};
|
|
391
|
-
return result;
|
|
392
|
-
}
|
|
393
|
-
export { SOURCE_LAYOUT_RULE_ID, SOURCE_NAME_RULE_ID };
|