@starci/hfs 4.0.10 → 4.2.0

package/runtime/scripts/hfs/architecture/source-names-shape.mjs

@@ -0,0 +1,318 @@
+import { relativePath, UNPROVEN_FRAMEWORK, unwrapExpression } from './typescript.mjs';
+import { constructedDecoratorKind, mutableDecoratorKind, nodeDecorators, tracedFrameworkKinds, violation } from './ast-walks.mjs';
+import { byCodeUnit } from '../../lib/list.mjs';
+function locateSource(h, config, context, sourceFile, roots, state) {
+  const { featureRoots, moduleRoots, localFiles } = roots;
+  const { canonical, frameworkTargets, locatedRoot, sourceRole, exportedDeclarations, SPECIAL_BASENAMES } = h;
+  const fileName = canonical(sourceFile.fileName);
+  const featureRoot = locatedRoot(featureRoots, fileName);
+  const moduleRoot = locatedRoot(moduleRoots, fileName);
+  if (!featureRoot && !moduleRoot) return null;
+  state.checkedFiles += 1;
+  const checker = context.checkerFor(fileName);
+  if (!state.frameworkByChecker.has(checker)) state.frameworkByChecker.set(checker, frameworkTargets(config, context, checker, localFiles));
+  const framework = state.frameworkByChecker.get(checker);
+  const relativeToOwner = relativePath(featureRoot ?? moduleRoot, fileName);
+  const parts = relativeToOwner.split('/');
+  const directories = parts.slice(0, -1).map(part => part.toLowerCase());
+  const applicationIndex = directories.indexOf('application');
+  const transportIndex = directories.indexOf('transport');
+  const inApplication = applicationIndex >= 0;
+  const inTransport = transportIndex >= 0;
+  const role = sourceRole(context.ts, sourceFile);
+  const relative = relativePath(config.root, fileName);
+  const migrationName = /^\d{10,}-[A-Z][A-Za-z0-9]*$/.test(role.base);
+  const persistencePath = !role.spec && (migrationName || directories.includes('migrations'));
+  const special = SPECIAL_BASENAMES.has(role.base.toLowerCase()) || migrationName
+    || ['constants', 'enums', 'errors', 'migrations'].some(folder => directories.includes(folder));
+  const publicDeclarations = exportedDeclarations(context.ts, checker, sourceFile);
+  return { config, context, sourceFile, fileName, featureRoot, moduleRoot, checker, framework, directories, transportIndex,
+    inApplication, inTransport, role, relative, migrationName, persistencePath, special, publicDeclarations };
+}
+
+function reportSourceName(h, info, state) {
+  const { kebabSourceBase, SOURCE_NAME_RULE_ID } = h;
+  const { config, sourceFile, migrationName, role, relative } = info;
+  if (!migrationName && !kebabSourceBase(role.base)) state.violations.push(violation(config, sourceFile, sourceFile, SOURCE_NAME_RULE_ID,
+    `Source basename ${role.base} must use kebab-case segments plus an explicit role suffix.`));
+  if (!role.role && !info.special) state.namingReasons.push(`${relative} has no statically identifiable source role`);
+}
+
+function reportFeatureRoleConflicts(h, info, state) {
+  const { SOURCE_LAYOUT_RULE_ID, APPLICATION_ROLES, TRANSPORT_ROLES } = h;
+  const { config, sourceFile, role, directories, inApplication, inTransport, transportIndex } = info;
+  const { violations } = state;
+  if (inApplication && inTransport) violations.push(violation(config, sourceFile, sourceFile, SOURCE_LAYOUT_RULE_ID,
+    'A feature source cannot belong to both application and transport layers.'));
+  if (role.role && APPLICATION_ROLES.has(role.role) && !inApplication) violations.push(violation(config, sourceFile, sourceFile,
+    SOURCE_LAYOUT_RULE_ID, `${role.role} source belongs under the feature application/ layer.`));
+  if (role.role && TRANSPORT_ROLES.has(role.role) && !inTransport) violations.push(violation(config, sourceFile, sourceFile,
+    SOURCE_LAYOUT_RULE_ID, `${role.role} source belongs under the feature transport/<protocol>/ layer.`));
+  if (inApplication && role.role && TRANSPORT_ROLES.has(role.role)) violations.push(violation(config, sourceFile, sourceFile,
+    SOURCE_LAYOUT_RULE_ID, `Transport role ${role.role} cannot live in application/.`));
+  if (inTransport && role.role && APPLICATION_ROLES.has(role.role)) violations.push(violation(config, sourceFile, sourceFile,
+    SOURCE_LAYOUT_RULE_ID, `Application role ${role.role} cannot live in transport/.`));
+  if (inTransport && transportIndex >= directories.length - 1) violations.push(violation(config, sourceFile, sourceFile,
+    SOURCE_LAYOUT_RULE_ID, 'Feature transport source must name a protocol below transport/.'));
+}
+
+/** A non-index source whose role is neither one of the layer's own roles nor one the other layer or the schema owns. */
+function unselectedLayerRole(role, layerRoles, otherRoles) {
+  return role.base !== 'index' && (!role.role || !layerRoles.has(role.role)) && !(role.role && (otherRoles.has(role.role) || role.role === 'entity'));
+}
+
+function reportFeatureRoleSelection(h, info, state) {
+  const { APPLICATION_ROLES, TRANSPORT_ROLES, APPLICATION_LAYER_ROLES, TRANSPORT_LAYER_ROLES } = h;
+  const { role, relative, directories, inApplication, inTransport, persistencePath } = info;
+  const topLevelFeatureFile = directories.length === 1 && (role.base === 'index' || role.role === 'module' || role.spec);
+  if (inApplication && unselectedLayerRole(role, APPLICATION_LAYER_ROLES, TRANSPORT_ROLES)) {
+    state.layoutReasons.push(`${relative} role ${role.role ?? '(unclassified)'} is not a selected application-layer role`);
+  }
+  if (inTransport && unselectedLayerRole(role, TRANSPORT_LAYER_ROLES, APPLICATION_ROLES)) {
+    state.layoutReasons.push(`${relative} role ${role.role ?? '(unclassified)'} is not a selected transport-layer role`);
+  }
+  if (inApplication || inTransport || topLevelFeatureFile) return;
+  if (role.role && role.role !== 'entity' && !APPLICATION_ROLES.has(role.role) && !TRANSPORT_ROLES.has(role.role)) {
+    state.layoutReasons.push(`${relative} role ${role.role} has no statically selected feature layer`);
+  }
+  if (!role.role && !persistencePath) state.layoutReasons.push(`${relative} has no statically selected feature layer`);
+}
+
+function reportFeatureSchemaPlacement(h, info, state) {
+  const { SOURCE_LAYOUT_RULE_ID } = h;
+  const { config, sourceFile, role, persistencePath } = info;
+  if (persistencePath) state.violations.push(violation(config, sourceFile, sourceFile, SOURCE_LAYOUT_RULE_ID,
+    'Migration source cannot be owned by a feature; place it under the declared persistence module.'));
+  if (role.role === 'entity') state.violations.push(violation(config, sourceFile, sourceFile, SOURCE_LAYOUT_RULE_ID,
+    'Entity source cannot be owned by a feature; place schema under the declared persistence module.'));
+}
+
+function reportFeatureLayout(h, info, state) {
+  if (!info.featureRoot) return;
+  reportFeatureRoleConflicts(h, info, state);
+  reportFeatureRoleSelection(h, info, state);
+  reportFeatureSchemaPlacement(h, info, state);
+}
+
+function inspectClassPlacement(h, info, declaration, kinds, state) {
+  const { implementsFramework, SOURCE_LAYOUT_RULE_ID } = h;
+  const { config, context, sourceFile, featureRoot, inTransport, directories, transportIndex, checker, framework } = info;
+  const { ts } = context;
+  const graphQlDto = kinds.some(kind => kind === 'ArgsType' || kind === 'InputType' || kind === 'ObjectType');
+  if (graphQlDto && (!featureRoot || !inTransport || directories[transportIndex + 1] !== 'graphql')) {
+    state.violations.push(violation(config, sourceFile, declaration.name ?? declaration, SOURCE_LAYOUT_RULE_ID,
+      'GraphQL DTO classes belong under a feature transport/graphql/ boundary.'));
+  }
+  const persistenceSchema = kinds.includes('Entity') || kinds.includes('ViewEntity')
+    || implementsFramework(ts, checker, declaration, framework.bySymbol, 'MigrationInterface');
+  if (persistenceSchema && featureRoot) state.violations.push(violation(config, sourceFile, declaration.name ?? declaration, SOURCE_LAYOUT_RULE_ID,
+    'TypeORM entities and migrations cannot be owned by a feature; place schema under its declared persistence module.'));
+}
+
+function inspectClassName(h, info, declaration, state) {
+  const { implementedPortNames, SOURCE_NAME_RULE_ID, CLASS_ROLE_SUFFIX, NON_CLASS_ROLES } = h;
+  const { config, sourceFile, role, relative, checker } = info;
+  const { ts } = info.context;
+  const { publicDeclarations } = info;
+  const classSuffix = role.role && !NON_CLASS_ROLES.has(role.role) ? CLASS_ROLE_SUFFIX.get(role.role) : null;
+  if (publicDeclarations.has(declaration) && !declaration.name) state.namingReasons.push(`${relative} exports an anonymous class whose role name cannot be proved`);
+  else if (publicDeclarations.has(declaration) && declaration.name && classSuffix && !declaration.name.text.endsWith(classSuffix)
+    && !implementedPortNames(ts, checker, declaration).some(port => declaration.name.text.endsWith(port))) {
+    state.violations.push(violation(config, sourceFile, declaration.name, SOURCE_NAME_RULE_ID,
+      `Exported class ${declaration.name.text} must end in ${classSuffix} for a ${role.role} source file, or in the name of the port it implements.`));
+  } else if (publicDeclarations.has(declaration) && declaration.name && role.role && !NON_CLASS_ROLES.has(role.role) && !classSuffix) {
+    state.namingReasons.push(`${relative} declares exported class ${declaration.name.text} with unclassified file role ${role.role}`);
+  }
+}
+
+function inspectClass(h, info, declaration, state) {
+  const { decoratorKind } = h;
+  const { ts } = info.context;
+  const { checker, framework } = info;
+  const declarationDecorators = nodeDecorators(ts, declaration);
+  const kinds = declarationDecorators.map(decorator => decoratorKind(ts, checker, decorator, framework.bySymbol)).filter(Boolean);
+  inspectClassPlacement(h, info, declaration, kinds, state);
+  inspectClassName(h, info, declaration, state);
+}
+
+function inspectClasses(h, info, state) {
+  const declarations = info.sourceFile.statements.filter(statement => info.context.ts.isClassDeclaration(statement));
+  for (const declaration of declarations) inspectClass(h, info, declaration, state);
+}
+
+function inspectClassValue(h, info, declaration, state) {
+  const { classValueStatus, SOURCE_NAME_RULE_ID, CLASS_ROLE_SUFFIX, NON_CLASS_ROLES } = h;
+  const { config, sourceFile, relative, role, checker, publicDeclarations } = info;
+  const { ts } = info.context;
+  if (!publicDeclarations.has(declaration) || !declaration.initializer) return;
+  const classValue = classValueStatus(ts, checker, declaration.initializer);
+  if (classValue.status === 'unavailable') {
+    state.namingReasons.push(`${relative} exports a class-valued declaration whose role identity is not statically proved`);
+    return;
+  }
+  if (classValue.status !== 'class') return;
+  const classSuffix = role.role && !NON_CLASS_ROLES.has(role.role) ? CLASS_ROLE_SUFFIX.get(role.role) : null;
+  if (!classSuffix || !ts.isIdentifier(declaration.name)) {
+    state.namingReasons.push(`${relative} exports a class-valued declaration without a statically selected class role`);
+    return;
+  }
+  const names = [declaration.name.text, ...classValue.names];
+  const invalid = names.find(name => !name.endsWith(classSuffix));
+  if (invalid) state.violations.push(violation(config, sourceFile, declaration.name, SOURCE_NAME_RULE_ID,
+    `Exported class value ${invalid} must end in ${classSuffix} for a ${role.role} source file.`));
+}
+
+function inspectClassValues(h, info, state) {
+  const { ts } = info.context;
+  const { sourceFile } = info;
+  for (const statement of sourceFile.statements) if (ts.isVariableStatement(statement)) {
+    for (const declaration of statement.declarationList.declarations) inspectClassValue(h, info, declaration, state);
+  }
+}
+
+function inspectEnumMembers(h, info, statement, state) {
+  const { SOURCE_NAME_RULE_ID } = h;
+  const { config, sourceFile } = info;
+  const { ts } = info.context;
+  for (const member of statement.members) {
+    const name = ts.isIdentifier(member.name) || ts.isStringLiteralLike(member.name) ? member.name.text : null;
+    const initializer = member.initializer && unwrapExpression(ts, member.initializer);
+    if (!name || !/^[A-Z][A-Za-z0-9]*$/.test(name) || !initializer || !ts.isStringLiteralLike(initializer)) {
+      state.violations.push(violation(config, sourceFile, member.name, SOURCE_NAME_RULE_ID,
+        'Enum members must use PascalCase names with explicit static string values.'));
+    }
+  }
+}
+
+function inspectObjectContract(h, info, statement, state) {
+  const { objectContractStatus, companionInterfaceAllowed, SOURCE_NAME_RULE_ID, TRANSPORT_OBJECT_SUFFIX } = h;
+  const { config, sourceFile, role, checker, publicDeclarations } = info;
+  const { ts } = info.context;
+  const contractStatus = objectContractStatus(ts, checker, statement);
+  const transportSuffix = TRANSPORT_OBJECT_SUFFIX.get(role.role);
+  if (contractStatus === 'object' && publicDeclarations.has(statement) && transportSuffix && !role.spec
+    && !statement.name.text.endsWith(transportSuffix) && !companionInterfaceAllowed(ts, sourceFile, statement.name.text)) {
+    state.violations.push(violation(config, sourceFile, statement.name, SOURCE_NAME_RULE_ID,
+      `Public object contract ${statement.name.text} in a ${role.role} source file must end in ${transportSuffix}.`));
+  }
+}
+
+function inspectEnumAndContract(h, info, statement, state) {
+  const { hasModifier, SOURCE_NAME_RULE_ID } = h;
+  const { config, sourceFile } = info;
+  const { ts } = info.context;
+  if (ts.isEnumDeclaration(statement)) {
+    if (hasModifier(ts, statement, ts.SyntaxKind.ConstKeyword) || !/^[A-Z][A-Za-z0-9]*$/.test(statement.name.text)) {
+      state.violations.push(violation(config, sourceFile, statement.name, SOURCE_NAME_RULE_ID,
+        'Enums must be non-const declarations with PascalCase names.'));
+    }
+    inspectEnumMembers(h, info, statement, state);
+  }
+  inspectObjectContract(h, info, statement, state);
+}
+
+function inspectEnumsAndContracts(h, info, state) {
+  for (const statement of info.sourceFile.statements) inspectEnumAndContract(h, info, statement, state);
+}
+
+function inspectDynamicDecorator(info, dynamic, state) {
+  const detail = `${info.relative} uses a mutable or constructed ${dynamic} decorator identity`;
+  if (['Entity', 'ViewEntity', 'ArgsType', 'InputType', 'ObjectType', 'multiple framework', 'unproven framework'].includes(dynamic)) state.layoutReasons.push(detail);
+  if (!['Entity', 'ViewEntity'].includes(dynamic)) state.namingReasons.push(detail);
+}
+
+function inspectDecorator(h, info, node, decorator, state) {
+  const { graphqlField, graphqlArgument, decoratorKind, TRACE_NEW } = h;
+  const { ts } = info.context;
+  const { checker, framework } = info;
+  const kind = decoratorKind(ts, checker, decorator, framework.bySymbol);
+  if (!kind) {
+    const dynamic = mutableDecoratorKind(ts, checker, decorator, framework.bySymbol)
+      ?? constructedDecoratorKind(ts, checker, decorator, framework.bySymbol, TRACE_NEW);
+    if (dynamic) inspectDynamicDecorator(info, dynamic, state);
+  }
+  if (kind === 'Mutation' || kind === 'Query') graphqlField({ config: info.config, context: info.context, sourceFile: info.sourceFile,
+    node, decorator, kind, namingReasons: state.namingReasons, violations: state.violations });
+  if (kind === 'Args') graphqlArgument(info.config, info.context, info.sourceFile, node, decorator, state.namingReasons, state.violations);
+}
+
+function inspectNodeDecorators(h, info, node, state) {
+  for (const decorator of nodeDecorators(info.context.ts, node)) inspectDecorator(h, info, node, decorator, state);
+}
+
+function inspectEnumCalls(h, info, node, state) {
+  const { graphqlEnumRegistration, selectedCallKind, callsNamedHelper } = h;
+  const { ts } = info.context;
+  const { checker, framework } = info;
+  if (!ts.isCallExpression(node)) return;
+  if (selectedCallKind(ts, checker, node, framework.bySymbol) === 'registerEnumType') {
+    graphqlEnumRegistration(info.config, info.context, info.sourceFile, node, state.namingReasons, state.violations);
+  } else if (callsNamedHelper(ts, checker, node, 'createEnumType')) {
+    state.namingReasons.push(`${info.relative} calls a project GraphQL enum adapter whose emitted type name is not statically proved`);
+  }
+}
+
+function inspectConstructedSource(h, info, node, state) {
+  const { SOURCE_LAYOUT_RULE_ID, TRACE_NEW } = h;
+  const { ts } = info.context;
+  const { checker, framework, publicDeclarations, featureRoot } = info;
+  const exportedFactoryCall = ts.isCallExpression(node) && ts.isVariableDeclaration(node.parent) && publicDeclarations.has(node.parent);
+  if ((ts.isNewExpression(node) || exportedFactoryCall) && featureRoot) {
+    const constructed = tracedFrameworkKinds(ts, checker, node, framework.bySymbol, TRACE_NEW);
+    if (constructed.has('EntitySchema')) state.violations.push(violation(info.config, info.sourceFile, node.expression, SOURCE_LAYOUT_RULE_ID,
+      'TypeORM EntitySchema cannot be owned by a feature; place schema under its declared persistence module.'));
+    if (constructed.has(UNPROVEN_FRAMEWORK)) state.layoutReasons.push(`${info.relative} has a constructed provider identity beyond the bounded static trace`);
+  }
+}
+
+function visitSourceNode(h, info, node, state) {
+  inspectNodeDecorators(h, info, node, state);
+  inspectEnumCalls(h, info, node, state);
+  inspectConstructedSource(h, info, node, state);
+  info.context.ts.forEachChild(node, child => visitSourceNode(h, info, child, state));
+}
+
+function inspectSourceFile(h, config, context, sourceFile, roots, state) {
+  const info = locateSource(h, config, context, sourceFile, roots, state);
+  if (!info) return;
+  reportSourceName(h, info, state);
+  reportFeatureLayout(h, info, state);
+  inspectClasses(h, info, state);
+  inspectClassValues(h, info, state);
+  inspectEnumsAndContracts(h, info, state);
+  visitSourceNode(h, info, sourceFile, state);
+}
+
+function coverageFor(state) {
+  for (const framework of state.frameworkByChecker.values()) {
+    state.layoutReasons.push(...framework.reasons);
+    state.namingReasons.push(...framework.reasons.filter(reason => reason.includes('@nestjs/graphql')));
+  }
+  if (state.checkedFiles === 0) {
+    state.layoutReasons.push('the checked TypeScript program contains no configured backend feature or module source');
+    state.namingReasons.push('the checked TypeScript program contains no configured backend feature or module source');
+  }
+  return {
+    files: state.checkedFiles,
+    layout: state.layoutReasons.length
+      ? { status: 'unavailable', reason: 'one or more backend source placement relations are not statically proved', details: [...new Set(state.layoutReasons)].sort(byCodeUnit) }
+      : { status: 'checked' },
+    naming: state.namingReasons.length
+      ? { status: 'unavailable', reason: 'one or more backend source naming relations are not statically proved', details: [...new Set(state.namingReasons)].sort(byCodeUnit) }
+      : { status: 'checked' },
+  };
+}
+
+/** Check the adopted domain-first backend source layout without inferring semantic ownership from folder names alone. */
+export function createBackendSourceShapeChecker(helpers) {
+  const { absoluteRoots, canonical } = helpers;
+  return function checkBackendSourceShape(config, context) {
+    const featureRoots = absoluteRoots(config.root, config.backend.features);
+    const moduleRoots = absoluteRoots(config.root, config.backend.modules);
+    const localFiles = new Set(context.files.map(file => canonical(file.fileName)));
+    const state = { frameworkByChecker: new Map(), violations: [], layoutReasons: [], namingReasons: [], checkedFiles: 0 };
+    const roots = { featureRoots, moduleRoots, localFiles };
+    for (const sourceFile of context.files) inspectSourceFile(helpers, config, context, sourceFile, roots, state);
+    return { violations: state.violations, coverage: coverageFor(state) };
+  };
+}