Référence d'API — nodefony — kernel-checks

stable

Documentation › Référence d’API › nodefony › kernel-checks

Générée depuis les déclarations de types publiées de nodefony 10.0.0-beta.5 : exactement ce que reçoit une application qui l’installe. Cette page n’existe dans aucun dépôt — pour la corriger, on corrige le TSDoc du code.

nodefony#

import { … } from "nodefony" — 19 symboles.

Fonctions (11)#

collectDoctorReport#

function collectDoctorReport(start: string, targetEnv?: string | null, deepRequested?: boolean, report?: DeepReporter): Promise<IDoctorReport>

Collecte le diagnostic — sans rien imprimer.

countCheckFindings#

function countCheckFindings(report: IDoctorReport): number

Nombre total de manquements d’un rapport — le verdict, en un endroit.

fragmentsWithoutSatisfies#

function fragmentsWithoutSatisfies(projectRoot: string, reader: IManifestReader): string[]

Les fragments qui rendent une configuration SANS satisfies.

isReservedFragmentName#

function isReservedFragmentName(name: string): boolean

Le nom appartient-il au chargement d’un MODULE, et non à un fragment ?

manifestFileWith#

function manifestFileWith(projectRoot: string, reader: IManifestReader, pattern: RegExp): string

Le fichier du manifeste qui porte un motif — celui qu’un ÉCRIVAIN doit modifier.

projectEntityDialectMismatches#

function projectEntityDialectMismatches(projectRoot: string, dialect: SqlDialectName): IEntityDialectScan

Les entités du PROJET qu’un connecteur de ce dialecte ne saurait pas servir.

readManifestCode#

function readManifestCode(projectRoot: string, reader: IManifestReader): string

Le CODE du manifeste entier — racine puis fragments, commentaires retirés, concaténés — pour les lecteurs qui cherchent un motif sans avoir à savoir quel fichier le porte (security:secrets, l’état d’installation).

readManifestSources#

function readManifestSources(projectRoot: string, reader: IManifestReader): IManifestSource[]

Rend TOUS les textes qui composent le manifeste d’une application.

reservedFragmentFiles#

function reservedFragmentFiles(projectRoot: string, reader: IManifestReader): string[]

Les fichiers de <app>/nodefony/config/ qui portent un nom RÉSERVÉ — hors sous-dossiers, dont cluster/, lu par chemin par le process maître.

skippedChecks#

function skippedChecks(execution: Partial<Record<DoctorFamily, IExecution>>): ISkippedCheck[]

Les contrôles qui n’ont PAS eu lieu, dans l’ordre de lecture du rapport.

withoutComments#

function withoutComments(source: string): string

Le CODE d’une source : son texte privé de ses commentaires.

Constantes (2)#

GENERATED_VITE_CONFIG_FILE#

const GENERATED_VITE_CONFIG_FILE = "vite.config.generated.mjs"

Config Vite que le superviseur de développement RÉÉCRIT à chaque démarrage, à la racine du frontend. Ce n’est pas une source : la compter faisait annoncer un build périmé à toute application dont on venait de lancer npm run dev. Nom unique, lu aussi par l’écrivain (@nodefony/frontend).

diskManifestReader#

const diskManifestReader: IManifestReader

LE lecteur du disque — l’implémentation unique que les contrôles, le scaffold hors simulation et les bancs passent à readManifestSources.

Interfaces (5)#

IDoctorReport#

interface IDoctorReport

Rapport de diagnostic statique, tel que toutes les portes le lisent.

• root: string — Racine de l’application effectivement contrôlée.
• appName: string — nom version tel que le manifeste le déclare — vide s’il ne dit rien.
• scanned: number — Nombre de paquets parcourus.
• findings: ReturnType<typeof checkPackageDeps>["findings"] — Manquements de dépendances.
• wiring: { scanned: number; findings: ReturnType<typeof checkWiring>["findings"]; notices?: ReturnType<typeof checkWiring>["notices"]; } — Manquements de câblage, avec le nombre de classes contrôlées.
• readiness: IReadinessResult — Ce qui manque ICI et maintenant (env, modules, deps, ports).
• freshness: IFreshnessResult — Écarts entre ce qui est ÉCRIT et ce qui s’EXÉCUTERA (build, plancher Node).
• nodeSecurity?: INodeSecurityGap | null — Le Node de ce poste porte-t-il des failles déjà corrigées ?
• surface: ISurfaceResult — Ce qui est atteignable SANS authentification, et les entités hors dialecte.
• guards: IGuardResult — Les filets du projet — sont-ils ARMÉS ?
• deep: IDeepResult | null — Étage 3 — ce que le projet DÉCLARE, réellement lancé (--deep).
• lastBoots: ILastBoot[] — Les bilans de démarrage disponibles — serveur d’abord, console ensuite.
• exceptions: number — Exceptions déclarées, comptées dans le rendu humain.
• live?: ILiveResult — Ce que l’application DÉMARRÉE a dit d’elle-même — absent sans --live.
• execution: Record<DoctorFamily, IExecution> — Ce que chaque famille a pu — ou n’a PAS pu — regarder.

IEntityDialectMismatch#

interface IEntityDialectMismatch

Une entité écrite pour d’autres moteurs que celui du connecteur.

• file: string — Le fichier de l’entité, relatif à la racine analysée.
• wrote: SqlDialectName[] — Les moteurs pour lesquels elle est écrite — aucun n’est le connecteur.

IEntityDialectScan#

interface IEntityDialectScan

Ce que le relevé des entités a trouvé.

• mismatches: IEntityDialectMismatch[]
• entitiesScanned: number — Entités relevées, tous dialectes confondus.

IManifestReader#

interface IManifestReader

De quoi lire une arborescence — le disque, ou ce qu’un scaffold s’apprête à écrire.

• exists(file: string): boolean — Le fichier existe-t-il (sur disque, ou en attente d’écriture) ?
• read(file: string): string — Son contenu.
• listDir(dir: string): { name: string; isDirectory: boolean; }[] — Les entrées d’un dossier.

IManifestSource#

interface IManifestSource

Un fichier du manifeste, et son texte.

• path: string — Chemin absolu — un écrivain doit savoir OÙ il a trouvé le motif.
• source: string — Le texte, tel qu’il est sur le disque.

Types (1)#

SqlDialectName#

type SqlDialectName = "sqlite" | "postgres" | "mysql"

Les moteurs qu’une entité peut viser.

← Toutes les références d’API