no-mistakes 0.20.1 → 0.22.0

package/README.md

@@ -48,6 +48,12 @@ const {
     files: ["src/utils.mts"],
     include: "both",
   });
+  const signatureImpact = await symbols({
+    root: process.cwd(),
+    files: ["src/utils.mts"],
+    mode: "signature-impact",
+    symbol: "parseDate",
+  });
   const plan = await testsPlan({
     root: process.cwd(),
     framework: "vitest",

package/index.d.ts

@@ -15,8 +15,11 @@ import type {
   ReactUsagesReport,
   ReactViolation,
   ServerRoutesReport,
+  SignatureImpactResult,
+  SymbolsListOptions,
   SymbolsOptions,
   SymbolsResult,
+  SymbolsSignatureImpactOptions,
   TestGraph,
   TestPlan,
   TestsImpactOptions,
@@ -33,7 +36,9 @@ export function dependencies(options: TraverseOptions): Promise<DependencyResult
 export function dependents(options: TraverseOptions): Promise<DependencyResult>;
 export function related(options: TraverseOptions): Promise<DependencyResult>;
 export function analyzeProject(options: AnalyzeProjectOptions): Promise<AnalyzeProjectResult>;
-export function symbols(options: SymbolsOptions): Promise<SymbolsResult>;
+export function symbols(options: SymbolsSignatureImpactOptions): Promise<SignatureImpactResult>;
+export function symbols(options: SymbolsListOptions): Promise<SymbolsResult>;
+export function symbols(options: SymbolsOptions): Promise<SymbolsResult | SignatureImpactResult>;
 export function fetches(options?: FetchesOptions): Promise<unknown>;
 export function check(options?: ProjectOptions): Promise<CheckReport>;
 export function testsPlan(options: TestsPlanOptions): Promise<TestPlan>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "no-mistakes",
-  "version": "0.20.1",
+  "version": "0.22.0",
   "description": "Static codebase analysis tools for TS/JS dependencies, dependents, and symbols",
   "license": "MIT",
   "repository": {

package/traversal-types.d.ts

@@ -68,10 +68,23 @@ export interface SymbolsOptions {
   files: string[];
   root?: string;
   tsconfig?: string;
+  config?: string;
+  mode?: "list" | "signature-impact";
+  symbol?: string;
   kinds?: ExportKind[];
   include?: "exports" | "imports" | "both";
 }
 
+export type SymbolsListOptions = Omit<SymbolsOptions, "mode" | "symbol"> & {
+  mode?: "list";
+  symbol?: string;
+};
+
+export type SymbolsSignatureImpactOptions = SymbolsOptions & {
+  mode: "signature-impact";
+  symbol: string;
+};
+
 export interface SymbolExport {
   name: string;
   kind: string;
@@ -103,6 +116,42 @@ export interface SymbolsResult {
   files: SymbolFile[];
 }
 
+export interface SignatureImpactLocation {
+  file: string;
+  symbol: string;
+  line: number;
+  kind: string;
+}
+
+export interface SignatureImpactCaller {
+  file: string;
+  symbol?: string;
+  depth: number;
+  via: string[];
+}
+
+export interface SignatureImpactTest {
+  file: string;
+  depth: number;
+  via: string[];
+}
+
+export interface SignatureImpactWarning {
+  type: string;
+  message: string;
+}
+
+export interface SignatureImpactResult {
+  roots: string[];
+  symbol: string;
+  definition: SignatureImpactLocation;
+  exports: SignatureImpactLocation[];
+  productionCallers: SignatureImpactCaller[];
+  testCallers: SignatureImpactCaller[];
+  suggestedTests: SignatureImpactTest[];
+  warnings: SignatureImpactWarning[];
+}
+
 export interface ProjectOptions {
   root?: string;
   tsconfig?: string;
@@ -136,7 +185,7 @@ export type AnalyzeProjectReportRequest =
       TraverseOptions,
       "root" | "tsconfig"
     >)
-  | ({ type: "symbols"; id?: string } & SymbolsOptions)
+  | ({ type: "symbols"; id?: string } & (SymbolsListOptions | SymbolsSignatureImpactOptions))
   | ({ type: "queues" | "queueEdges" | "queueCheck"; id?: string } & BatchedProjectOptions)
   | ({ type: "queueRelated"; id?: string } & BatchedQueueRelatedOptions)
   | ({