Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 12 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,13 +88,13 @@ at a time in the IDE.

- Terminal -> Run Build Task (`Ctrl+Shift+B`)

This will setup a an incremental watching build for the whole
This will setup an incremental watching build for the whole
repo. From there on, your changes will be built whenever you save.

Problems will be reported in the Problems pane automatically and the
Terminal pane will have three parallel watch tasks running:

- `watch-source`: tsc process that recompile on TypeScript changes
- `watch-source`: tsc process that recompiles on TypeScript changes
- `watch-spec`: process that regenerates spec.html when
spec.emu.html changes
- `watch-tmlanguage`: process that regenerates typespec.tmlanguage when
Expand All @@ -106,14 +106,14 @@ Terminal pane will have three parallel watch tasks running:
# Run all the tests
pnpm test

# Run in a specific package tests in watch mode
# Run tests in a specific package in watch mode
pnpm test:watch
```

### Debugging

There are several "Run and Debug" tasks set up. Click on the Run and
Debug icon on the sidebar, pick one from its down, and press F5 to
Debug icon on the sidebar, pick one from its dropdown, and press F5 to
debug the last one you chose.

1. **VS Code Extension**: This will run and debug an experimental
Expand All @@ -127,6 +127,7 @@ debug the last one you chose.
there to experiment and debug how the compiler reacts.
3. **Compile Scratch (nostdlib)**: Same as above, but skips parsing
and evaluating the TypeSpec standard library. Sometimes it's easier to
debug without it.
4. **Attach to Default Port**: Use this to attach to a manually run
`node --debug` command.
5. **Attach to Language Server**: Use this to attach to the language
Expand Down Expand Up @@ -170,7 +171,7 @@ changes after you make them.
- Click on the play icon in the toolbar or press `F5`

This will run and debug an experimental instance of VS with a version
of the TypeSpec extension for VS Code running live with any of your changes
of the TypeSpec extension for VS running live with any of your changes
to the extension or the TypeSpec language server.

The VS debugger will attach only to the VS client process. Use "Attach
Expand Down Expand Up @@ -206,7 +207,7 @@ that gets produced.

### Run locally

Go to `packages/website` and run the command:
Go to `website` and run the command:

```bash
pnpm start
Expand Down Expand Up @@ -392,15 +393,15 @@ Labels are configured in `eng/common/config/labels.ts`. To update labels, edit t

# TypeSpec Emitters

The various language emitters will live in the in the repo under the following directory structure
The various language emitters will live in the repo under the following directory structure

- `packages/{protocol}-{client|server}-{language}` - Contains the `@typespec/{protocol}-{client|server}-{language}` package which is intended to be consumed by customers in their tsconfig.yaml file.
- `packages/{protocol}-{client|server}-{language}-generator` - Contains the `@typespec/{protocol}-{client|server}-{language}-generator` package which is the backend implementation of for a given emitter and usually contains code
- `packages/{protocol}-{client|server}-{language}-generator` - Contains the `@typespec/{protocol}-{client|server}-{language}-generator` package which is the backend implementation for a given emitter and usually contains code
languages such as .NET, Python, or Java. This package is only intended to be used as a dependency of the root emitter package.
- `packages/{protocol}-{client|server}-{language}-generator\**` - This directory will contain whatever is needed to build the backend emitter code generator. It will contain whatever folder structure is needed to build
that specific native code. It will also contain an isolated ci.yml file which will be the build pipeline for this package.

There is a goal to be able to ship these emitter packages independent from the rest of the packages in this repo as such they by default be excluded from the root pnpm workspace. Any npm package work
will be isolated to those directories with a goal of eventually moving to a consistent model so that we can both work in isolation as well as work as a E2E.
There is a goal to be able to ship these emitter packages independent from the rest of the packages in this repo as such they will by default be excluded from the root pnpm workspace. Any npm package work
will be isolated to those directories with a goal of eventually moving to a consistent model so that we can both work in isolation as well as work as an E2E.

For language specific contributing information look for the contributing.md file in that specific lanague emitter folder.
For language specific contributing information look for the contributing.md file in that specific language emitter folder.
2 changes: 1 addition & 1 deletion packages/http-client-java/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ npm install [path-to-typespec-http-client-java-tgz]

## End-to-end Tests

There is 2 end-to-end test modules:
There are 2 end-to-end test modules:

- `packages/http-client-java/generator/http-client-generator-clientcore-test` for testing of unbranded code
- `packages/http-client-java/generator/http-client-generator-test` for testing of branded code
Expand Down
Loading