@oprt/cli 0.3.0 → 0.4.0

package/dist/index.d.cts

@@ -8,7 +8,7 @@ declare const VERSION: string;
  * structured result. It rises when a field is removed or changes meaning; adding a field does not
  * raise it. The envelope's `apiVersion` is the same number, kept for the readers that branch on it.
  */
-declare const RESULT_SCHEMA_VERSION = 1;
+declare const RESULT_SCHEMA_VERSION = 2;
 interface Identity {
     /** This program: the `@oprt/cli` package version. */
     cli_version: string;
@@ -33,32 +33,18 @@ interface ErrorIdentity {
 declare function contractDigest(contract: Contract): string;
 declare function identityOf(contract: Contract): Identity;
 
-/**
- * The `typescript` module as the project has it. It is opaque in the installer's own types, so
- * that using those types does not require TypeScript to be installed.
- */
-type TypeScript = object;
 /** Where the parser came from, for a person or an agent deciding whether to trust the answer. */
 interface ParserInfo {
-    name: "typescript";
+    name: "@babel/parser";
     version: string;
-    /**
-     * `project`: resolved from the directory being checked. `installer`: found beside this program
-     * instead, because the project has none of its own. `provided`: handed in by a caller of the
-     * library.
-     */
-    source: "project" | "installer" | "provided";
-}
-interface ParserResolution extends ParserInfo {
-    /** The folder of the `typescript` package that was loaded. */
-    resolved_from: string;
+    /** `bundled`: it ships inside oprt (dist/babel-parser.cjs), so there is nothing to install. */
+    source: "bundled";
 }
 /** Why checking cannot run, as a stable word. */
-type ParserBlock = "typescript_missing" | "typescript_unusable";
+type ParserBlock = "parser_missing" | "parser_unusable";
 type ParserProbe = {
     ready: true;
-    typescript: TypeScript;
-    resolution: ParserResolution;
+    parser: ParserInfo;
 } | {
     ready: false;
     reason: ParserBlock;
@@ -70,7 +56,7 @@ type ResultType = (typeof RESULT_TYPES)[number];
 /** The envelope every `--json` answer and every structured tool result comes in. */
 interface Envelope<T = unknown> {
     /** The result model's version (same number as `identity.schema_version`), for readers that branch on it. */
-    apiVersion: 1;
+    apiVersion: typeof RESULT_SCHEMA_VERSION;
     /** What `data` holds. */
     type: ResultType;
     identity: Identity;
@@ -78,7 +64,7 @@ interface Envelope<T = unknown> {
 }
 /** What a failure comes in. `code` is stable and only ever added to. */
 interface ErrorEnvelope {
-    apiVersion: 1;
+    apiVersion: typeof RESULT_SCHEMA_VERSION;
     error: string;
     code: string;
     suggestions?: string[];
@@ -129,7 +115,7 @@ declare function runAgentCommand(command: AgentCommand, context: {
     cwd: string;
     contract: Contract;
     registry: Registry;
-    /** For doctor: the TypeScript resolution to report, when the caller already has it. */
+    /** For doctor: the parser probe to report, when the caller already has it. */
     parser?: ParserProbe;
 }): Answer;
 
@@ -214,36 +200,36 @@ interface CheckReport {
     parser: ParserInfo;
 }
 /**
- * Check one file's source. `file` is only the name the findings carry. A file that does not parse
- * is not checked at all (`not_evaluated`, with the syntax errors as findings): what TypeScript
+ * Check one file's source. `file` is only the name the findings carry (and, by its extension, the
+ * dialect: `.tsx` is read as TypeScript, anything else as JavaScript). A file that does not parse
+ * is not checked at all (`not_evaluated`, with the syntax errors as findings): what a parser
  * recovers from broken code is a guess, and the contract is not judged on a guess.
  */
-declare function checkSource(typescript: TypeScript, contract: Contract, file: string, text: string): SourceEvaluation;
+declare function checkSource(contract: Contract, file: string, text: string): SourceEvaluation;
 /**
  * The report for a set of evaluated files. The status is `evaluated_clean` only when every file
  * was read in full and nothing was found; everything short of that has its own name.
  */
-declare function buildCheckReport(evaluations: readonly SourceEvaluation[], context: {
-    parser: ParserInfo;
+declare function buildCheckReport(evaluations: readonly SourceEvaluation[], context?: {
+    parser?: ParserInfo;
     skipped?: SkippedInput[];
 }): CheckReport;
 /**
  * The exit code of `oprt check`. 0: every file that was read has no errors (and, when strict, no
  * warnings); limits are shown and do not fail the run. 1: an error was found, a file did not
  * parse, or no file was read at all (nothing was checked, which is not a pass). Usage mistakes
- * and a path that is not there exit 2, and a missing TypeScript exits 1, before any report.
+ * and a path that is not there exit 2, and a parser that cannot be loaded exits 1, before any report.
  */
 declare function checkExitCode(report: CheckReport, { strict }: {
     strict: boolean;
 }): number;
 /**
- * Check every .tsx and .jsx file under the given paths. `typescript` is found in the project when
- * it is not passed; null stands for "there is none".
+ * Check every .tsx and .jsx file under the given paths, with the parser that ships inside oprt.
+ * Fails with a code when that parser cannot be loaded, rather than answering without it.
  */
 declare function checkPaths(paths: string[], context: {
     cwd: string;
     contract: Contract;
-    typescript?: TypeScript | null;
 }): CheckReport;
 /**
  * A check as text, for a terminal or a tool result. Findings first, then the limits, then one
@@ -259,8 +245,9 @@ interface DoctorCheck {
 }
 /**
  * Whether one thing oprt does can run here. Lookups (search, component, list) read the contract
- * that ships inside oprt, so they always can. Checking code needs a parser, which is the
- * project's own TypeScript: without it that operation is blocked, with the reason as a word.
+ * that ships inside oprt, so they always can. Checking code needs a parser, which also ships inside
+ * oprt (Babel's): it needs nothing from the project, and is blocked only if that file is missing
+ * or fails a probe, with the reason as a word.
  */
 interface DoctorOperations {
     lookup: {
@@ -273,8 +260,8 @@ interface DoctorOperations {
         message: string;
         reason?: ParserBlock;
         fix?: string;
-        /** The parser that checking will use, when it is ready. */
-        typescript?: Pick<ParserResolution, "version" | "resolved_from" | "source">;
+        /** The parser that checking reads code with, when it is ready. */
+        parser?: ParserInfo;
     };
 }
 interface DoctorReport {
@@ -292,7 +279,7 @@ interface DoctorReport {
 declare function doctor({ cwd, contract, parser, }: {
     cwd: string;
     contract: Contract;
-    /** What resolving TypeScript from `cwd` found. Resolved here when it is not passed. */
+    /** What probing the parser found. Probed here when it is not passed. */
     parser?: ParserProbe;
 }): DoctorReport;
 
@@ -317,9 +304,6 @@ interface PropertySchema {
 interface McpContext {
     contract: Contract;
     registry: Registry;
-    /** For check_code. Found beside the project or the installer when it is not passed. */
-    typescript?: TypeScript | null;
-    cwd?: string;
 }
 interface ToolDefinition {
     name: string;
@@ -377,4 +361,4 @@ declare function install(options: AddOptions, context?: {
     registry?: Registry;
 }): InstallResult;
 
-export { AddOptions, type Answer, type CheckReport, Command, ComponentDetail, type ComponentDetailData, Contract, DEFAULT_OUT, type DoctorCheck, type DoctorReport, type Envelope, type ErrorEnvelope, type ErrorIdentity, type EvaluationStatus, type Finding, type Identity, type InitFile, type InitOptions, type InitResult, InstallResult, type Limitation, type McpContext, RESULT_SCHEMAS, RESULT_SCHEMA_VERSION, RESULT_TYPES, Registry, RegistryEntry, type ResultType, type SkippedInput, type SourceEvaluation, TOOLS, type TypeScript, VERSION, buildCheckReport, checkExitCode, checkPaths, checkSource, contract, contractDigest, doctor, envelope, errorEnvelope, handleMessage, identityOf, init, install, outputSchemaFor, parseArgs, registry, renderCheckText, resolveEntries, runAgentCommand, schemaFor, serve };
+export { AddOptions, type Answer, type CheckReport, Command, ComponentDetail, type ComponentDetailData, Contract, DEFAULT_OUT, type DoctorCheck, type DoctorReport, type Envelope, type ErrorEnvelope, type ErrorIdentity, type EvaluationStatus, type Finding, type Identity, type InitFile, type InitOptions, type InitResult, InstallResult, type Limitation, type McpContext, type ParserInfo, RESULT_SCHEMAS, RESULT_SCHEMA_VERSION, RESULT_TYPES, Registry, RegistryEntry, type ResultType, type SkippedInput, type SourceEvaluation, TOOLS, VERSION, buildCheckReport, checkExitCode, checkPaths, checkSource, contract, contractDigest, doctor, envelope, errorEnvelope, handleMessage, identityOf, init, install, outputSchemaFor, parseArgs, registry, renderCheckText, resolveEntries, runAgentCommand, schemaFor, serve };

package/dist/index.d.ts

@@ -8,7 +8,7 @@ declare const VERSION: string;
  * structured result. It rises when a field is removed or changes meaning; adding a field does not
  * raise it. The envelope's `apiVersion` is the same number, kept for the readers that branch on it.
  */
-declare const RESULT_SCHEMA_VERSION = 1;
+declare const RESULT_SCHEMA_VERSION = 2;
 interface Identity {
     /** This program: the `@oprt/cli` package version. */
     cli_version: string;
@@ -33,32 +33,18 @@ interface ErrorIdentity {
 declare function contractDigest(contract: Contract): string;
 declare function identityOf(contract: Contract): Identity;
 
-/**
- * The `typescript` module as the project has it. It is opaque in the installer's own types, so
- * that using those types does not require TypeScript to be installed.
- */
-type TypeScript = object;
 /** Where the parser came from, for a person or an agent deciding whether to trust the answer. */
 interface ParserInfo {
-    name: "typescript";
+    name: "@babel/parser";
     version: string;
-    /**
-     * `project`: resolved from the directory being checked. `installer`: found beside this program
-     * instead, because the project has none of its own. `provided`: handed in by a caller of the
-     * library.
-     */
-    source: "project" | "installer" | "provided";
-}
-interface ParserResolution extends ParserInfo {
-    /** The folder of the `typescript` package that was loaded. */
-    resolved_from: string;
+    /** `bundled`: it ships inside oprt (dist/babel-parser.cjs), so there is nothing to install. */
+    source: "bundled";
 }
 /** Why checking cannot run, as a stable word. */
-type ParserBlock = "typescript_missing" | "typescript_unusable";
+type ParserBlock = "parser_missing" | "parser_unusable";
 type ParserProbe = {
     ready: true;
-    typescript: TypeScript;
-    resolution: ParserResolution;
+    parser: ParserInfo;
 } | {
     ready: false;
     reason: ParserBlock;
@@ -70,7 +56,7 @@ type ResultType = (typeof RESULT_TYPES)[number];
 /** The envelope every `--json` answer and every structured tool result comes in. */
 interface Envelope<T = unknown> {
     /** The result model's version (same number as `identity.schema_version`), for readers that branch on it. */
-    apiVersion: 1;
+    apiVersion: typeof RESULT_SCHEMA_VERSION;
     /** What `data` holds. */
     type: ResultType;
     identity: Identity;
@@ -78,7 +64,7 @@ interface Envelope<T = unknown> {
 }
 /** What a failure comes in. `code` is stable and only ever added to. */
 interface ErrorEnvelope {
-    apiVersion: 1;
+    apiVersion: typeof RESULT_SCHEMA_VERSION;
     error: string;
     code: string;
     suggestions?: string[];
@@ -129,7 +115,7 @@ declare function runAgentCommand(command: AgentCommand, context: {
     cwd: string;
     contract: Contract;
     registry: Registry;
-    /** For doctor: the TypeScript resolution to report, when the caller already has it. */
+    /** For doctor: the parser probe to report, when the caller already has it. */
     parser?: ParserProbe;
 }): Answer;
 
@@ -214,36 +200,36 @@ interface CheckReport {
     parser: ParserInfo;
 }
 /**
- * Check one file's source. `file` is only the name the findings carry. A file that does not parse
- * is not checked at all (`not_evaluated`, with the syntax errors as findings): what TypeScript
+ * Check one file's source. `file` is only the name the findings carry (and, by its extension, the
+ * dialect: `.tsx` is read as TypeScript, anything else as JavaScript). A file that does not parse
+ * is not checked at all (`not_evaluated`, with the syntax errors as findings): what a parser
  * recovers from broken code is a guess, and the contract is not judged on a guess.
  */
-declare function checkSource(typescript: TypeScript, contract: Contract, file: string, text: string): SourceEvaluation;
+declare function checkSource(contract: Contract, file: string, text: string): SourceEvaluation;
 /**
  * The report for a set of evaluated files. The status is `evaluated_clean` only when every file
  * was read in full and nothing was found; everything short of that has its own name.
  */
-declare function buildCheckReport(evaluations: readonly SourceEvaluation[], context: {
-    parser: ParserInfo;
+declare function buildCheckReport(evaluations: readonly SourceEvaluation[], context?: {
+    parser?: ParserInfo;
     skipped?: SkippedInput[];
 }): CheckReport;
 /**
  * The exit code of `oprt check`. 0: every file that was read has no errors (and, when strict, no
  * warnings); limits are shown and do not fail the run. 1: an error was found, a file did not
  * parse, or no file was read at all (nothing was checked, which is not a pass). Usage mistakes
- * and a path that is not there exit 2, and a missing TypeScript exits 1, before any report.
+ * and a path that is not there exit 2, and a parser that cannot be loaded exits 1, before any report.
  */
 declare function checkExitCode(report: CheckReport, { strict }: {
     strict: boolean;
 }): number;
 /**
- * Check every .tsx and .jsx file under the given paths. `typescript` is found in the project when
- * it is not passed; null stands for "there is none".
+ * Check every .tsx and .jsx file under the given paths, with the parser that ships inside oprt.
+ * Fails with a code when that parser cannot be loaded, rather than answering without it.
  */
 declare function checkPaths(paths: string[], context: {
     cwd: string;
     contract: Contract;
-    typescript?: TypeScript | null;
 }): CheckReport;
 /**
  * A check as text, for a terminal or a tool result. Findings first, then the limits, then one
@@ -259,8 +245,9 @@ interface DoctorCheck {
 }
 /**
  * Whether one thing oprt does can run here. Lookups (search, component, list) read the contract
- * that ships inside oprt, so they always can. Checking code needs a parser, which is the
- * project's own TypeScript: without it that operation is blocked, with the reason as a word.
+ * that ships inside oprt, so they always can. Checking code needs a parser, which also ships inside
+ * oprt (Babel's): it needs nothing from the project, and is blocked only if that file is missing
+ * or fails a probe, with the reason as a word.
  */
 interface DoctorOperations {
     lookup: {
@@ -273,8 +260,8 @@ interface DoctorOperations {
         message: string;
         reason?: ParserBlock;
         fix?: string;
-        /** The parser that checking will use, when it is ready. */
-        typescript?: Pick<ParserResolution, "version" | "resolved_from" | "source">;
+        /** The parser that checking reads code with, when it is ready. */
+        parser?: ParserInfo;
     };
 }
 interface DoctorReport {
@@ -292,7 +279,7 @@ interface DoctorReport {
 declare function doctor({ cwd, contract, parser, }: {
     cwd: string;
     contract: Contract;
-    /** What resolving TypeScript from `cwd` found. Resolved here when it is not passed. */
+    /** What probing the parser found. Probed here when it is not passed. */
     parser?: ParserProbe;
 }): DoctorReport;
 
@@ -317,9 +304,6 @@ interface PropertySchema {
 interface McpContext {
     contract: Contract;
     registry: Registry;
-    /** For check_code. Found beside the project or the installer when it is not passed. */
-    typescript?: TypeScript | null;
-    cwd?: string;
 }
 interface ToolDefinition {
     name: string;
@@ -377,4 +361,4 @@ declare function install(options: AddOptions, context?: {
     registry?: Registry;
 }): InstallResult;
 
-export { AddOptions, type Answer, type CheckReport, Command, ComponentDetail, type ComponentDetailData, Contract, DEFAULT_OUT, type DoctorCheck, type DoctorReport, type Envelope, type ErrorEnvelope, type ErrorIdentity, type EvaluationStatus, type Finding, type Identity, type InitFile, type InitOptions, type InitResult, InstallResult, type Limitation, type McpContext, RESULT_SCHEMAS, RESULT_SCHEMA_VERSION, RESULT_TYPES, Registry, RegistryEntry, type ResultType, type SkippedInput, type SourceEvaluation, TOOLS, type TypeScript, VERSION, buildCheckReport, checkExitCode, checkPaths, checkSource, contract, contractDigest, doctor, envelope, errorEnvelope, handleMessage, identityOf, init, install, outputSchemaFor, parseArgs, registry, renderCheckText, resolveEntries, runAgentCommand, schemaFor, serve };
+export { AddOptions, type Answer, type CheckReport, Command, ComponentDetail, type ComponentDetailData, Contract, DEFAULT_OUT, type DoctorCheck, type DoctorReport, type Envelope, type ErrorEnvelope, type ErrorIdentity, type EvaluationStatus, type Finding, type Identity, type InitFile, type InitOptions, type InitResult, InstallResult, type Limitation, type McpContext, type ParserInfo, RESULT_SCHEMAS, RESULT_SCHEMA_VERSION, RESULT_TYPES, Registry, RegistryEntry, type ResultType, type SkippedInput, type SourceEvaluation, TOOLS, VERSION, buildCheckReport, checkExitCode, checkPaths, checkSource, contract, contractDigest, doctor, envelope, errorEnvelope, handleMessage, identityOf, init, install, outputSchemaFor, parseArgs, registry, renderCheckText, resolveEntries, runAgentCommand, schemaFor, serve };