MARS TECH vite-debug-plugin

Exports par sous-chemins

SpécificateurCe qu'il fournit
@mars-tech/vite-debug-pluginLa fabrique du plugin (export par défaut) et les types publics MT*.
@mars-tech/vite-debug-plugin/helpersLes constantes DEFAULT_* et les types MT* principaux.
@mars-tech/vite-debug-plugin/eslintUne configuration plate ESLint qui déclare la globale $debug, et deux fonctions d'aide.
@mars-tech/vite-debug-plugin/testingLa configuration des tests : installe un $debug inerte, et exporte les fonctions qui installent le bouchon et le journaliseur console.
@mars-tech/vite-debug-plugin/testing/logUn module de configuration des tests qui installe le journaliseur console avec ses valeurs par défaut, pour une config sans le plugin.
@mars-tech/vite-debug-plugin/clientLa cible de la référence triple-slash pour le type de la globale $debug.
ts
import mtDebug from "@mars-tech/vite-debug-plugin";
import {
  DEFAULT_COLORS,
  type MTLevel,
} from "@mars-tech/vite-debug-plugin/helpers";

Le manifeste du paquet est aussi exporté (@mars-tech/vite-debug-plugin/package.json), pour les outils qui lisent le manifeste d'une dépendance à travers la table exports.

@mars-tech/vite-debug-plugin

Export par défaut uniquement : la fabrique du plugin. Les types publics MT* y sont aussi réexportés (import type { MTPluginOptions } from "@mars-tech/vite-debug-plugin"). Il est appelable depuis CommonJS : const mtDebug = require('@mars-tech/vite-debug-plugin') renvoie la fonction.

@mars-tech/vite-debug-plugin/helpers

L'emplacement de référence des constantes et des types principaux :

  • constantes : DEFAULT_COLORS, DEFAULT_PREFIX, DEFAULT_GLOBAL_NAME ;
  • types : MTLevel, MTCallOptions, MTPluginOptions, MTDebug, MTDebugFn, MTColorMap, MTColorEntry, MTColorOverrides, MTSourceLocation, MTLogRecord, MTLogLine.

MTInstallStubOptions et MTInstallConsoleOptions sont fournis par /testing, et MTGlobalAccess, MTEslintOptions et MTFlatConfig par /eslint. Voir Types exportés pour ce que décrit chaque type principal.

@mars-tech/vite-debug-plugin/eslint

L'export par défaut est une configuration plate ESLint qui déclare la globale $debug. Le module exporte aussi deux fonctions d'aide qui prennent le même objet d'options ({ globalName?, access? }) :

  • mtDebugFlatConfig(opts) : une configuration plate pour un globalName personnalisé ;
  • mtDebugGlobals(opts?) : une table globals, pour languageOptions.globals ou un ancien .eslintrc (ESLint 9 et antérieurs).

Voir Déclarer la globale à ESLint.

@mars-tech/vite-debug-plugin/testing

La configuration des tests : l'importer installe un $debug inerte. Le module exporte aussi installMtDebugStub(opts) et installMtDebugConsole(opts), le journaliseur console qui tient compte de la configuration et que test: 'log' installe, pour un fichier de configuration des tests écrit à la main. Voir Tests et Un journaliseur dans votre propre fichier de configuration des tests.

@mars-tech/vite-debug-plugin/testing/log

Un module de configuration des tests qui installe le vrai journaliseur console avec ses valeurs par défaut, pour une config sans le plugin (Jest, ou une config Vitest qui ne le charge pas). Placez-le en premier dans setupFiles. Pour passer des options comme prefix ou redact, appelez plutôt installMtDebugConsole depuis /testing.

Avec le plugin, test: 'log' enregistre un module de configuration des tests généré à partir de votre configuration : n'ajoutez pas celui-ci en plus. S'il est importé malgré tout, il laisse en place le journaliseur configuré. Voir Voir la sortie de $debug dans les tests.

@mars-tech/vite-debug-plugin/client

La cible de la référence triple-slash qui déclare le type de la globale $debug. Voir Activer le typage de la globale $debug.

Types exportés

TypeCe qu'il décrit
MTLevelL'un des six niveaux : 'error', 'warning', 'info', 'debug', 'success', 'trace'.
MTCallOptionsLes options d'appel : showStack, showSource, tag, prefix, inspect (et raw, son alias déprécié). Voir Signature d'appel.
MTPluginOptionsLes options de mtDebug(). Voir Options du plugin.
MTDebugLe $debug global : la fonction appelable et ses 14 méthodes. Utilisez-le pour déclarer un globalName personnalisé.
MTDebugFnLa fonction appelable seule, telle que la renvoie $debug.ns().
MTColorMap / MTColorEntry / MTColorOverridesLes couleurs des niveaux : la table complète, l'entrée d'un niveau { ansi, css, label }, et les surcharges partielles qu'accepte l'option colors.
MTSourceLocationL'endroit où un appel a été fait : { file, line, column }, le fichier relatif à la racine Vite, ligne et colonne comptées à partir de 1.
MTLogRecordUn appel tel que l'affiche le serveur de développement : level, message (rendu et masqué), et en option tag, source, stack et prefix.
MTLogLineUne ligne du fichier de log NDJSON : un MTLogRecord plus t (heure d'écriture ISO), seq (ordre dans la session) et origin ("browser" ou "server").