d47cf58f10
This allows `ng.getDirectiveMetadata` to be implemented by Wiz and ACX with subtly different shapes to match the nuances of those frameworks.
Existing usage of `{Component,Directive}DebugMetadata` was moved over to `Angular{Component,Directive}DebugMetadata` as appropriate, since the implementation of `ng` in `@angular/core` is specific to Angular. Only the types support Wiz and ACX.
I opted to merge `ComponentDebugMetadata` and `DirectiveDebugMetadata` into a single type of all the frameworks including both components and directives (recall that components extend directives). The reasoning for this is because Wiz does not support directives (you can kind of think of "Wiz Directive" as an abstract class extended by "Wiz Components"). I felt that a `DirectiveDebugMetadata` containing only Angular and ACX types would be a bit of a trap and lead to bugs when used. It's safer to just have the single type containing all the possible results from `ng.getDirectiveMetadata`.
I also chose to leave the `ng` type as is internally, since `@angular/core` implements a specific concrete version of it narrowed to Angular types. Separately I defined an expanded `FrameworkAgnosticGlobalUtils` which redefines `ng.getDirectiveMetadata` to include Wiz and ACX. We want this type to exist in the Angular GitHub repo so it can be referenced as a common primitive across all three frameworks. This is sufficient for now, however longer term we will likely want to actually manually define the function types in this framework-agnostic interface and make Angular's version properly implement it rather than extend and overwrite Angular's type.
PR Close #60475
|
||
|---|---|---|
| .. | ||
| cypress | ||
| docs | ||
| projects | ||
| src | ||
| tools | ||
| .gitignore | ||
| BUILD.bazel | ||
| cypress.json | ||
| README.md | ||
| tsconfig.json | ||
| tsconfig.spec.json | ||
| tslint.json | ||
Angular DevTools
Angular DevTools is a browser DevTools extension for debugging and profiling Angular applications.
Developing Locally
Set up
Follow the instructions below to set up your Angular DevTools development
environment. Note that all commands should be executed in the repository root, not
devtools/. All file paths are also relative to the repository root.
Debian Linux, MacOS, and Windows via WSL should build successfully. Building natively on Windows without WSL is not supported at the moment.
To set up your development environment, first install the correct version of Node. If you have
nvm set up, this can be done with:
nvm install
Second, install Yarn:
npm install -g yarn@1
Third, install NPM dependencies:
yarn --frozen-lockfile
Now you should be ready to build the DevTools extension.
Dev builds
To run the extension in development mode run:
yarn devtools:devserver
You can also run a standalone version of the demo app with:
yarn devtools:devserver:demo-standalone
This would start a development server that you can access on http://localhost:4200. In development, Angular DevTools uses a "development shell." This is different from "chrome shell" in a way, that it runs the user's app in an iframe. DevTools then communicate with the user's app via message passing.
Release builds
You can build the release version of Angular DevTools for either Chrome or Firefox with:
yarn devtools:build:chrome
yarn devtools:build:firefox
Either way, the built extension will be at dist/bin/devtools/projects/shell-browser/src/prodapp.
Installation
For Chrome, you can install the extension from dist/bin/devtools/projects/shell-browser/src/prodapp by following the
guide from here.
For Firefox, to load the extension, you can go to the about:debugging page, click the "This Firefox" option and then
click the Load Temporary Add-on button. You'll have to select the manifest file in
dist/bin/devtools/projects/shell-browser/src/prodapp directly.