Revert "Add tsp-client compare command (#8793)"

This reverts commit ab1eacb.

tools/tsp-client/.gitignore

@@ -3,5 +3,3 @@ node_modules
 dist
 types
 temp
-tsp-output/
-output/

tools/tsp-client/CHANGELOG.md

@@ -5,7 +5,6 @@
 - Added `generate-lock-file` command, see [README](https://github.com/Azure/azure-sdk-tools/blob/main/tools/tsp-client/README.md) for more information.
 - Removed the `--generate-lock-file` flag and replaced it with the command above.
 - Migrated tsp-client from `node:util` to `yargs` for commandline infrastructure.
-- Added `compare` command to compare a hand-authored Swagger to a TypeSpec-generated Swagger to understand the relevant differences between them.
 
 ## 2024-08-05 - 0.10.0
 

tools/tsp-client/README.md

@@ -3,72 +3,56 @@
 A simple command line tool to facilitate generating client libraries from TypeSpec.
 
 ## Installation
-
 ```
 npm install @azure-tools/typespec-client-generator-cli
 ```
 
 ## Prerequisites
-
 Please note that these prerequisites apply on the repository where the client library is going to be generated. Repo owners should make sure to follow these prerequisites. Users working with a repository that already accepts this tool can continue to see the [Usage](#usage) section.
 
 - Add an emitter-package.json to the repo following this [configuration](#emitter-packagejson).
 - Add the [TempTypeSpecFiles](#TempTypeSpecFiles) directory to the .gitignore file for your repository.
 
 ## Usage
-
 ```
 tsp-client <command> [options]
 ```
 
 ## Commands
-
 Use one of the supported commands to get started generating clients from a TypeSpec project.
 This tool will default to using your current working directory to generate clients in and will
 use it to look for relevant configuration files. To specify a different output directory, use
 the `-o` or `--output-dir` option.
 
 ### init
-
 Initialize the client library directory using a tspconfig.yaml. When running this command pass in a path to a local or remote tspconfig.yaml with the `-c` or `--tsp-config` flag.
 
 The `init` command generates a directory structure following the standard pattern used across Azure SDK language repositories, creates a [tsp-location.yaml](#tsp-locationyaml) file to control generation, and performs an initial generation of the client library. If you want to skip client library generation, then pass the `--skip-sync-and-generate` flag.
 
 > IMPORTANT: This command should be run from the root of the repository.
 
 ### update
-
 Sync and generate client libraries from a TypeSpec project. The `update` command will look for a [tsp-location.yaml](#tsp-locationyaml) file in your current directory to sync a TypeSpec project and generate a client library.
 
 ### sync
-
 Sync a TypeSpec project with the parameters specified in tsp-location.yaml.
 
 By default the `sync` command will look for a tsp-location.yaml to get the project details and sync them to a temporary directory called `TempTypeSpecFiles`. Alternately, you can pass in the `--local-spec-repo` flag with the path to your local TypeSpec project to pull those files into your temporary directory.
 
 ### generate
-
 Generate a client library from a TypeSpec project. The `generate` command should be run after the `sync` command. `generate` relies on the existence of the `TempTypeSpecFiles` directory created by the `sync` command and on an `emitter-package.json` file checked into your repository at the following path: `<repo root>/eng/emitter-package.json`. The `emitter-package.json` file is used to install project dependencies and get the appropriate emitter package.
 
 ### convert
-
 Convert an existing swagger specification to a TypeSpec project. This command should only be run once to get started working on a TypeSpec project. TypeSpec projects will need to be optimized manually and fully reviewed after conversion. When using this command a path or url to a swagger README file is required through the `--swagger-readme` flag.
 
-### compare
-
-Compares two Swagger definitions to identify the relevant differences between them. This command is useful when comparing an existing Swagger definition with a TypeSpec generated one. The `compare` command requires two parameters: `--lhs` which will typically be the original hand-authored Swagger and `--rhs` which will usually be the folder containing your TypeSpec. The command will generate the Swagger and compare the two definitions. The command will ignore differences in the Swagger that don't
-correspond to differences in the service, allowing you to focus only on differences that are relevant.
-
 ### sort-swagger
-
 Sort an existing swagger specification to be the same content order with TypeSpec generated swagger. This will allow you to easily compare and identify differences between the existing swagger and TypeSpec generated one. You should run this command on existing swagger files and check them in prior to creating converted TypeSpec PRs.
 
 ### generate-lock-file
 
 Generate an emitter-package-lock.json under the eng/ directory based on existing `<repo-root>/eng/emitter-package.json`.
 
 ## Options
-
 ```
   --arm                     Convert ARM swagger specification to TypeSpec       [boolean]
   -c, --tsp-config          The tspconfig.yaml file to use                      [string]
@@ -81,9 +65,9 @@ Generate an emitter-package-lock.json under the eng/ directory based on existing
   --save-inputs             Don't clean up the temp directory after generation  [boolean]
   --skip-sync-and-generate  Skip sync and generate during project init          [boolean]
   --swagger-readme          Path or url to swagger readme file                  [string]
-  -o, --output-dir          Specify an alternate output directory for the
+  -o, --output-dir          Specify an alternate output directory for the 
                             generated files. Default is your current directory  [string]
-  --repo                    Repository where the project is defined for init
+  --repo                    Repository where the project is defined for init 
                             or update                                           [string]
   -v, --version             Show version number                                 [boolean]
 ```
@@ -107,23 +91,22 @@ tsp-client update
 ## Important concepts
 
 ### Per project setup
-
 Each project will need to have a configuration file called tsp-location.yaml that will tell the tool where to find the TypeSpec project.
 
 #### tsp-location.yaml
 
-This file is created through the `tsp-client init` command or you can manually create it under the project directory to run other commands supported by this tool.
+This file is created through the `tsp-client init` command or you can manually create it under the project directory to run other commands supported by this tool. 
 
 > NOTE: This file should live under the project directory for each service.
 
 The file has the following properties:
 
-| Property                                                        | Description                                                                                                                                                                                                                                                                                           | IsRequired            |
-| --------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
-| <a id="directory-anchor"></a> directory                         | The top level directory where the main.tsp for the service lives. This should be relative to the spec repo root such as `specification/cognitiveservices/OpenAI.Inference`                                                                                                                            | true                  |
-| <a id="additionalDirectories-anchor"></a> additionalDirectories | Sometimes a typespec file will use a relative import that might not be under the main directory. In this case a single `directory` will not be enough to pull down all necessary files. To support this you can specify additional directories as a list to sync so that all needed files are synced. | false: default = null |
-| <a id="commit-anchor"></a> commit                               | The commit sha for the version of the typespec files you want to generate off of. This allows us to have idempotence on generation until we opt into pointing at a later version.                                                                                                                     | true                  |
-| <a id="repo-anchor"></a> repo                                   | The repo this spec lives in. This should be either `Azure/azure-rest-api-specs` or `Azure/azure-rest-api-specs-pr`. Note that pr will work locally but not in CI until we add another change to handle token based auth.                                                                              | true                  |
+| Property | Description | IsRequired |
+| --- | --- | --- |
+| <a id="directory-anchor"></a> directory | The top level directory where the main.tsp for the service lives.  This should be relative to the spec repo root such as `specification/cognitiveservices/OpenAI.Inference` | true |
+| <a id="additionalDirectories-anchor"></a> additionalDirectories | Sometimes a typespec file will use a relative import that might not be under the main directory.  In this case a single `directory` will not be enough to pull down all necessary files.  To support this you can specify additional directories as a list to sync so that all needed files are synced. | false: default = null |
+| <a id="commit-anchor"></a> commit | The commit sha for the version of the typespec files you want to generate off of.  This allows us to have idempotence on generation until we opt into pointing at a later version. | true |
+| <a id="repo-anchor"></a> repo | The repo this spec lives in.  This should be either `Azure/azure-rest-api-specs` or `Azure/azure-rest-api-specs-pr`.  Note that pr will work locally but not in CI until we add another change to handle token based auth. | true |
 
 Example:
 
@@ -152,6 +135,7 @@ See the following example of a valid tspconfig.yaml file: https://github.com/Azu
 
 Using the tspconfig.yaml linked above, by default, the client libraries will be generated in the following directory for C#: `<repo>/sdk/contosowidgetmanager/Azure.Template.Contoso/`.
 
+
 ### emitter-package.json (Required)
 
 `emitter-package.json` will be used the same as a `package.json` file. If the is no `emitter-package-lock.json` file, the tool will run `npm install` on the contents of `emitter-package.json`. This file allows each repository to pin the version of their emitter and other dependencies to be used when generating client libraries.
@@ -161,16 +145,16 @@ Example:
 
 ```json
 {
-  "main": "dist/src/index.js",
-  "dependencies": {
-    "@azure-tools/typespec-csharp": "0.1.11-beta.20230123.1"
-  }
+    "main": "dist/src/index.js",
+    "dependencies": {
+      "@azure-tools/typespec-csharp": "0.1.11-beta.20230123.1"
+    }
 }
 ```
 
 > NOTE: tsp compile currently requires the "main" line to be there.
 
-> NOTE: This file replaces the package.json checked into the `azure-rest-api-spec` repository.
+> NOTE: This file replaces the package.json checked into the `azure-rest-api-spec` repository. 
 
 ### emitter-package-lock.json (Optional)