nestjs-doctor 0.4.18 → 0.4.20

package/README.md

@@ -169,10 +169,22 @@ Also works as a `"nestjs-doctor"` key in `package.json`.
 | `minScore` | `number` | Minimum passing score (0-100). Exits with code 1 if below threshold |
 | `ignore.rules` | `string[]` | Rule IDs to suppress |
 | `ignore.files` | `string[]` | Glob patterns for files whose diagnostics are hidden |
-| `rules` | `Record<string, boolean>` | Enable/disable individual rules |
+| `rules` | `Record<string, RuleOverride \| boolean>` | Enable/disable individual rules, override severity, and pass rule-specific options |
 | `categories` | `Record<string, boolean>` | Enable/disable entire categories |
 | `customRulesDir` | `string` | Path to a directory containing custom rule files |
 
+Example rule-specific override:
+
+```json
+{
+  "rules": {
+    "architecture/no-manual-instantiation": {
+      "excludeClasses": ["Logger", "PinoLogger"]
+    }
+  }
+}
+```
+
 ---
 
 ## Custom Rules
@@ -203,7 +215,7 @@ export const noTodoComments = {
       const pos = context.sourceFile.getLineAndColumnAtPos(match.index);
       context.report({
         message: "Unresolved TODO comment",
-        file: context.filePath,
+        filePath: context.filePath,
         line: pos.line,
       });
     }
@@ -321,7 +333,7 @@ mono.combined;      // Merged DiagnoseResult
 
 | Rule | Severity | What it catches |
 |------|----------|-----------------|
-| `no-missing-injectable` | error | Provider in module missing `@Injectable()` |
+| `no-missing-injectable` | error | Provider with constructor deps missing `@Injectable()` |
 | `no-duplicate-routes` | error | Same method + path + version twice in a controller |
 | `no-missing-guard-method` | error | Guard class missing `canActivate()` |
 | `no-missing-pipe-method` | error | Pipe class missing `transform()` |
@@ -370,4 +382,3 @@ mono.combined;      // Merged DiagnoseResult
 | `schema/require-primary-key` | error | Entity without a primary key column |
 | `schema/require-timestamps` | warning | Entity missing createdAt/updatedAt columns |
 | `schema/require-cascade-rule` | info | Relation missing explicit onDelete behavior |
-

package/dist/api/index.d.mts

@@ -1,64 +1,10 @@
 import { ClassDeclaration, Project, SourceFile } from "ts-morph";
 
