@microtronics/studio-cli 1.3.0-alpha.1 → 1.3.0-alpha.3

package/out/studio-cli.d.ts

@@ -2601,6 +2601,25 @@ export declare namespace DLO {
      * EXPECT_* macros and `main()`. Empty for anything that is not a spec root.
      */
     export function getSpecCompileDefines(filePath: string, source?: string): string[];
+    /**
+     * The identifier the pre-compiler derives from an `IT("title")` of a spec root: the title
+     * lower-cased, every run of characters outside `[A-Za-z0-9_]` collapsed into one `_`,
+     * leading/trailing `_` dropped and truncated to `IT_SLUG_MAX` (22) so that
+     * `__it_<slug>__<n>` still fits pawncc's 31 character public name limit.
+     */
+    export const itSlug: typeof ItNaming.itSlug;
+    /** `itSlug()` made unique within one spec by appending `_2`, `_3`, ... */
+    export const uniqueItSlug: typeof ItNaming.uniqueItSlug;
+    /** The public an `IT` declares: `__it_<slug>`. */
+    export const itPublicName: typeof ItNaming.itPublicName;
+    /** The public a `STEP` declares: `__it_<slug>__<n>`. */
+    export const stepPublicName: typeof ItNaming.stepPublicName;
+    export const IT_PREFIX = "__it_";
+    export const IT_SLUG_MAX: number;
+    export const PUBLIC_NAME_MAX = 31;
+    /** `// @it <slug> "<title>"` - the marker the pre-compiler leaves on a rewritten line. */
+    export const itMarkerComment: typeof ItNaming.itMarkerComment;
+    export const IT_MARKER_RE: RegExp;
     /**
      * The DLO Compiler
      */
@@ -2986,6 +3005,49 @@ export declare enum HttpMethod {
  */
 export declare function install(cwd: URI, fs: LocalFS, logger: Log.Logger, env: Globals.ENV, apiToken: string | null, dependencies: string[], development?: boolean): Promise<void>;
 
+/** Matches the marker `itMarkerComment()` writes, capturing the slug and the raw title. */
+declare const IT_MARKER_RE: RegExp;
+
+/** What `IT` pastes in front of the id/slug to get the public name. */
+declare const IT_PREFIX = "__it_";
+
+/** Longest slug that keeps `__it_<slug>__<n>` (n up to 99) inside `PUBLIC_NAME_MAX`: 22. */
+declare const IT_SLUG_MAX: number;
+
+/**
+ * The marker the pre-compiler leaves on the line it rewrote: `// @it <slug> "<title>"`, with
+ * the title kept exactly as it was written (escapes included). It lets the runner and the
+ * language server map a public back to its title without re-deriving the slug.
+ */
+declare function itMarkerComment(slug: string, rawTitle: string): string;
+
+declare namespace ItNaming {
+    export {
+        itSlug,
+        uniqueItSlug,
+        itPublicName,
+        stepPublicName,
+        itMarkerComment,
+        PUBLIC_NAME_MAX,
+        IT_PREFIX,
+        IT_SLUG_MAX,
+        IT_MARKER_RE
+    }
+}
+
+/** The public an `IT` declares. */
+declare function itPublicName(slug: string): string;
+
+/**
+ * The identifier part of the public an `IT("title")` declares: the title lower-cased, every
+ * run of characters outside `[A-Za-z0-9_]` collapsed into a single `_`, leading and trailing
+ * `_` dropped and the result truncated to `maxLength` (`IT_SLUG_MAX` by default).
+ *
+ * Empty when the title has nothing to slug (`"---"`), which the caller has to report - there
+ * is no name to give the public.
+ */
+declare function itSlug(title: string, maxLength?: number): string;
+
 export declare namespace Library {
     /**
      * Creates the library.tar.gz archive content
@@ -5817,6 +5879,9 @@ declare interface PawnModuleOptions {
     printErr?: (data: string) => void;
 }
 
+/** pawncc truncates a public's name to `sNAMEMAX` characters. */
+declare const PUBLIC_NAME_MAX = 31;
+
 /**
  * Publishes a package to the registry with the specified settings and configurations.
  *
@@ -5891,12 +5956,22 @@ export declare interface StampPollerStatus {
     paused: boolean;
 }
 
+/** The public a `STEP` declares - a continuation of `itPublicName(slug)`. */
+declare function stepPublicName(slug: string, n: number): string;
+
 /**
  * Opens the transports for a device given its serial number. The default (WebUSB) factory
  * is used by {@link openDevice} unless a test/consumer supplies its own.
  */
 export declare type TransportFactory = (serial: string, needDebug?: boolean) => Promise<DeviceTransports>;
 
+/**
+ * `itSlug()` made unique within one spec: on a collision `_2`, `_3`, ... is appended, the base
+ * re-truncated so the suffixed slug still fits `IT_SLUG_MAX`. Returns an empty string for a
+ * title that slugs to nothing.
+ */
+declare function uniqueItSlug(title: string, taken: ReadonlySet<string>): string;
+
 /**
  * Upload result interface
  */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@microtronics/studio-cli",
-	"version": "1.3.0-alpha.1",
+	"version": "1.3.0-alpha.3",
 	"description": "Microtronics Studio CLI Tool",
 	"main": "./out/api.js",
 	"typings": "./out/studio-cli.d.ts",
@@ -76,7 +76,7 @@
 		"mocha": "^10.8.2",
 		"mocha-junit-reporter": "^2.2.1",
 		"openapi-typescript": "^7.6.0",
-		"pawncc-wasm": "bitbucket:microtronics-core/pawncc-wasm#v1.1.1",
+		"pawncc-wasm": "bitbucket:microtronics-core/pawncc-wasm#v1.2.0",
 		"resedit": "^3.0.2",
 		"tar": "^7.5.7",
 		"ts-node": "^10.9.2",