@azure-tools/typespec-ts 0.54.0-dev.6 → 0.54.0-dev.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/typespec-ts",
-  "version": "0.54.0-dev.6",
+  "version": "0.54.0-dev.7",
   "description": "An experimental TypeSpec emitter for TypeScript RLC",
   "main": "dist/src/index.js",
   "type": "module",
@@ -99,8 +99,6 @@
     "lint:fix": "eslint src --fix --ext .ts",
     "check:tree": "tsx ./test/commands/check-clean-tree.ts",
     "test:ts:e2e": "npm run copy:typespec && npm run integration-test-ci:azure-rlc && npm run integration-test-ci:azure-modular",
-    "format": "npm run -s prettier -- --write",
-    "check-format": "npm run prettier -- --check",
     "prettier": "prettier --config ./.prettierrc \"{src,test,static}/**/*.ts\" \"!test/**/generated/**/*.ts\"",
     "integration-test-ci": "npm-run-all copy:typespec integration-test-ci:rlc integration-test-ci:azure-rlc integration-test-ci:modular integration-test-ci:azure-modular",
     "integration-test-ci:sequential": "npm-run-all --serial copy:typespec integration-test-ci:modular && npm run integration-test-ci:modular",

package/src/contextManager.ts

@@ -1,10 +1,10 @@
-import { Project, SourceFile } from "ts-morph";
-import { RlcMetaTree } from "./metaTree.js";
-import { EmitContext } from "@typespec/compiler";
 import { SdkContext } from "@azure-tools/typespec-client-generator-core";
-import { SdkTypeContext } from "./framework/hooks/sdkTypes.js";
-import { Binder } from "./framework/hooks/binder.js";
+import { EmitContext } from "@typespec/compiler";
+import { Project, SourceFile } from "ts-morph";
 import { ExternalDependencies } from "./framework/dependency.js";
+import { Binder } from "./framework/hooks/binder.js";
+import { SdkTypeContext } from "./framework/hooks/sdkTypes.js";
+import { RlcMetaTree } from "./metaTree.js";
 
 /**
  * Contexts Object Guidelines
@@ -96,9 +96,6 @@ export function useContext<K extends ContextKey>(key: K): Contexts[K] {
  * @param {ContextKey} key - The key of the context to provide.
  * @param {Contexts[K]} value - The value to set for the specified context.
  */
-export function provideContext<K extends ContextKey>(
-  key: K,
-  value: Contexts[K]
-): void {
+export function provideContext<K extends ContextKey>(key: K, value: Contexts[K]): void {
   contextManager.setContext(key, value);
 }

package/src/framework/declaration.ts

@@ -1,16 +1,16 @@
 import {
-  SourceFile,
+  ClassDeclaration,
   ClassDeclarationStructure,
+  EnumDeclaration,
   EnumDeclarationStructure,
+  FunctionDeclaration,
   FunctionDeclarationStructure,
+  InterfaceDeclaration,
   InterfaceDeclarationStructure,
-  TypeAliasDeclarationStructure,
+  SourceFile,
   StructureKind,
-  ClassDeclaration,
-  EnumDeclaration,
-  FunctionDeclaration,
-  InterfaceDeclaration,
-  TypeAliasDeclaration
+  TypeAliasDeclaration,
+  TypeAliasDeclarationStructure,
 } from "ts-morph";
 import { useBinder } from "./hooks/binder.js";
 import { refkey as getRefKey } from "./refkey.js";
@@ -31,58 +31,50 @@ export type Declarations =
 export function addDeclaration(
   sourceFile: SourceFile,
   declaration: ClassDeclarationStructure,
-  refkey: unknown
+  refkey: unknown,
 ): void;
 
 export function addDeclaration(
   sourceFile: SourceFile,
   declaration: EnumDeclarationStructure,
-  refkey: unknown
+  refkey: unknown,
 ): void;
 
 export function addDeclaration(
   sourceFile: SourceFile,
   declaration: FunctionDeclarationStructure,
-  refkey: unknown
+  refkey: unknown,
 ): void;
 
 export function addDeclaration(
   sourceFile: SourceFile,
   declaration: InterfaceDeclarationStructure,
-  refkey: unknown
+  refkey: unknown,
 ): void;
 
 export function addDeclaration(
   sourceFile: SourceFile,
   declaration: TypeAliasDeclarationStructure,
-  refkey: unknown
-): void;
-export function addDeclaration(
-  sourceFile: SourceFile,
-  declaration: string,
-  refkey: unknown
+  refkey: unknown,
 ): void;
+export function addDeclaration(sourceFile: SourceFile, declaration: string, refkey: unknown): void;
 export function addDeclaration(
   sourceFile: SourceFile,
   input: DeclarationStructures | string,
-  refkey: unknown
+  refkey: unknown,
 ): void {
   const binder = useBinder();
   const declaration: DeclarationStructures =
-    typeof input === "string"
-      ? ({ name: input, kind: StructureKind.TypeAlias } as any)
-      : input;
+    typeof input === "string" ? ({ name: input, kind: StructureKind.TypeAlias } as any) : input;
   if (!declaration.name) {
-    throw new Error(
-      `Declaration must have a name ${JSON.stringify(declaration)}`
-    );
+    throw new Error(`Declaration must have a name ${JSON.stringify(declaration)}`);
   }
 
   const stringRefkey = typeof refkey === "string" ? refkey : getRefKey(refkey);
   const trackedDeclarationName = binder.trackDeclaration(
     stringRefkey,
     declaration.name,
-    sourceFile
+    sourceFile,
   );
 
   // Update the declaration name to be unique
@@ -107,8 +99,6 @@ export function addDeclaration(
       }
       break;
     default:
-      throw new Error(
-        `Unsupported declaration kind ${(trackedDeclaration as any).kind}`
-      );
+      throw new Error(`Unsupported declaration kind ${(trackedDeclaration as any).kind}`);
   }
 }

