New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(ivy): add better documentation around debugging ivy tests #25432
Conversation
14595bb
to
34323c5
Compare
docs/BAZEL.md
Outdated
See also: [`./src/ivy_switch.ts`](https://github.com/angular/angular/blob/master/packages/core/src/ivy_switch.ts) for more details. | ||
|
||
- `--config=debug`: build and launch in debug mode (see [debugging](#debugging) instructions below) | ||
- `--define=compile=<option>` Controls if ivy or legacy mode is enabled. This is down by generating the [`src/ivy_switch.ts`](https://github.com/angular/angular/blob/master/packages/core/src/ivy_switch.ts) file from [`ivy_switch_legacy.ts`](https://github.com/angular/angular/blob/master/packages/core/src/ivy_switch_legacy.ts) (default), [`ivy_switch_jit.ts`](https://github.com/angular/angular/blob/master/packages/core/src/ivy_switch_jit.ts), or [`ivy_switch_local.ts`](https://github.com/angular/angular/blob/master/packages/core/src/ivy_switch_local.ts). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is down -> This is done
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks.
docs/BAZEL.md
Outdated
|
||
- `--config=debug`: build and launch in debug mode (see [debugging](#debugging) instructions below) | ||
- `--define=compile=<option>` Controls if ivy or legacy mode is enabled. This is down by generating the [`src/ivy_switch.ts`](https://github.com/angular/angular/blob/master/packages/core/src/ivy_switch.ts) file from [`ivy_switch_legacy.ts`](https://github.com/angular/angular/blob/master/packages/core/src/ivy_switch_legacy.ts) (default), [`ivy_switch_jit.ts`](https://github.com/angular/angular/blob/master/packages/core/src/ivy_switch_jit.ts), or [`ivy_switch_local.ts`](https://github.com/angular/angular/blob/master/packages/core/src/ivy_switch_local.ts). | ||
- `legacy`: (default behavior) compile against legacy renderer, e.g. `--define=compile=legacy` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"legacy renderer` -> "View Engine" ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks.
docs/BAZEL.md
Outdated
- `local`: Compile in ivy AOT move, e.g. `--define=compile=local` | ||
- `--test_tag_filters=<tag>`: filter tests down to tags defined in the `tag` config | ||
of your rules in any given `BUILD.bazel`. | ||
- `ivy-jit`: Only run tests that have to do with ivy JIT, e.g. `--test_tag_filters=ivy-jit`, e.g. `--test_tag_filters=ivy-local`. For this, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change "Only run tests that have to do with ivy JIT" to "This flag should be set for tests that should be excuted with ivy JIT" ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yup. There were other issues there too.
docs/BAZEL.md
Outdated
@@ -107,6 +129,7 @@ First time setup: | |||
}, | |||
``` | |||
|
|||
** Setting breakpoints directly in your code files may not work in VSCode**. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why ? / what should I do then ?
(Do you refer to the fact that bkpoints should be added to built file in /private/...
?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah... I'm not sure what to put there... people should add debugger
statements to get it to stop at the right spot.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay, updated.
docs/BAZEL.md
Outdated
|
||
See also: [`//tools/bazel.rc`](https://github.com/angular/angular/blob/master/tools/bazel.rc) where `--define=ivy=false` is defined as default. | ||
|
||
See also: [`./src/ivy_switch.ts`](https://github.com/angular/angular/blob/master/packages/core/src/ivy_switch.ts) for more details. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Aren't comments in ./src/ivy_switch.ts
outdated ? Shouldn't that file refer to here ? (and the same for the bazel files)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yup... updating that.
You can preview 6f51918 at https://pr25432-6f51918.ngbuilds.io/. |
You can preview 26adfd2 at https://pr25432-26adfd2.ngbuilds.io/. |
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
Updating docs.
What is the current behavior?
Issue Number: N/A
What is the new behavior?
Does this PR introduce a breaking change?
Other information
Just adding more information about build flags and the like.