@azure-tools/typespec-ts 0.55.0-dev.1 → 0.55.0-dev.3

package/src/index.ts

@@ -1,9 +1,10 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { EmitContext, Program } from "@typespec/compiler";
-import { provideContext, useContext } from "./contextManager.js";
-import { buildRootIndex, buildSubClientIndexFile } from "./modular/buildRootIndex.js";
+import { EmitContext, Program, getBaseFileName, joinPaths } from "@typespec/compiler";
+import { existsSync } from "fs";
+import { provideContext, useContext } from "./context-manager.js";
+import { buildRootIndex, buildSubClientIndexFile } from "./modular/build-root-index.js";
 import {
   AzureCoreDependencies,
   AzureIdentityDependencies,
@@ -69,8 +70,8 @@ import {
   updatePackageFile,
   updateReadmeFile,
 } from "./rlc-common/index.js";
-import { emitContentByBuilder, emitModels } from "./utils/emitUtil.js";
-import { clearDirectory, emptyDir, pathExists } from "./utils/fileSystemUtils.js";
+import { emitContentByBuilder, emitModels } from "./utils/emit-util.js";
+import { clearDirectory, emptyDir, pathExists } from "./utils/file-system-utils.js";
 import { GenerationDirDetail, SdkContext } from "./utils/interfaces.js";
 
 import {
@@ -79,37 +80,35 @@ import {
   createSdkContext,
   listAllServiceNamespaces,
 } from "@azure-tools/typespec-client-generator-core";
-import { existsSync } from "fs";
-import { basename, join } from "path";
 import { Project } from "ts-morph";
 import { provideBinder } from "./framework/hooks/binder.js";
-import { provideSdkTypes } from "./framework/hooks/sdkTypes.js";
+import { provideSdkTypes } from "./framework/hooks/sdk-types.js";
 import { loadStaticHelpers } from "./framework/load-static-helpers.js";
 import { EmitterOptions } from "./lib.js";
-import { buildClassicalClient } from "./modular/buildClassicalClient.js";
-import { buildClassicOperationFiles } from "./modular/buildClassicalOperationGroups.js";
-import { buildClientContext, getClientContextPath } from "./modular/buildClientContext.js";
-import { transformModularEmitterOptions } from "./modular/buildModularOptions.js";
-import { buildOperationFiles } from "./modular/buildOperations.js";
-import { getModuleExports } from "./modular/buildProjectFiles.js";
-import { buildRestorePoller } from "./modular/buildRestorePoller.js";
-import { buildSubpathIndexFile } from "./modular/buildSubpathIndex.js";
-import { emitLoggerFile } from "./modular/emitLoggerFile.js";
-import { emitNonModelResponseTypes, emitTypes } from "./modular/emitModels.js";
-import { buildApiOptions } from "./modular/emitModelsOptions.js";
-import { emitSamples } from "./modular/emitSamples.js";
-import { emitTests } from "./modular/emitTests.js";
-import { getClassicalClientName } from "./modular/helpers/namingHelpers.js";
+import { buildClassicalClient } from "./modular/build-classical-client.js";
+import { buildClassicOperationFiles } from "./modular/build-classical-operation-groups.js";
+import { buildClientContext, getClientContextPath } from "./modular/build-client-context.js";
+import { transformModularEmitterOptions } from "./modular/build-modular-options.js";
+import { buildOperationFiles } from "./modular/build-operations.js";
+import { getModuleExports } from "./modular/build-project-files.js";
+import { buildRestorePoller } from "./modular/build-restore-poller.js";
+import { buildSubpathIndexFile } from "./modular/build-subpath-index.js";
+import { emitLoggerFile } from "./modular/emit-logger-file.js";
+import { buildApiOptions } from "./modular/emit-models-options.js";
+import { emitNonModelResponseTypes, emitTypes } from "./modular/emit-models.js";
+import { emitSamples } from "./modular/emit-samples.js";
+import { emitTests } from "./modular/emit-tests.js";
+import { getClassicalClientName } from "./modular/helpers/naming-helpers.js";
 import { ModularEmitterOptions } from "./modular/interfaces.js";
-import { packageUsesXmlSerialization } from "./modular/serialization/buildXmlSerializerFunction.js";
+import { packageUsesXmlSerialization } from "./modular/serialization/build-xml-serializer-function.js";
 import { transformRLCModel } from "./transform/transform.js";
-import { transformRLCOptions } from "./transform/transfromRLCOptions.js";
+import { transformRLCOptions } from "./transform/transfrom-rlc-options.js";
 import {
   getClientHierarchyMap,
   getModularClientOptions,
   getRLCClients,
-} from "./utils/clientUtils.js";
-import { generateCrossLanguageDefinitionFile } from "./utils/crossLanguageDef.js";
+} from "./utils/client-utils.js";
+import { generateCrossLanguageDefinitionFile } from "./utils/cross-language-def.js";
 
 export * from "./lib.js";
 
@@ -220,7 +219,7 @@ export async function $onEmit(context: EmitContext) {
       await clearDirectory(context.emitterOutputDir, ["TempTypeSpecFiles"], program);
     }
     const hasTestFolder = await pathExists(
-      join(dpgContext.generationPathDetail?.metadataDir ?? "", "test"),
+      joinPaths(dpgContext.generationPathDetail?.metadataDir ?? "", "test"),
     );
     options.generateTest =
       options.generateTest === true ||
@@ -232,15 +231,15 @@ export async function $onEmit(context: EmitContext) {
 
   async function calculateGenerationDir(): Promise<GenerationDirDetail> {
     const projectRoot = context.emitterOutputDir ?? "";
-    const customizationFolder = join(projectRoot, "generated");
-    const srcGeneratedFolder = join(projectRoot, "src", "generated");
+    const customizationFolder = joinPaths(projectRoot, "generated");
+    const srcGeneratedFolder = joinPaths(projectRoot, "src", "generated");
     // if customization folder exists, use it as sources root
     const finalCustomizationFolder = (await pathExists(srcGeneratedFolder))
       ? srcGeneratedFolder
       : customizationFolder;
     const sourcesRoot = (await pathExists(finalCustomizationFolder))
       ? finalCustomizationFolder
-      : join(projectRoot, "src");
+      : joinPaths(projectRoot, "src");
     return {
       rootDir: projectRoot,
       metadataDir: projectRoot,
@@ -259,7 +258,10 @@ export async function $onEmit(context: EmitContext) {
 
   async function clearSamplesDevFolder() {
     if (emitterOptions["generate-sample"] === true) {
-      const samplesDevPath = join(dpgContext.generationPathDetail?.rootDir ?? "", "samples-dev");
+      const samplesDevPath = joinPaths(
+        dpgContext.generationPathDetail?.rootDir ?? "",
+        "samples-dev",
+      );
       if (await pathExists(samplesDevPath)) {
         await emptyDir(samplesDevPath);
       }
@@ -316,7 +318,7 @@ export async function $onEmit(context: EmitContext) {
       // platform-types (and its browser/react-native variants); emit those
       // files directly under src/ (strip the static-helpers/ segment) to match
       // the RLC design where all generated output lives in src/.
-      if (!basename(filePath).startsWith("platform-types")) {
+      if (!getBaseFileName(filePath).startsWith("platform-types")) {
         continue;
       }
       const outputPath = filePath.replace(/\/static-helpers\//g, "/");
@@ -450,27 +452,30 @@ export async function $onEmit(context: EmitContext) {
     // to avoid unexpected modifications to files like package.json, README.md,
     // warp.config.yml, and snippets.spec.ts. metadata.json is still updated.
     const sourcesDir = dpgContext.generationPathDetail?.modularSourcesDir ?? "";
-    const hasManualConvenienceLayer = basename(sourcesDir) === "generated";
+    const hasManualConvenienceLayer = getBaseFileName(sourcesDir) === "generated";
     const isAzureFlavor = isAzurePackage({ options: option });
     // Generate metadata
-    const existingPackageFilePath = join(
+    const existingPackageFilePath = joinPaths(
       dpgContext.generationPathDetail?.metadataDir ?? "",
       "package.json",
     );
-    const hasPackageFile = await existsSync(existingPackageFilePath);
-    const existingReadmeFilePath = join(
+    const hasPackageFile = existsSync(existingPackageFilePath);
+    const existingReadmeFilePath = joinPaths(
       dpgContext.generationPathDetail?.metadataDir ?? "",
       "README.md",
     );
-    const hasReadmeFile = await existsSync(existingReadmeFilePath);
-    const existingChangelogFilePath = join(
+    const hasReadmeFile = existsSync(existingReadmeFilePath);
+    const existingChangelogFilePath = joinPaths(
       dpgContext.generationPathDetail?.metadataDir ?? "",
       "CHANGELOG.md",
     );
-    const hasChangelogFile = await existsSync(existingChangelogFilePath);
+    const hasChangelogFile = existsSync(existingChangelogFilePath);
     const shouldGenerateMetadata = option.generateMetadata === true || !hasPackageFile;
-    const existingTestFolderPath = join(dpgContext.generationPathDetail?.metadataDir ?? "", "test");
-    const hasTestFolder = await existsSync(existingTestFolderPath);
+    const existingTestFolderPath = joinPaths(
+      dpgContext.generationPathDetail?.metadataDir ?? "",
+      "test",
+    );
+    const hasTestFolder = existsSync(existingTestFolderPath);
     if (option.generateTest === undefined) {
       if (hasTestFolder) {
         option.generateTest = false;

package/src/lib.ts

@@ -145,18 +145,18 @@ export const RLCOptionsSchema: JSONSchemaType<EmitterOptions> = {
     "add-credentials": {
       type: "boolean",
       nullable: true,
-      description: `
-      We support two types of authentication: Azure Key Credential(AzureKey) and Token credential(AADToken), any other will need to be handled manually.
-
-      There are two ways to set up our credential details
-
-      - To use \`@useAuth\` decorator in TypeSpec
-      - To config in yaml file
-
-      Please notice defining in TypeSpec is recommended and also has higher priority than second one.
-
-      To enable credential in \`tspconfig.yaml\` and we need to provide more details to let codegen know types.
-      `,
+      description: [
+        "We support two types of authentication: Azure Key Credential(AzureKey) and Token credential(AADToken), any other will need to be handled manually.",
+        "",
+        "There are two ways to set up our credential details",
+        "",
+        "- To use `@useAuth` decorator in TypeSpec",
+        "- To config in yaml file",
+        "",
+        "Please notice defining in TypeSpec is recommended and also has higher priority than second one.",
+        "",
+        "To enable credential in `tspconfig.yaml` and we need to provide more details to let codegen know types.",
+      ].join("\n"),
     },
     "credential-scopes": {
       type: "array",
@@ -186,20 +186,19 @@ export const RLCOptionsSchema: JSONSchemaType<EmitterOptions> = {
     "generate-metadata": {
       type: "boolean",
       nullable: true,
-      description: `
-      Whether to generate metadata files which includes package.json, README.md and tsconfig.json etc. Defaults to \`undefined\`. If there's not a package.json under package-dir, defaults to \`true\`. but if you'd like to disable this feature you could set it as \`false\`.
-      `,
+      description:
+        "Whether to generate metadata files which includes package.json, README.md and tsconfig.json etc. Defaults to `undefined`. If there's not a package.json under package-dir, defaults to `true`. but if you'd like to disable this feature you could set it as `false`.",
     },
     "generate-test": {
       type: "boolean",
       nullable: true,
-      description: `
-      Whether to generate test files, for basic testing of your generated sdks. Defaults to \`undefined\`.
-      other cases:
-      - If azure-sdk-for-js is \`false\`. Defaults to \`false\`.
-      - If azure-sdk-for-js is \`true\` but there's a test folder under package-dir. Defaults to \`false\`.
-      - If azure-sdk-for-js is \`true\` but there's not a test folder under package-dir. Defaults to \`true\`.
-      `,
+      description: [
+        "Whether to generate test files, for basic testing of your generated sdks. Defaults to `undefined`.",
+        "other cases:",
+        "- If azure-sdk-for-js is `false`. Defaults to `false`.",
+        "- If azure-sdk-for-js is `true` but there's a test folder under package-dir. Defaults to `false`.",
+        "- If azure-sdk-for-js is `true` but there's not a test folder under package-dir. Defaults to `true`.",
+      ].join("\n"),
     },
     "generate-sample": {
       type: "boolean",
@@ -359,15 +358,16 @@ export const RLCOptionsSchema: JSONSchemaType<EmitterOptions> = {
       },
       required: [],
       nullable: true,
-      description: `Only for Modular generation
-      By default, code generation uses the titles specified in the \`@client\` and \`@service\` decorators in TypeSpec to name modular clients. If you need to override these names, you can configure the \`typespec-title-map\`. The map's keys represent the original client names from TypeSpec, and the values are the desired client names. This configuration supports renaming multiple clients.
-
-      \`\`\`yaml
-      typespec-title-map: 
-        AnomalyDetectorClient: AnomalyDetectorRest
-        AnomalyDetectorClient2: AnomalyDetectorRest2
-      \`\`\`
-      `,
+      description: [
+        "Only for Modular generation",
+        "By default, code generation uses the titles specified in the `@client` and `@service` decorators in TypeSpec to name modular clients. If you need to override these names, you can configure the `typespec-title-map`. The map's keys represent the original client names from TypeSpec, and the values are the desired client names. This configuration supports renaming multiple clients.",
+        "",
+        "```yaml",
+        "typespec-title-map:",
+        "  AnomalyDetectorClient: AnomalyDetectorRest",
+        "  AnomalyDetectorClient2: AnomalyDetectorRest2",
+        "```",
+      ].join("\n"),
     },
     "should-use-pnpm-dep": {
       type: "boolean",