-//#region src/engine/type-resolver.d.ts
-interface ProviderInfo {
-  classDeclaration: ClassDeclaration;
-  dependencies: string[];
-  filePath: string;
-  name: string;
-  publicMethodCount: number;
-}
-declare function updateProvidersForFile(providers: Map<string, ProviderInfo>, project: Project, filePath: string): void;
-//#endregion
-//#region src/engine/module-graph.d.ts
-interface ModuleNode {
-  classDeclaration: ClassDeclaration;
-  controllers: string[];
-  exports: string[];
-  filePath: string;
-  imports: string[];
-  name: string;
-  providers: string[];
-}
-interface ModuleGraph {
-  edges: Map<string, Set<string>>;
-  modules: Map<string, ModuleNode>;
-  providerToModule: Map<string, ModuleNode>;
-}
-declare function updateModuleGraphForFile(graph: ModuleGraph, project: Project, filePath: string): void;
-//#endregion
-//#region src/types/diagnostic.d.ts
-type Severity = "error" | "warning" | "info";
-type Category = "security" | "performance" | "correctness" | "architecture" | "schema";
-interface SourceLine {
-  line: number;
-  text: string;
-}
-interface BaseDiagnostic {
-  category: Category;
-  filePath: string;
-  help: string;
-  message: string;
-  rule: string;
-  scope?: RuleScope;
-  severity: Severity;
-}
-interface CodeDiagnostic extends BaseDiagnostic {
-  column: number;
-  line: number;
-  sourceLines?: SourceLine[];
-}
-interface SchemaDiagnostic extends BaseDiagnostic {
-  entity: string;
-  schemaColumn?: string;
-}
-type Diagnostic = CodeDiagnostic | SchemaDiagnostic;
-declare function isCodeDiagnostic(d: Diagnostic): d is CodeDiagnostic;
-declare function isSchemaDiagnostic(d: Diagnostic): d is SchemaDiagnostic;
-//#endregion
-//#region src/types/config.d.ts
+//#region src/common/config.d.ts
 interface RuleOverride {
   enabled?: boolean;
+  excludeClasses?: string[];
+  options?: Record<string, unknown>;
   severity?: Severity;
 }
 interface NestjsDoctorIgnoreConfig {
@@ -75,7 +21,7 @@ interface NestjsDoctorConfig {
   rules?: Record<string, RuleOverride | boolean>;
 }
 //#endregion
-//#region src/types/schema.d.ts
+//#region src/common/schema.d.ts
 interface SchemaColumn {
   defaultValue?: string;
   hasIndex?: boolean;
@@ -135,7 +81,34 @@ interface SerializedSchemaEntity {
   tableName: string;
 }
 //#endregion
-//#region src/rules/types.d.ts
+//#region src/engine/graph/type-resolver.d.ts
+interface ProviderInfo {
+  classDeclaration: ClassDeclaration;
+  dependencies: string[];
+  filePath: string;
+  name: string;
+  publicMethodCount: number;
+}
+declare function updateProvidersForFile(providers: Map<string, ProviderInfo>, project: Project, filePath: string): void;
+//#endregion
+//#region src/engine/graph/module-graph.d.ts
+interface ModuleNode {
+  classDeclaration: ClassDeclaration;
+  controllers: string[];
+  exports: string[];
+  filePath: string;
+  imports: string[];
+  name: string;
+  providers: string[];
+}
+interface ModuleGraph {
+  edges: Map<string, Set<string>>;
+  modules: Map<string, ModuleNode>;
+  providerToModule: Map<string, ModuleNode>;
+}
+declare function updateModuleGraphForFile(graph: ModuleGraph, project: Project, filePath: string): void;
+//#endregion
+//#region src/engine/rules/types.d.ts
 type RuleScope = "file" | "project" | "schema";
 interface RuleMeta {
   category: Category;
@@ -146,6 +119,7 @@ interface RuleMeta {
   severity: Severity;
 }
 interface CodeRuleContext {
+  config?: NestjsDoctorConfig;
   filePath: string;
   report(diagnostic: Omit<CodeDiagnostic, "rule" | "category" | "severity" | "scope">): void;
   sourceFile: SourceFile;
@@ -177,7 +151,36 @@ interface SchemaRule {
 }
 type AnyRule = Rule | ProjectRule | SchemaRule;
 //#endregion
-//#region src/types/result.d.ts
+//#region src/common/diagnostic.d.ts
+type Severity = "error" | "warning" | "info";
+type Category = "security" | "performance" | "correctness" | "architecture" | "schema";
+interface SourceLine {
+  line: number;
+  text: string;
+}
+interface BaseDiagnostic {
+  category: Category;
+  filePath: string;
+  help: string;
+  message: string;
+  rule: string;
+  scope?: RuleScope;
+  severity: Severity;
+}
+interface CodeDiagnostic extends BaseDiagnostic {
+  column: number;
+  line: number;
+  sourceLines?: SourceLine[];
+}
+interface SchemaDiagnostic extends BaseDiagnostic {
+  entity: string;
+  schemaColumn?: string;
+}
+type Diagnostic = CodeDiagnostic | SchemaDiagnostic;
+declare function isCodeDiagnostic(d: Diagnostic): d is CodeDiagnostic;
+declare function isSchemaDiagnostic(d: Diagnostic): d is SchemaDiagnostic;
+//#endregion
+//#region src/common/result.d.ts
 interface Score {
   label: string;
   value: number;
@@ -221,59 +224,116 @@ interface MonorepoResult {
   subProjects: SubProjectResult[];
 }
 //#endregion
-//#region src/core/scanner.d.ts
-interface ScanOptions {
-  config?: string;
+//#region src/common/errors.d.ts
+declare class NestjsDoctorError extends Error {
+  constructor(message: string);
+}
+declare class ConfigurationError extends NestjsDoctorError {
+  constructor(message: string);
+}
+declare class ScanError extends NestjsDoctorError {
+  constructor(message: string);
+}
+declare class ValidationError extends NestjsDoctorError {
+  constructor(message: string);
+}
+//#endregion
+//#region src/engine/rules/index.d.ts
+declare function getRules(): AnyRule[];
+//#endregion
+//#region src/engine/config/scan-config.d.ts
+interface ScanConfig {
+  combinedRules: AnyRule[];
+  config: NestjsDoctorConfig;
+  customRuleWarnings: string[];
+  fileRules: Rule[];
+  projectRules: ProjectRule[];
+  schemaRules: SchemaRule[];
+}
+declare function resolveScanConfig(targetPath: string, configPath?: string): Promise<ScanConfig>;
+//#endregion
+//#region src/engine/project-detector.d.ts
+interface MonorepoInfo {
+  projects: Map<string, string>;
 }
-interface ScanContext {
+//#endregion
+//#region src/engine/analysis-context.d.ts
+interface AnalysisContext {
   astProject: Project;
   config: NestjsDoctorConfig;
   fileRules: Rule[];
   files: string[];
   moduleGraph: ModuleGraph;
+  project: ProjectInfo;
   projectRules: ProjectRule[];
   providers: Map<string, ProviderInfo>;
   schemaGraph?: SchemaGraph;
   schemaRules: SchemaRule[];
   targetPath: string;
 }
-declare function prepareScan(targetPath: string, options?: ScanOptions): Promise<{
-  context: ScanContext;
+declare function buildAnalysisContext(targetPath: string, scanConfig: ScanConfig): Promise<AnalysisContext>;
+declare function prepareAnalysis(targetPath: string, options?: {
+  config?: string;
+}): Promise<{
+  context: AnalysisContext;
   customRuleWarnings: string[];
 }>;
-declare function updateFile(context: ScanContext, filePath: string): void;
-declare function scanFile(context: ScanContext, filePath: string): {
+declare function updateFile(context: AnalysisContext, filePath: string): void;
+//#endregion
+//#region src/engine/diagnostician.d.ts
+interface RawDiagnosticOutput {
+  diagnostics: Diagnostic[];
+  elapsedMs: number;
+  ruleErrors: RuleErrorInfo[];
+}
+declare function checkFile(context: AnalysisContext, filePath: string): {
   diagnostics: Diagnostic[];
   errors: RuleErrorInfo[];
 };
-declare function scanAllFiles(context: ScanContext): {
+declare function checkAllFiles(context: AnalysisContext): {
   diagnostics: Diagnostic[];
   errors: RuleErrorInfo[];
 };
-declare function scanProject(context: ScanContext): {
+declare function checkProject(context: AnalysisContext): {
+  diagnostics: Diagnostic[];
+  errors: RuleErrorInfo[];
+};
+declare function checkSchema(context: AnalysisContext): {
   diagnostics: Diagnostic[];
   errors: RuleErrorInfo[];
 };
 //#endregion
-//#region src/engine/schema/extract.d.ts
-declare function extractSchema(project: Project, files: string[], orm: string | null, targetPath: string): SchemaGraph;
-//#endregion
-//#region src/rules/index.d.ts
-declare function getRules(): AnyRule[];
-//#endregion
-//#region src/types/errors.d.ts
-declare class NestjsDoctorError extends Error {
-  constructor(message: string);
-}
-declare class ConfigurationError extends NestjsDoctorError {
-  constructor(message: string);
-}
-declare class ScanError extends NestjsDoctorError {
-  constructor(message: string);
+//#region src/engine/result-builder.d.ts
+interface EngineResult {
+  customRuleWarnings: string[];
+  files: string[];
+  moduleGraph: ModuleGraph;
+  providers: Map<string, ProviderInfo>;
+  result: DiagnoseResult;
+  schemaGraph: SchemaGraph;
 }
-declare class ValidationError extends NestjsDoctorError {
-  constructor(message: string);
+interface MonorepoEngineResult {
+  customRuleWarnings: string[];
+  moduleGraphs: Map<string, ModuleGraph>;
+  result: MonorepoResult;
 }
+declare function buildResult(context: AnalysisContext, rawOutput: RawDiagnosticOutput, customRuleWarnings?: string[]): EngineResult;
+//#endregion
+//#region src/engine/scanner.d.ts
+type AutoScanResult = {
+  isMonorepo: true;
+  monorepo: MonorepoEngineResult;
+} | {
+  isMonorepo: false;
+  single: EngineResult;
+};
+declare function autoScan(targetPath: string, options?: {
+  config?: string;
+  monorepo?: MonorepoInfo;
+}): Promise<AutoScanResult>;
+//#endregion
+//#region src/engine/schema/extract.d.ts
+declare function extractSchema(project: Project, files: string[], orm: string | null, targetPath: string): SchemaGraph;
 //#endregion
 //#region src/api/index.d.ts
 /**
@@ -302,5 +362,4 @@ declare function diagnoseMonorepo(path: string, options?: {
   config?: string;
 }): Promise<MonorepoResult>;
 //#endregion
-export { type AnyRule, type BaseDiagnostic, type Category, type CodeDiagnostic, type CodeRuleContext, type CodeRuleContext as RuleContext, ConfigurationError, type DiagnoseResult, type DiagnoseSummary, type Diagnostic, type MonorepoResult, type NestjsDoctorConfig, NestjsDoctorError, type ProjectInfo, type ProjectRule, type ProjectRuleContext, type Rule, type RuleErrorInfo, type RuleMeta, type ScanContext, ScanError, type SchemaColumn, type SchemaDiagnostic, type SchemaEntity, type SchemaGraph, type SchemaRelation, type SchemaRule, type SchemaRuleContext, type Score, type SerializedSchemaGraph, type Severity, type SubProjectResult, ValidationError, diagnose, diagnoseMonorepo, extractSchema, getRules, isCodeDiagnostic, isSchemaDiagnostic, prepareScan, scanAllFiles, scanFile, scanProject, updateFile, updateModuleGraphForFile, updateProvidersForFile };
-//# sourceMappingURL=index.d.mts.map
+export { type AnalysisContext, type AnyRule, type AutoScanResult, type BaseDiagnostic, type Category, type CodeDiagnostic, type CodeRuleContext, type CodeRuleContext as RuleContext, ConfigurationError, type DiagnoseResult, type DiagnoseSummary, type Diagnostic, type MonorepoResult, type NestjsDoctorConfig, NestjsDoctorError, type ProjectInfo, type ProjectRule, type ProjectRuleContext, type RawDiagnosticOutput, type Rule, type RuleErrorInfo, type RuleMeta, type ScanConfig, ScanError, type SchemaColumn, type SchemaDiagnostic, type SchemaEntity, type SchemaGraph, type SchemaRelation, type SchemaRule, type SchemaRuleContext, type Score, type SerializedSchemaGraph, type Severity, type SubProjectResult, ValidationError, autoScan, buildAnalysisContext, buildResult, checkAllFiles, checkFile, checkProject, checkSchema, diagnose, diagnoseMonorepo, extractSchema, getRules, isCodeDiagnostic, isSchemaDiagnostic, prepareAnalysis, resolveScanConfig, updateFile, updateModuleGraphForFile, updateProvidersForFile };