@microtronics/studio-cli 1.2.0 → 1.3.0-alpha.0

package/dist/studio-cli.d.ts

@@ -2002,7 +2002,7 @@ export declare namespace Dependencies {
         partInstalls: string[];
     };
     /**
-     * Normalize the `dist/blo` and `dist/pov/details` `package.json` files of every already-installed library
+     * Normalize the `dist/blo`, `dist/pov/details` and `dist/dlo` `package.json` files of every already-installed library
      * reachable from the consumer's `libraryDependencies`/`libraryDevDependencies` (version stamping and
      * stripping of npm-invalid Studio-library dependency entries), walking each library's own
      * `libraryDependencies`/`libraryDevDependencies` transitively.
@@ -2024,7 +2024,7 @@ export declare namespace Dependencies {
      */
     export function validateMinimumBackendVersion(cwd: URI, fs: LocalFS, logger: Log.Logger): Promise<void>;
     /**
-     * Install npm dependencies in pov and blo working paths if they exist and contain a package.json.
+     * Install npm dependencies in pov, blo and dlo working paths if they exist and contain a package.json.
      * This ensures that a single `studio install` command sets up the entire project.
      * If the root package.json declares npm workspaces that cover a part, the install is done once at the
      * project root using `npm install` instead of separately for each covered part; parts not covered by a
@@ -2043,11 +2043,13 @@ export declare namespace Dependencies {
      * @param cwd
      * @param fs
      * @param apmPart currently only dlo and dfiles are supported
+     * @param production - set to true to exclude libraryDevDependencies, e.g. dlo-test - a dev-only
+     * library must never be force-included into the shipped app (see getAll)
      */
-    export function getApmPartDependencies(cwd: URI, fs: LocalFS, apmPart: APM.Part.dlo | APM.Part.dfiles): Promise<APMPartLibrary[]>;
+    export function getApmPartDependencies(cwd: URI, fs: LocalFS, apmPart: APM.Part.dlo | APM.Part.dfiles, production?: boolean): Promise<APMPartLibrary[]>;
     /**
-     * Link a library's blo/pov exports into the consuming project's part package.json files.
-     * After a library is extracted, check if it exports blo or pov parts and add `file:` references.
+     * Link a library's blo/pov/dlo exports into the consuming project's part package.json files.
+     * After a library is extracted, check if it exports blo, pov or dlo parts and add `file:` references.
      * @param cwd
      * @param fs
      * @param logger
@@ -2056,7 +2058,7 @@ export declare namespace Dependencies {
      */
     export function linkLibraryApmParts(cwd: URI, fs: LocalFS, logger: Log.Logger, libraryName: string, development?: boolean): Promise<void>;
     /**
-     * Unlink a library's blo/pov exports from the consuming project's part package.json files.
+     * Unlink a library's blo/pov/dlo exports from the consuming project's part package.json files.
      * Removes `file:` references that were added by linkLibraryApmParts.
      * @param cwd
      * @param fs
@@ -2553,12 +2555,27 @@ export declare namespace DLO {
     export type FileSequencer = DloFileSequencer;
     export const PreCompiler: typeof DloPreCompiler;
     export type PreCompiler = DloPreCompiler;
+    /** True for files pawncc compiles directly: the app main file and every *.spec.dlo. */
+    export function isDloRootFile(filePath: string, manifest?: Manifest.Manifest): boolean;
+    /** True for a DLO unit-test spec: `*.spec.dlo`, compiled as its own translation unit. */
+    export function isDloSpecFile(filePath: string): boolean;
+    /**
+     * `DLO_TEST_SPEC=1` (and, if the spec source itself defines `TEST_OWN_MAIN`, `TEST_OWN_MAIN=1`
+     * too) - the pawncc positional defines a `*.spec.dlo` compile needs so dlo-test.inc exposes its
+     * EXPECT_* macros and `main()`. Empty for anything that is not a spec root.
+     */
+    export function getSpecCompileDefines(filePath: string, source?: string): string[];
     /**
      * The DLO Compiler
      */
     export const Compiler: typeof DloCompiler;
     export type Compiler = DloCompiler;
     export const uriToMemFs: typeof uriToMemFsPath;
+    /**
+     * Diagnostics the DLO pre-compiler produced for the files currently cached by the WASM
+     * filesystem hook - i.e. everything the last compile read.
+     */
+    export const getPrecompilerDiagnostics: typeof getPrecompilerDiagnostics;
     export const parseCompilerWarningsAndErrors: typeof parseWarningsAndErrors;
     /**
      * Generate the dlo.cfg file and write it to the .studio/auto/dlo directory
@@ -2584,10 +2601,16 @@ declare class DloCompiler {
         diagnostics: Diagnostics.File[];
     }>;
     /**
-     * Run the symbol compiler and return its output lines.
+     * Run the symbol compiler and return its exit code together with its output lines.
      * Handles WASM-specific path patching (`.` prefix for PROXYFS, `-R` flag).
+     *
+     * A non-zero exit code is not treated as "no output": the lines produced up to the failure are
+     * still returned, so callers can publish diagnostics from them. The dump is truncated in that
+     * case though - pawncc emits no `{"type": "error"}` record in `-R` mode, so the truncation is
+     * not otherwise detectable - and callers must therefore not build a symbol table from a run
+     * that did not exit 0.
      */
-    getDloSymbols(mainFile: string, compileOptions: string[]): Promise<string[] | null>;
+    getDloSymbols(mainFile: string, compileOptions: string[]): Promise<DloSymbolDump | null>;
     /**
      * Get a symbol compiler instance with direct disk access via CUSTOM_WASM_FS.
      */
@@ -2620,6 +2643,14 @@ declare class DloPreCompiler {
     };
 }
 
+/** Result of one `pawncc -R` symbol run: its process exit code plus everything it printed. */
+declare interface DloSymbolDump {
+    /** 0 when pawncc ran to completion; anything else means the dump below is truncated. */
+    exitCode: number;
+    /** stdout followed by stderr, one entry per line. */
+    lines: string[];
+}
+
 /**
  * Thin wrapper around the private `pawncc-wasm` package (bundled into the CLI
  * at build time, like device-master).
@@ -2737,6 +2768,9 @@ declare enum FileType {
  */
 export declare function generateDevApmId(developmentReference: string): string;
 
+/** Aggregates diagnostics from live cache entries so stale/removed files never linger. */
+declare function getPrecompilerDiagnostics(): Diagnostics.File[];
+
 export declare namespace Globals {
     /**
      * Supported ENV for the studio environment