[tsp-client] Support generating a lock file from emitter-package.json (#7898)

* generate lock file from emitter-package.json

* generate in eng dir

Author: catalinaperalta

tools/tsp-client/README.md

@@ -50,6 +50,8 @@ Convert an existing swagger specification to a TypeSpec project. This command sh
   --commit                  Commit to be used for project init or update        [string]
   -d, --debug               Enable debug logging                                [boolean]
   --emitter-options         The options to pass to the emitter                  [string]
+  --generate-lock-file      Generate a lock file under the eng/ directory from 
+                            an existing emitter-package.json                    [boolean]
   -h, --help                Show help                                           [boolean]
   --local-spec-repo         Path to local repository with the TypeSpec project  [string]
   --save-inputs             Don't clean up the temp directory after generation  [boolean]

tools/tsp-client/src/index.ts

@@ -260,6 +260,22 @@ async function convert(readme: string, outputDir: string, arm?: boolean): Promis
   return await npxCommand(outputDir, args);
 }
 
+async function generateLockFile(rootUrl: string, repoRoot: string) {
+  Logger.info("Generating lock file...");
+  const args: string[] = ["install"];
+  if (process.env['TSPCLIENT_FORCE_INSTALL']?.toLowerCase() === "true") {
+    args.push("--force");
+  }
+  const tempRoot = await createTempDirectory(rootUrl);
+  await cp(joinPaths(repoRoot, "eng", "emitter-package.json"), joinPaths(tempRoot, "package.json"));
+  await npmCommand(tempRoot, args);
+  const lockFile = await stat(joinPaths(tempRoot, "package-lock.json"));
+  if (lockFile.isFile()) {
+    await cp(joinPaths(tempRoot, "package-lock.json"), joinPaths(repoRoot, "eng", "emitter-package-lock.json"));
+  }
+  await removeDirectory(tempRoot);
+  Logger.info(`Lock file generated in ${joinPaths(rootUrl, "emitter-package-lock.json")}`);
+}
 
 async function main() {
   const options = await getOptions();
@@ -285,7 +301,12 @@ async function main() {
   } catch (err) {
     Logger.debug(`Error occurred while attempting to remove sparse-spec directory: ${err}`);
   }
-  
+
+  if (options.generateLockFile) {
+    await generateLockFile(rootUrl, repoRoot);
+    return;
+  }
+
   switch (options.command) {
       case "init":
         const emitter = await getEmitterFromRepoConfig(joinPaths(repoRoot, "eng", "emitter-package.json"));

tools/tsp-client/src/log.ts

@@ -75,6 +75,8 @@ Options:
   --commit                  Commit to be used for project init or update        [string]
   -d, --debug               Enable debug logging                                [boolean]
   --emitter-options         The options to pass to the emitter                  [string]
+  --generate-lock-file      Generate a lock file under the eng/ directory from 
+                            an existing emitter-package.json                    [boolean]
   -h, --help                Show help                                           [boolean]
   --local-spec-repo         Path to local repository with the TypeSpec project  [string]
   --save-inputs             Don't clean up the temp directory after generation  [boolean]

tools/tsp-client/src/options.ts

@@ -17,6 +17,7 @@ export interface Options {
   isUrl: boolean;
   localSpecRepo?: string;
   emitterOptions?: string;
+  generateLockFile: boolean;
   swaggerReadme?: string;
   arm: boolean;
 }
@@ -54,6 +55,9 @@ export async function getOptions(): Promise<Options> {
       ["emitter-options"]: {
         type: "string",
       },
+      ["generate-lock-file"]: {
+        "type": "boolean",
+      },
       ["local-spec-repo"]: {
         type: "string",
       },
@@ -81,50 +85,53 @@ export async function getOptions(): Promise<Options> {
     process.exit(0);
   }
 
-  if (positionals.length === 0) {
-    Logger.error("Command is required");
-    printUsage();
-    process.exit(1);
-  }
+  let isUrl = true;
   const supportedCommands = ["sync", "generate", "update", "init", "convert"];
-
   const command = positionals[0];
-  if (!command) {
-    Logger.error("Command is required");
-    printUsage();
-    process.exit(1);
-  }
 
-  if (!supportedCommands.includes(command)) {
-    Logger.error(`Unknown command ${command}`);
-    printUsage();
-    process.exit(1);
-  }
+  if (!values["generate-lock-file"]) {
+    if (positionals.length === 0) {
+      Logger.error("Command is required");
+      printUsage();
+      process.exit(1);
+    }
 
-  let isUrl = true;
-  if (command === "init") {
-    if (!values["tsp-config"]) {
-      Logger.error("tspConfig is required");
+    if (!command) {
+      Logger.error("Command is required");
       printUsage();
       process.exit(1);
     }
-    if (await doesFileExist(values["tsp-config"])) {
-      isUrl = false;
+
+    if (!supportedCommands.includes(command)) {
+      Logger.error(`Unknown command ${command}`);
+      printUsage();
+      process.exit(1);
     }
-    if (!isUrl) {
-      if (!values.commit || !values.repo) {
-        Logger.error("The commit and repo options are required when tspConfig is a local directory");
+
+    if (command === "init") {
+      if (!values["tsp-config"]) {
+        Logger.error("tspConfig is required");
         printUsage();
         process.exit(1);
       }
+      if (await doesFileExist(values["tsp-config"])) {
+        isUrl = false;
+      }
+      if (!isUrl) {
+        if (!values.commit || !values.repo) {
+          Logger.error("The commit and repo options are required when tspConfig is a local directory");
+          printUsage();
+          process.exit(1);
+        }
+      }
     }
-  }
 
-  if (command === "convert") {
-    if (!values["swagger-readme"]) {
-      Logger.error("Must specify a swagger readme with the `--swagger-readme` flag");
-      printUsage();
-      process.exit(1);
+    if (command === "convert") {
+      if (!values["swagger-readme"]) {
+        Logger.error("Must specify a swagger readme with the `--swagger-readme` flag");
+        printUsage();
+        process.exit(1);
+      }
     }
   }
 
@@ -158,7 +165,7 @@ export async function getOptions(): Promise<Options> {
 
   return {
     debug: values.debug ?? false,
-    command: command,
+    command: command ?? "",
     tspConfig: values["tsp-config"],
     noCleanup: values["save-inputs"] ?? false,
     skipSyncAndGenerate: values["skip-sync-and-generate"] ?? false,
@@ -168,6 +175,7 @@ export async function getOptions(): Promise<Options> {
     isUrl: isUrl,
     localSpecRepo: values["local-spec-repo"],
     emitterOptions: values["emitter-options"],
+    generateLockFile: values["generate-lock-file"] ?? false,
     swaggerReadme: values["swagger-readme"],
     arm: values.arm ?? false,
   };