package/src/framework/dependency.ts

@@ -5,8 +5,7 @@ export interface ReferenceableSymbol {
   visibility?: "internal" | "public";
 }
 
-export type ExternalDependencies = CoreDependencies &
-  Record<string, ReferenceableSymbol>;
+export type ExternalDependencies = CoreDependencies & Record<string, ReferenceableSymbol>;
 
 /**
  * This interface defines the well known Core dependencies that plugins can use to override and provide their own implementations if needed

package/src/framework/hooks/binder.ts

@@ -1,21 +1,18 @@
+import { normalizePath } from "@typespec/compiler";
+import path from "path/posix";
 import {
-  SourceFile,
   ImportDeclarationStructure,
-  StructureKind,
   ImportSpecifierStructure,
-  Project
+  Project,
+  SourceFile,
+  StructureKind,
 } from "ts-morph";
 import { provideContext, useContext } from "../../contextManager.js";
+import { generateLocallyUniqueName } from "../../modular/helpers/namingHelpers.js";
 import { ReferenceableSymbol } from "../dependency.js";
-import { provideDependencies, useDependencies } from "./useDependencies.js";
+import { SourceFileSymbol, StaticHelperMetadata } from "../load-static-helpers.js";
 import { refkey } from "../refkey.js";
-import {
-  SourceFileSymbol,
-  StaticHelperMetadata
-} from "../load-static-helpers.js";
-import path from "path/posix";
-import { normalizePath } from "@typespec/compiler";
-import { generateLocallyUniqueName } from "../../modular/helpers/namingHelpers.js";
+import { provideDependencies, useDependencies } from "./useDependencies.js";
 
 export interface DeclarationInfo {
   name: string;
@@ -39,11 +36,7 @@ export interface Binder {
    * @param sourceFile - The source file where the declaration is made.
    * @returns The tracked declaration name.
    */
-  trackDeclaration(
-    refkey: unknown,
-    name: string,
-    sourceFile: SourceFile
-  ): string;
+  trackDeclaration(refkey: unknown, name: string, sourceFile: SourceFile): string;
   resolveReference(refkey: unknown): string;
   resolveAllReferences(sourceRoot: string, testRoot?: string): void;
 }
@@ -69,15 +62,8 @@ class BinderImp implements Binder {
     this.useSubpathImports = options.useSubpathImports ?? false;
   }
 
