You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Revert "Add `tsp-client compare` command (#8793)"
This reverts commit ab1eacb.
* update package version and lock
* update changelog to reflect package version
Copy file name to clipboardExpand all lines: tools/tsp-client/CHANGELOG.md
+4-1Lines changed: 4 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,14 @@
1
1
# Release
2
2
3
+
## 2024-08-08 - 0.11.1
4
+
5
+
- Removed `compare` command.
6
+
3
7
## 2024-08-08 - 0.11.0
4
8
5
9
- Added `generate-lock-file` command, see [README](https://github.com/Azure/azure-sdk-tools/blob/main/tools/tsp-client/README.md) for more information.
6
10
- Removed the `--generate-lock-file` flag and replaced it with the command above.
7
11
- Migrated tsp-client from `node:util` to `yargs` for commandline infrastructure.
8
-
- Added `compare` command to compare a hand-authored Swagger to a TypeSpec-generated Swagger to understand the relevant differences between them.
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.
14
12
15
13
- Add an emitter-package.json to the repo following this [configuration](#emitter-packagejson).
16
14
- Add the [TempTypeSpecFiles](#TempTypeSpecFiles) directory to the .gitignore file for your repository.
17
15
18
16
## Usage
19
-
20
17
```
21
18
tsp-client <command> [options]
22
19
```
23
20
24
21
## Commands
25
-
26
22
Use one of the supported commands to get started generating clients from a TypeSpec project.
27
23
This tool will default to using your current working directory to generate clients in and will
28
24
use it to look for relevant configuration files. To specify a different output directory, use
29
25
the `-o` or `--output-dir` option.
30
26
31
27
### init
32
-
33
28
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.
34
29
35
30
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.
36
31
37
32
> IMPORTANT: This command should be run from the root of the repository.
38
33
39
34
### update
40
-
41
35
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.
42
36
43
37
### sync
44
-
45
38
Sync a TypeSpec project with the parameters specified in tsp-location.yaml.
46
39
47
40
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.
48
41
49
42
### generate
50
-
51
43
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.
52
44
53
45
### convert
54
-
55
46
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.
56
47
57
-
### compare
58
-
59
-
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
60
-
correspond to differences in the service, allowing you to focus only on differences that are relevant.
61
-
62
48
### sort-swagger
63
-
64
49
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.
65
50
66
51
### generate-lock-file
67
52
68
53
Generate an emitter-package-lock.json under the eng/ directory based on existing `<repo-root>/eng/emitter-package.json`.
69
54
70
55
## Options
71
-
72
56
```
73
57
--arm Convert ARM swagger specification to TypeSpec [boolean]
74
58
-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
81
65
--save-inputs Don't clean up the temp directory after generation [boolean]
82
66
--skip-sync-and-generate Skip sync and generate during project init [boolean]
83
67
--swagger-readme Path or url to swagger readme file [string]
84
-
-o, --output-dir Specify an alternate output directory for the
68
+
-o, --output-dir Specify an alternate output directory for the
85
69
generated files. Default is your current directory [string]
86
-
--repo Repository where the project is defined for init
70
+
--repo Repository where the project is defined for init
87
71
or update [string]
88
72
-v, --version Show version number [boolean]
89
73
```
@@ -107,23 +91,22 @@ tsp-client update
107
91
## Important concepts
108
92
109
93
### Per project setup
110
-
111
94
Each project will need to have a configuration file called tsp-location.yaml that will tell the tool where to find the TypeSpec project.
112
95
113
96
#### tsp-location.yaml
114
97
115
-
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.
98
+
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.
116
99
117
100
> NOTE: This file should live under the project directory for each service.
| <aid="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|
124
-
| <aid="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 |
125
-
| <aid="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|
126
-
| <aid="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|
104
+
| Property | Description | IsRequired |
105
+
| --- | --- | --- |
106
+
| <aid="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 |
107
+
| <aid="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 |
108
+
| <aid="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 |
109
+
| <aid="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 |
127
110
128
111
Example:
129
112
@@ -152,6 +135,7 @@ See the following example of a valid tspconfig.yaml file: https://github.com/Azu
152
135
153
136
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/`.
154
137
138
+
155
139
### emitter-package.json (Required)
156
140
157
141
`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.
0 commit comments