no-mistakes 0.32.0 → 0.33.0

package/README.md

@@ -42,6 +42,8 @@ const {
     root: process.cwd(),
     files: ["src/main.mts"],
     relationships: ["import"],
+    timeout: 30,
+    lockTimeout: 30,
   });
   const tests = await dependents({
     root: process.cwd(),
@@ -108,6 +110,13 @@ const {
 })();
 ```
 
+CLI and Node analyses share a per-user machine-wide lock. CLI flags
+`--timeout`, `--lock-timeout`, and `--fail-on-lock` have Node equivalents
+`timeout`, `lockTimeout`, and `failOnLock`. Both timeouts default to 30 seconds;
+`0` disables either CLI timeout, while `0` or `null` disables it in Node.
+Waiting does not alter successful output, and Node lock/timeout failures reject
+the returned Promise.
+
 External `no-mistakes-*` executables on `PATH` can be invoked as subcommands.
 For example, after installing `no-mistakes-scripts`:
 

package/index.d.ts

@@ -66,72 +66,135 @@ import type {
   TestsWhyOptions,
   TraverseOptions,
   WhyStep,
+  WithInvocationOptions,
 } from "./types";
 
 export * from "./types";
 
-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: SymbolsSignatureImpactOptions): Promise<SignatureImpactResult>;
-export function symbols(options: SymbolsListOptions): Promise<SymbolsResult>;
-export function symbols(options: SymbolsOptions): Promise<SymbolsResult | SignatureImpactResult>;
-export function importUsages(options?: ImportUsagesOptions): Promise<ImportUsagesResult>;
-export function importers(options: ImportersOptions): Promise<ImportersResult>;
-export function exportsOf(options: ExportsOfOptions): Promise<ExportsOfResult>;
-export function deadExports(options: DeadExportsOptions): Promise<DeadExportsResult>;
-export function callSites(options: CallSitesOptions): Promise<CallSitesResult>;
-export function resolveCheck(options: ResolveCheckOptions): Promise<ResolveCheckResult>;
-export function fetches(options?: FetchesOptions): Promise<unknown>;
-export function flow(options: FlowOptions): Promise<FlowReport>;
-export function check(options?: ProjectOptions): Promise<CheckReport>;
-export function testsPlan(options: TestsPlanOptions): Promise<TestPlan>;
-export function testsImpact(options: TestsImpactOptions): Promise<TestPlan>;
-export function testsTargets(options: TestsTargetsOptions): Promise<TestsTargetsReport>;
-export function testsWhy(options: TestsWhyOptions): Promise<Record<string, WhyStep[]>>;
-export function testsComment(options: TestsPlanDocumentOptions): Promise<string>;
-export function testsGraph(options: TestsPlanDocumentOptions): Promise<TestGraph>;
-export function testsGraphMermaid(options: TestsPlanDocumentOptions): Promise<string>;
-export function playwrightCheck(options?: PlaywrightOptions): Promise<unknown>;
-export function playwrightEdges(options?: PlaywrightOptions): Promise<unknown>;
-export function playwrightRelated(options: PlaywrightRelatedOptions): Promise<unknown>;
-export function playwrightTests(options?: PlaywrightOptions): Promise<unknown>;
-export function queues(options?: ProjectOptions): Promise<QueueReport>;
-export function queueEdges(options?: ProjectOptions): Promise<GraphEdge[]>;
-export function queueRelated(options: ProjectOptions): Promise<GraphEdge[]>;
-export function queueCheck(options?: ProjectOptions): Promise<unknown[]>;
-export function serverRoutes(options?: ProjectOptions): Promise<ServerRoutesReport>;
-export function serverRouteList(options?: ProjectOptions): Promise<unknown[]>;
-export function serverRouteEdges(options?: ProjectOptions): Promise<GraphEdge[]>;
-export function serverRouteRelated(options: ProjectOptions): Promise<GraphEdge[]>;
-export function serverContracts(options?: ProjectOptions): Promise<ServerContractsReport>;
-export function reactAnalyze(options?: ProjectOptions): Promise<ReactComponentFacts[]>;
-export function reactCheck(options?: ProjectOptions): Promise<ReactViolation[]>;
+export function dependencies(
+  options: WithInvocationOptions<TraverseOptions>,
+): Promise<DependencyResult>;
+export function dependents(
+  options: WithInvocationOptions<TraverseOptions>,
+): Promise<DependencyResult>;
+export function related(options: WithInvocationOptions<TraverseOptions>): Promise<DependencyResult>;
+export function analyzeProject(
+  options: WithInvocationOptions<AnalyzeProjectOptions>,
+): Promise<AnalyzeProjectResult>;
+export function symbols(
+  options: WithInvocationOptions<SymbolsSignatureImpactOptions>,
+): Promise<SignatureImpactResult>;
+export function symbols(options: WithInvocationOptions<SymbolsListOptions>): Promise<SymbolsResult>;
+export function symbols(
+  options: WithInvocationOptions<SymbolsOptions>,
+): Promise<SymbolsResult | SignatureImpactResult>;
+export function importUsages(
+  options?: WithInvocationOptions<ImportUsagesOptions>,
+): Promise<ImportUsagesResult>;
+export function importers(
+  options: WithInvocationOptions<ImportersOptions>,
+): Promise<ImportersResult>;
+export function exportsOf(
+  options: WithInvocationOptions<ExportsOfOptions>,
+): Promise<ExportsOfResult>;
+export function deadExports(
+  options: WithInvocationOptions<DeadExportsOptions>,
+): Promise<DeadExportsResult>;
+export function callSites(
+  options: WithInvocationOptions<CallSitesOptions>,
+): Promise<CallSitesResult>;
+export function resolveCheck(
+  options: WithInvocationOptions<ResolveCheckOptions>,
+): Promise<ResolveCheckResult>;
+export function fetches(options?: WithInvocationOptions<FetchesOptions>): Promise<unknown>;
+export function flow(options: WithInvocationOptions<FlowOptions>): Promise<FlowReport>;
+export function check(options?: WithInvocationOptions<ProjectOptions>): Promise<CheckReport>;
+export function testsPlan(options: WithInvocationOptions<TestsPlanOptions>): Promise<TestPlan>;
+export function testsImpact(options: WithInvocationOptions<TestsImpactOptions>): Promise<TestPlan>;
+export function testsTargets(
+  options: WithInvocationOptions<TestsTargetsOptions>,
+): Promise<TestsTargetsReport>;
+export function testsWhy(
+  options: WithInvocationOptions<TestsWhyOptions>,
+): Promise<Record<string, WhyStep[]>>;
+export function testsComment(
+  options: WithInvocationOptions<TestsPlanDocumentOptions>,
+): Promise<string>;
+export function testsGraph(
+  options: WithInvocationOptions<TestsPlanDocumentOptions>,
+): Promise<TestGraph>;
+export function testsGraphMermaid(
+  options: WithInvocationOptions<TestsPlanDocumentOptions>,
+): Promise<string>;
+export function playwrightCheck(
+  options?: WithInvocationOptions<PlaywrightOptions>,
+): Promise<unknown>;
+export function playwrightEdges(
+  options?: WithInvocationOptions<PlaywrightOptions>,
+): Promise<unknown>;
+export function playwrightRelated(
+  options: WithInvocationOptions<PlaywrightRelatedOptions>,
+): Promise<unknown>;
+export function playwrightTests(
+  options?: WithInvocationOptions<PlaywrightOptions>,
+): Promise<unknown>;
+export function queues(options?: WithInvocationOptions<ProjectOptions>): Promise<QueueReport>;
+export function queueEdges(options?: WithInvocationOptions<ProjectOptions>): Promise<GraphEdge[]>;
+export function queueRelated(options: WithInvocationOptions<ProjectOptions>): Promise<GraphEdge[]>;
+export function queueCheck(options?: WithInvocationOptions<ProjectOptions>): Promise<unknown[]>;
+export function serverRoutes(
+  options?: WithInvocationOptions<ProjectOptions>,
+): Promise<ServerRoutesReport>;
+export function serverRouteList(
+  options?: WithInvocationOptions<ProjectOptions>,
+): Promise<unknown[]>;
+export function serverRouteEdges(
+  options?: WithInvocationOptions<ProjectOptions>,
+): Promise<GraphEdge[]>;
+export function serverRouteRelated(
+  options: WithInvocationOptions<ProjectOptions>,
+): Promise<GraphEdge[]>;
+export function serverContracts(
+  options?: WithInvocationOptions<ProjectOptions>,
+): Promise<ServerContractsReport>;
+export function reactAnalyze(
+  options?: WithInvocationOptions<ProjectOptions>,
+): Promise<ReactComponentFacts[]>;
+export function reactCheck(
+  options?: WithInvocationOptions<ProjectOptions>,
+): Promise<ReactViolation[]>;
 export function reactUsages(
-  options: ProjectOptions & { target: string },
+  options: WithInvocationOptions<ProjectOptions & { target: string }>,
 ): Promise<ReactUsagesReport>;
-export function lockfileDiff(options: LockfileDiffOptions): Promise<LockfileDiffEntry[]>;
-export function ciImpact(options: CiImpactOptions): Promise<CiImpactReport>;
-export function ciEnv(options: CiEnvOptions): Promise<CiEnvReport>;
-export function impactedChecks(options: ImpactedChecksOptions): Promise<ImpactedChecksReport>;
-export function dataPw(options: DataPwOptions): Promise<DataPwReport>;
-export function effects(options: EffectsOptions): Promise<EffectsReport>;
-export function rscCallers(options: RscCallersOptions): Promise<RscCallersReport>;
+export function lockfileDiff(
+  options: WithInvocationOptions<LockfileDiffOptions>,
+): Promise<LockfileDiffEntry[]>;
+export function ciImpact(options: WithInvocationOptions<CiImpactOptions>): Promise<CiImpactReport>;
+export function ciEnv(options: WithInvocationOptions<CiEnvOptions>): Promise<CiEnvReport>;
+export function impactedChecks(
+  options: WithInvocationOptions<ImpactedChecksOptions>,
+): Promise<ImpactedChecksReport>;
+export function dataPw(options: WithInvocationOptions<DataPwOptions>): Promise<DataPwReport>;
+export function effects(options: WithInvocationOptions<EffectsOptions>): Promise<EffectsReport>;
+export function rscCallers(
+  options: WithInvocationOptions<RscCallersOptions>,
+): Promise<RscCallersReport>;
 export function registryExtension(
-  options: RegistryExtensionOptions,
+  options: WithInvocationOptions<RegistryExtensionOptions>,
 ): Promise<RegistryExtensionReport>;
 export function infraResourceRefs(
-  options: InfraOptions & { address: string },
+  options: WithInvocationOptions<InfraOptions & { address: string }>,
 ): Promise<ResourceRefRow[]>;
 export function infraOutputs(
-  options: InfraOptions & { moduleDir: string },
+  options: WithInvocationOptions<InfraOptions & { moduleDir: string }>,
 ): Promise<ModuleOutputsResult>;
-export function infraTestFor(options: InfraOptions & { tfFile: string }): Promise<TestForRow[]>;
+export function infraTestFor(
+  options: WithInvocationOptions<InfraOptions & { tfFile: string }>,
+): Promise<TestForRow[]>;
 export function swiftImporters(
-  options: SwiftOptions & { file: string },
+  options: WithInvocationOptions<SwiftOptions & { file: string }>,
 ): Promise<SwiftImporterRow[]>;
 export function swiftTestTargets(
-  options: SwiftOptions & { file: string },
+  options: WithInvocationOptions<SwiftOptions & { file: string }>,
 ): Promise<SwiftTestTargetRow[]>;
 export function version(): Promise<string>;

package/invocation-types.d.ts

@@ -0,0 +1,11 @@
+/** Controls shared by every analysis invocation. Durations are in seconds. */
+export interface InvocationOptions {
+  /** Command execution timeout. Defaults to 30; 0 or null disables it. */
+  timeout?: number | null;
+  /** Maximum time to wait for the machine-wide lock. Defaults to 30; 0 or null waits indefinitely. */
+  lockTimeout?: number | null;
+  /** Fail immediately instead of waiting when another invocation holds the lock. */
+  failOnLock?: boolean;
+}
+
+export type WithInvocationOptions<T> = T & InvocationOptions;

package/package.json

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

package/types.d.ts

@@ -1,3 +1,4 @@
+export * from "./invocation-types";
 export * from "./traversal-types";
 export * from "./analyze-project-types";
 export * from "./flow-types";