-  trackDeclaration(
-    refkey: unknown,
-    name: string,
-    sourceFile: SourceFile
-  ): string {
-    const uniqueName = this.generateLocallyUniqueDeclarationName(
-      name,
-      sourceFile
-    );
+  trackDeclaration(refkey: unknown, name: string, sourceFile: SourceFile): string {
+    const uniqueName = this.generateLocallyUniqueDeclarationName(name, sourceFile);
     const declarationInfo: DeclarationInfo = { name: uniqueName, sourceFile };
     this.declarations.set(refkey, declarationInfo);
 
@@ -96,12 +82,8 @@ class BinderImp implements Binder {
    * @param sourceFile - The source file where the declaration is made.
    * @returns A unique name for the declaration within the file.
    */
-  private generateLocallyUniqueDeclarationName(
-    name: string,
-    sourceFile: SourceFile
-  ): string {
-    const existingNamesInFile =
-      this.symbolsBySourceFile.get(sourceFile) ?? new Set<string>();
+  private generateLocallyUniqueDeclarationName(name: string, sourceFile: SourceFile): string {
+    const existingNamesInFile = this.symbolsBySourceFile.get(sourceFile) ?? new Set<string>();
     return generateLocallyUniqueName(name, existingNamesInFile);
   }
 
@@ -111,10 +93,7 @@ class BinderImp implements Binder {
    * @param sourceFile - The source file where the import is made.
    * @returns A unique name for the import within the file.
    */
-  private generateLocallyUniqueImportName(
-    name: string,
-    sourceFile: SourceFile
-  ): string {
+  private generateLocallyUniqueImportName(name: string, sourceFile: SourceFile): string {
     const existingImports = (this.imports.get(sourceFile) ?? [])
       .flatMap((i) => i.namedImports as ImportSpecifierStructure[])
       .map((i) => i.alias ?? i.name);
@@ -123,15 +102,12 @@ class BinderImp implements Binder {
     const actualImports = sourceFile
       .getImportDeclarations()
       .flatMap((imp) => imp.getNamedImports())
-      .map(
-        (namedImp) => namedImp.getAliasNode()?.getText() ?? namedImp.getName()
-      );
+      .map((namedImp) => namedImp.getAliasNode()?.getText() ?? namedImp.getName());
 
-    const existingDeclarations =
-      this.symbolsBySourceFile.get(sourceFile) ?? new Set<string>();
+    const existingDeclarations = this.symbolsBySourceFile.get(sourceFile) ?? new Set<string>();
     return generateLocallyUniqueName(
       name,
-      new Set([...existingImports, ...actualImports, ...existingDeclarations])
+      new Set([...existingImports, ...actualImports, ...existingDeclarations]),
     );
   }
 
@@ -166,12 +142,9 @@ class BinderImp implements Binder {
   private addImport(
     fileWhereImportIsAdded: SourceFile,
     fileWhereImportPointsTo: SourceFile | string,
-    name: string
+    name: string,
   ): ImportSpecifierStructure {
-    const importAlias = this.generateLocallyUniqueImportName(
-      name,
-      fileWhereImportIsAdded
-    );
+    const importAlias = this.generateLocallyUniqueImportName(name, fileWhereImportIsAdded);
     let moduleSpecifier = "";
     if (typeof fileWhereImportPointsTo === "string") {
       moduleSpecifier = fileWhereImportPointsTo;
@@ -180,35 +153,30 @@ class BinderImp implements Binder {
         .getRelativePathTo(fileWhereImportPointsTo)
         .replace(".ts", ".js");
       moduleSpecifier =
-        relative.startsWith(".") || relative.startsWith("/")
-          ? relative
-          : `./${relative}`;
+        relative.startsWith(".") || relative.startsWith("/") ? relative : `./${relative}`;
     }
 
     const importStructures = this.imports.get(fileWhereImportIsAdded) || [];
 
-    let importStructure = importStructures.find(
-      (imp) => imp.moduleSpecifier === moduleSpecifier
-    );
+    let importStructure = importStructures.find((imp) => imp.moduleSpecifier === moduleSpecifier);
 
     if (!importStructure) {
       importStructure = {
         kind: StructureKind.ImportDeclaration,
         moduleSpecifier,
-        namedImports: []
+        namedImports: [],
       };
       importStructures.push(importStructure);
     }
 
-    const namedImports =
-      importStructure.namedImports as ImportSpecifierStructure[];
+    const namedImports = importStructure.namedImports as ImportSpecifierStructure[];
     let importSpecifier = namedImports.find((n) => n.name === importAlias);
 
     if (!importSpecifier) {
       importSpecifier = {
         name: name,
         alias: name === importAlias ? undefined : importAlias,
-        kind: StructureKind.ImportSpecifier
+        kind: StructureKind.ImportSpecifier,
       };
       namedImports.push(importSpecifier);
     }
@@ -225,21 +193,15 @@ class BinderImp implements Binder {
    * e.g. "src/static-helpers/serialization/get-binary-response.ts"
    *   -> "#platform/static-helpers/serialization/get-binary-response"
    */
-  private getPlatformImportSpecifier(
-    declarationSourceFile: SourceFile
-  ): string | undefined {
+  private getPlatformImportSpecifier(declarationSourceFile: SourceFile): string | undefined {
     if (!this.useSubpathImports) return undefined;
     const filePath = declarationSourceFile.getFilePath();
     const srcIndex = filePath.indexOf("/src/");
     if (srcIndex === -1) return undefined;
     // Check if a -browser.mts or -react-native.mts sibling exists
     const basePath = filePath.replace(/\.ts$/, "");
-    const hasBrowserVariant = this.project.getSourceFile(
-      basePath + "-browser.mts"
-    );
-    const hasReactNativeVariant = this.project.getSourceFile(
-      basePath + "-react-native.mts"
-    );
+    const hasBrowserVariant = this.project.getSourceFile(basePath + "-browser.mts");
+    const hasReactNativeVariant = this.project.getSourceFile(basePath + "-react-native.mts");
     if (!hasBrowserVariant && !hasReactNativeVariant) return undefined;
     const relativePath = filePath.substring(srcIndex + "/src/".length);
     return "#platform/" + relativePath.replace(/\.ts$/, "");
@@ -255,23 +217,14 @@ class BinderImp implements Binder {
       [unknown, DeclarationInfo | StaticHelperMetadata]
     >();
     for (const [key, value] of this.declarations) {
-      declarationByPlaceholder.set(this.serializePlaceholder(key), [
-        key,
-        value
-      ]);
+      declarationByPlaceholder.set(this.serializePlaceholder(key), [key, value]);
     }
     for (const [key, value] of this.staticHelpers) {
-      declarationByPlaceholder.set(this.serializePlaceholder(key), [
-        key,
-        value
-      ]);
+      declarationByPlaceholder.set(this.serializePlaceholder(key), [key, value]);
     }
     const dependencyByPlaceholder = new Map<string, ReferenceableSymbol>();
     for (const dependency of Object.values(this.dependencies)) {
-      dependencyByPlaceholder.set(
-        this.serializePlaceholder(refkey(dependency)),
-        dependency
-      );
+      dependencyByPlaceholder.set(this.serializePlaceholder(refkey(dependency)), dependency);
     }
 
     this.project.getSourceFiles().map((file) => {
@@ -285,13 +238,13 @@ class BinderImp implements Binder {
           file,
           declarationByPlaceholder,
           presentPlaceholders,
-          replacementMap
+          replacementMap,
         );
         this.resolveDependencyReferences(
           file,
           dependencyByPlaceholder,
           presentPlaceholders,
-          replacementMap
+          replacementMap,
         );
         if (replacementMap.size > 0) {
           applyReplacements(file, replacementMap);
@@ -300,9 +253,7 @@ class BinderImp implements Binder {
       const importStructures = this.imports.get(file);
       if (importStructures && importStructures.length > 0) {
         // Sort imports in place by module specifier to ensure consistent ordering
-        importStructures.sort((a, b) =>
-          a.moduleSpecifier < b.moduleSpecifier ? -1 : 1
-        );
+        importStructures.sort((a, b) => (a.moduleSpecifier < b.moduleSpecifier ? -1 : 1));
         file.addImportDeclarations(importStructures);
       }
     });
@@ -322,7 +273,7 @@ class BinderImp implements Binder {
     file: SourceFile,
     dependencyByPlaceholder: Map<string, ReferenceableSymbol>,
     presentPlaceholders: Set<string>,
-    replacementMap: Map<string, string>
+    replacementMap: Map<string, string>,
   ) {
     for (const [placeholder, dependency] of dependencyByPlaceholder) {
       if (!presentPlaceholders.has(placeholder)) {
@@ -346,17 +297,11 @@ class BinderImp implements Binder {
    */
   private resolveDeclarationReferences(
     file: SourceFile,
-    declarationByPlaceholder: Map<
-      string,
-      [unknown, DeclarationInfo | StaticHelperMetadata]
-    >,
+    declarationByPlaceholder: Map<string, [unknown, DeclarationInfo | StaticHelperMetadata]>,
     presentPlaceholders: Set<string>,
-    replacementMap: Map<string, string>
+    replacementMap: Map<string, string>,
   ) {
-    for (const [
-      placeholderKey,
-      [declarationKey, declaration]
-    ] of declarationByPlaceholder) {
+    for (const [placeholderKey, [declarationKey, declaration]] of declarationByPlaceholder) {
       if (!presentPlaceholders.has(placeholderKey)) {
         continue;
       }
@@ -373,9 +318,7 @@ class BinderImp implements Binder {
       if (file !== declarationSourceFile) {
         this.trackReference(declarationKey, file);
         // Use #platform/ subpath import specifier for static helpers in warp packages
-        const platformSpecifier = this.getPlatformImportSpecifier(
-          declarationSourceFile
-        );
+        const platformSpecifier = this.getPlatformImportSpecifier(declarationSourceFile);
         const importTarget = platformSpecifier ?? declarationSourceFile;
         const importDec = this.addImport(file, importTarget, name);
         name = importDec.alias ?? name;
@@ -399,7 +342,7 @@ class BinderImp implements Binder {
       if (!sourceFile) {
         // This should be unreachable
         throw new Error(
-          `Static helper ${helper.name} does not have a source file. Make sure that loadStaticHelpers has been correctly initialized in index.ts`
+          `Static helper ${helper.name} does not have a source file. Make sure that loadStaticHelpers has been correctly initialized in index.ts`,
         );
       }
       const referencedHelper = this.references.get(refkey(helper));
@@ -411,11 +354,9 @@ class BinderImp implements Binder {
 
     // Also keep files that are imported by any used helper file
     const helperFiles = this.project.getSourceFiles(
-      normalizePath(path.join(sourceRoot, "static-helpers/**/*.*ts"))
-    );
-    const usedFiles = helperFiles.filter(
-      (file) => !isFileUnused(file, usedHelperNames)
+      normalizePath(path.join(sourceRoot, "static-helpers/**/*.*ts")),
     );
+    const usedFiles = helperFiles.filter((file) => !isFileUnused(file, usedHelperNames));
     for (const usedFile of usedFiles) {
       for (const importDecl of usedFile.getImportDeclarations()) {
         const resolved = importDecl.getModuleSpecifierSourceFile();
@@ -437,19 +378,14 @@ class BinderImp implements Binder {
     }
     this.project
       //normalizae the final path to adapt to different systems
-      .getSourceFiles(
-        normalizePath(path.join(testRoot, "test/generated/util/**/*.*ts"))
-      )
+      .getSourceFiles(normalizePath(path.join(testRoot, "test/generated/util/**/*.*ts")))
       .filter((file) => isFileUnused(file, usedHelperNames))
       .forEach((helperFile) => helperFile.delete());
   }
 }
 
 // Provide the binder context to be used globally
-export function provideBinder(
-  project: Project,
-  options: BinderOptions = {}
-): Binder {
+export function provideBinder(project: Project, options: BinderOptions = {}): Binder {
   const binder = new BinderImp(project, options);
   provideContext("binder", binder);
   return binder;
@@ -460,7 +396,7 @@ function isFileUnused(file: SourceFile, usedHelperNames: string[]) {
   // A file is used if it matches a used helper name exactly,
   // or is a platform-specific variant (e.g. "foo-browser" for helper "foo")
   return !usedHelperNames.some(
-    (s) => name === s || name === `${s}-browser` || name === `${s}-react-native`
+    (s) => name === s || name === `${s}-browser` || name === `${s}-react-native`,
   );
 }
 
@@ -478,18 +414,12 @@ export function useBinder(): Binder {
  * @param sourceFile - The source file to mutate.
  * @param replacementMap - A map from each placeholder string to its replacement value.
  */
-function applyReplacements(
-  sourceFile: SourceFile,
-  replacementMap: Map<string, string>
-): void {
+function applyReplacements(sourceFile: SourceFile, replacementMap: Map<string, string>): void {
   if (replacementMap.size === 0) {
     return;
   }
   const text = sourceFile.getFullText();
-  const placeholderRegex = new RegExp(
-    `${escapeRegExp(PLACEHOLDER_PREFIX)}.+?__`,
-    "g"
-  );
+  const placeholderRegex = new RegExp(`${escapeRegExp(PLACEHOLDER_PREFIX)}.+?__`, "g");
   let changed = false;
   const updatedText = text.replace(placeholderRegex, (match) => {
     const replacement = replacementMap.get(match);
@@ -517,10 +447,7 @@ function collectPlaceholders(sourceFile: SourceFile): Set<string> {
     return result;
   }
   // Refkeys are alphanumeric (see refkey.ts), so `.+?` safely stops at `__`.
-  const placeholderRegex = new RegExp(
-    `${escapeRegExp(PLACEHOLDER_PREFIX)}.+?__`,
-    "g"
-  );
+  const placeholderRegex = new RegExp(`${escapeRegExp(PLACEHOLDER_PREFIX)}.+?__`, "g");
   let match: RegExpExecArray | null;
   while ((match = placeholderRegex.exec(text)) !== null) {
     result.add(match[0]);