TypeSpec Validation

Running Locally

To ensure you see the same results from TypeSpecValidation in your PR check and tsv on your local machine:

1. Merge latest from parent (e.g. main or RPSaaSMaster) to your PR branch
2. Run locally
   1. git clean -xdf (may revert any local changes)
   2. git pull
   3. npm ci
3. npx tsv ...
4. If you are still having problems, try cloning your branch to a new folder, or try on another machine.
5. If the problem can be reproduced on a clean machine, request assistance from the TypeSpec Discussion teams channel.

Examples

If you are having problems with diffs from "tsp compile" related to examples, ensure you understand how examples flow from source to destination.

The source of examples is under your TypeSpec source code folder, and the destination of examples is under the Swagger folder. The TypeSpec compiler copies from source to destination. In our sample:

• source
  • https://github.com/Azure/azure-rest-api-specs/tree/main/specification/contosowidgetmanager/Contoso.Management/examples/2021-10-01-preview
• destination
  • https://github.com/Azure/azure-rest-api-specs/tree/main/specification/contosowidgetmanager/resource-manager/Microsoft.Contoso/preview/2021-10-01-preview/examples

If you are changing examples, you must first change the copy under your TypeSpec folder, and then run tsp compile (or tsv which calls compile) to update the copies in your Swagger folder.