Matthieu Riegler
db5963797d
docs(docs-infra): Extract class constructors ( #60302 )
...
fixes #59180
PR Close #60302
2025-03-10 16:05:02 -07:00
Alan Agius
45f899a272
refactor: replace fast-glob usage with tinyglobby ( #60264 )
...
Usage of the `fast-glob` package has been replaced with the `tinyglobby` package. The change reduces the number of transitive dependencies related to these packages from 17 to 2 while also maintaining equivalent functionality. This was also changed in the Angular CLI packages.
PR Close #60264
2025-03-07 10:57:23 -08:00
Matthieu Riegler
aa1ab41e6c
docs(docs-infra): enable & fix tests ( #60220 )
...
PR Close #60220
2025-03-06 14:33:48 -08:00
Matthieu Riegler
286e4da52b
docs(docs-infra): Throw error at build time for invalid links ( #59162 )
...
PR Close #59162
2025-03-04 20:07:23 +00:00
hawkgs
2b114e784d
docs(docs-infra): API doc content rendering fixes ( #60116 )
...
The PR introduces a few doc content rendering fixes:
- Fix highlighted section heading styles (regression from #59965 ).
- Convert JSDoc links within 'Usage Notes' sections to HTML and render them.
- Add IDs to doc content headings. This, by itself, makes these headings available in the page ToC.
PR Close #60116
2025-03-04 17:46:30 +00:00
Miles Malerba
2e03a8685b
docs(docs-infra): Improve support for @link within the jsdoc. ( #60201 )
...
PR Close #60201
2025-03-04 17:13:42 +00:00
Matthieu Riegler
ba94f6f84f
docs(docs-infra): hide github link for external repos. ( #60114 )
...
fixes #60113
PR Close #60114
2025-03-04 17:02:37 +00:00
Charles Lyding
17c84e5a03
docs: use @angular/build directly in example/tutorial projects ( #60046 )
...
By using the `@angular/build` package directly within projects for each
example and tutorial, the total install size can be reduced. This lowers the amount
of time required to be spent setting up the dependencies in browser
before the example is displayed.
The `@angular/build@19.2.0-next.2` package currently has a total unpacked size of ~115 MB.
The `@angular-devkit/build-angular@19.2.0-next.2` package currently has a total unpacked size of ~291 MB.
This also removes the now unneeded `NG_BUILD_PARALLEL_TS=0` environment variable usage.
PR Close #60046
2025-02-24 10:14:17 -05:00
hawkgs
ea5b7371e5
docs(docs-infra): fix card highlighting in the API reference details page ( #59965 )
...
Drop `pointer-events: none` and update the member card highlighting mechanism.
PR Close #59965
2025-02-18 14:56:48 +00:00
Matthieu Riegler
c3e95ef1d5
docs(docs-infra): attemp to fix flaky mermaid test ( #59994 )
...
This test has 2 async parts, loading the markdown file and the marked parsing.
First attempt to fix the flakiness is by inline the markdown file.
If this test timeouts again in the future it means the timeout is related to marked itself (and the dynamic import of mermaid).
PR Close #59994
2025-02-18 14:55:49 +00:00
hawkgs
b6733eeea4
docs(docs-infra): drop tabs layout from the API reference details page ( #59068 )
...
Drop the tabs in favor of a single page separated by sections.
PR Close #59068
2025-02-13 14:58:33 +00:00
Matthieu Riegler
0d88463a66
docs(docs-infra): inline example in description ( #59908 )
...
fixes #59905
PR Close #59908
2025-02-12 09:21:49 -08:00
Matthieu Riegler
e4dd1773db
docs: update examples to the application builder ( #59539 )
...
fixes #59538
PR Close #59539
2025-01-16 08:08:36 -08:00
hawkgs
220608e4cc
docs(docs-infra): generate errors and extended-diagnostics route NavigationItem-s ( #59355 )
...
Generate the `NavigationItem`-s as part of adev/shared-docs pipeline and use the output JSON files instead of the hardcoded objects in the `sub-navigation-data.ts`.
PR Close #59355
2025-01-14 11:00:06 -05:00
Matthieu Riegler
fd073004bb
docs(docs-infra): fix entry labels. ( #59384 )
...
fixes #59382
PR Close #59384
2025-01-08 15:22:43 +00:00
RafaelJCamara
fabd642826
docs: update README to reflect correct Angular repository branch in rendering regions ( #59421 )
...
PR Close #59421
2025-01-08 15:22:07 +00:00
Matthieu Riegler
139f61913c
docs: remove data attributes from api-item-label ( #59273 )
...
Perf measurments have revealed that `data-*` attributes are slower to set than classes.
PR Close #59273
2025-01-06 16:03:42 +00:00
Matthieu Riegler
cf27cbb1f8
docs(docs-infra): remove costly localeCompare ( #59106 )
...
This function wasn't necessary, the items where already sorted.
fixes #59069d
PR Close #59106
2024-12-16 15:18:39 -08:00
Matthieu Riegler
f15ccb94b9
docs(docs-infra): enable tslint ( #58961 )
...
PR Close #58961
2024-12-05 16:03:35 -08:00
hawkgs
77a0ee85c1
feat(docs-infra): use angular-ts and angular-html shiki highlighting ( #59004 )
...
Use `angular-ts` instead of `typescript` and `angular-html` instead of `html`.
PR Close #59004
2024-12-04 18:05:59 +01:00
hawkgs
0a399e7f9c
refactor(docs-infra): update comments ( #59004 )
...
Add missing file header comments and update others.
PR Close #59004
2024-12-04 18:05:59 +01:00
hawkgs
c13528b1b9
test(docs-infra): interpolation mechanism ( #59004 )
...
Test all use cases that are supported by the interpolation mechanism.
PR Close #59004
2024-12-04 18:05:58 +01:00
hawkgs
d40967c356
fix(docs-infra): minor bug fixes ( #59004 )
...
Minor bug fixes found and implemented during testing.
PR Close #59004
2024-12-04 18:05:58 +01:00
hawkgs
b97b92024d
test(docs-infra): add initial test ( #59004 )
...
Setup the test suite and add the initial test.
PR Close #59004
2024-12-04 18:05:58 +01:00
hawkgs
9ca8ddb265
fix(docs-infra): markdown code block highlighting for the different file types ( #59004 )
...
Set the code block language highlighting based on the file type.
PR Close #59004
2024-12-04 18:05:58 +01:00
hawkgs
f13f52f70f
feat(docs-infra): remove redundant JSDoc transform related to code examples ( #59004 )
...
The transform is no longer relevant nor it served any functional purpose.
PR Close #59004
2024-12-04 18:05:58 +01:00
hawkgs
e1009f09c0
fix(docs-infra): handle regions overlap and multiple-regions examples ( #59004 )
...
It seems that there are overlapping region markers and an example can be composed by multiple regions.
PR Close #59004
2024-12-04 18:05:58 +01:00
hawkgs
e0beb27581
fix(docs-infra): interpolation script nesting ( #59004 )
...
Add support for nested #docregion-s and modify the examples caching.
PR Close #59004
2024-12-04 18:05:58 +01:00
hawkgs
8b93e3c90d
feat(docs-infra): implement interpolation script ( #59004 )
...
The script substitutes the JSDoc example tags with the respective code sample.
PR Close #59004
2024-12-04 18:05:58 +01:00
hawkgs
a4ee2d90e6
feat(docs-infra): include code examples files in the API gen ( #59004 )
...
The code examples in `package/examples` are now passed to the API JSON generator.
PR Close #59004
2024-12-04 18:05:58 +01:00
Matthieu Riegler
d0ea622040
docs(docs-infra): read jsdoctags from function overloads ( #58994 )
...
Functions like `linkedSignal` have there `@developerPreview` tags on the overload signature. This commit adds the support for them.
This commit also removes the logic for multiple entries, as now overloads are a single entry.
fixes #58817
PR Close #58994
2024-12-02 16:17:02 +01:00
kirjs
6ff53b7437
docs(docs-infra): Drop standalone: true ( #58914 )
...
This is now the default value, so safe to remove
PR Close #58914
2024-11-28 09:43:28 +01:00
Paul Gschwendtner
0ce15c6b5e
docs: update tutorials and playground to v19.0.0 ( #58742 )
...
Updates boilerplate for tutorial and playground to use v19
PR Close #58742
2024-11-19 17:26:47 +00:00
Alan Agius
c2a9b75045
fix(docs-infra): retain function keyword in API definitions ( #58561 )
...
**Before:**
```ts
animate(
timings: string | number,
styles?: AnimationStyleMetadata | AnimationKeyframesSequenceMetadata | null
): AnimationAnimateMetadata;
```
**Now:**
```ts
function animate(
timings: string | number,
styles?: AnimationStyleMetadata | AnimationKeyframesSequenceMetadata | null
): AnimationAnimateMetadata;
```
PR Close #58561
2024-11-08 17:16:04 +00:00
Alan Agius
d271c4422a
fix(compiler-cli): correct extraction of generics from type aliases ( #58548 )
...
**Before:**
```ts
type HttpEvent = | HttpSentEvent
| HttpHeaderResponse
| HttpResponse<T>
| HttpProgressEvent
| HttpUserEvent<T>
```
**After:**
```ts
type HttpEvent<T> = | HttpSentEvent
| HttpHeaderResponse
| HttpResponse<T>
| HttpProgressEvent
| HttpUserEvent<T>
```
PR Close #58548
2024-11-08 17:15:06 +00:00
Alan Agius
c95aca1f17
docs(docs-infra): update default generic values and add constraints for type parameters in functions ( #58548 )
...
Before
```typescript
createNodeRequestHandler(
handler: T
): T;
```
```typescript
class NgIf<T> {
@Input() set ngIf(value: T);
@Input() set ngIfThen(value: TemplateRef<NgIfContext<T>> | null);
@Input() set ngIfElse(value: TemplateRef<NgIfContext<T>> | null);
static ngTemplateGuard_ngIf: "binding";
static ngTemplateContextGuard<T>(dir: NgIf<T>, ctx: any): boolean;
}
```
Now
```typescript
createNodeRequestHandler<T extends NodeRequestHandlerFunction>(
handler: T
): T;
```
```typescript
class NgIf<T = unknown> {
@Input() set ngIf(value: T);
@Input() set ngIfThen(value: TemplateRef<NgIfContext<T>> | null);
@Input() set ngIfElse(value: TemplateRef<NgIfContext<T>> | null);
static ngTemplateGuard_ngIf: "binding";
static ngTemplateContextGuard<T>(dir: NgIf<T>, ctx: any): boolean;
}
```
PR Close #58548
2024-11-08 17:15:06 +00:00
Alan Agius
3ecf0f6701
docs: add hybrid rendering API guide ( #58445 )
...
This commit introduces a new guide for hybrid rendering APIs, which are currently in developer preview. This documentation provides insights into the usage and features of the APIs, helping developers understand their capabilities and limitations during the preview phase.
PR Close #58445
2024-11-07 21:28:54 +00:00
Alan Agius
c5ce302e0b
docs(docs-infra): add support for @remarks ( #58523 )
...
In TSDoc, we currently handle the `@usageNotes` annotation, but this is not a standard TSDoc tag. Instead, the `@remarks` annotation is the correct standard, which is used in the Angular CLI repo and on the SSR package.
This change ensures that `@remarks` is treated the same as `@usageNotes` during the transform process.
PR Close #58523
2024-11-07 15:49:13 +00:00
Matthieu Riegler
c1aa9c6041
docs(docs-infra): fix CLI commands ( #58294 )
...
With this commit the CLI doc will display the correct arguments for the subcommands
fixes #58279
PR Close #58294
2024-10-22 07:42:21 -07:00
Matthieu Riegler
bb0edaded0
docs(docs-infra): Add NgModule exports for directives. ( #58071 )
...
This information is extracted from the @NgModule Jsdoc tag.
fixes #57906
PR Close #58071
2024-10-04 14:46:16 -07:00
Alan Agius
8f73199e9f
fix(docs-infra): update getAnswerFiles to ensure compatibility with non-POSIX file systems ( #57970 )
...
This update modifies the `getAnswerFiles` function to support file systems that do not adhere to POSIX standards.
Prior to this change this method will always fail with the below:
```
Error: Invalid state: could not find start of answers path
```
PR Close #57970
2024-09-26 14:29:44 -07:00
Joey Perrott
af66e2475d
fix(docs-infra): extend the timeout for jasmine tests of mermaid ( #57948 )
...
Extend the timeout because mermaid takes too long for the default.
PR Close #57948
2024-09-24 13:02:52 -07:00
Joey Perrott
9dbe6fc18b
refactor: update license text to point to angular.dev ( #57901 )
...
Update license text to point to angular.dev instead of angular.io
PR Close #57901
2024-09-24 15:33:00 +02:00
Alan Agius
eb5651fe98
fix(docs-infra): resolve Mermaid from Bazel root path ( #57924 )
...
This update addresses a build failure on Windows caused by the previous method, which was incompatible with the Windows environment.
Closes #57920
PR Close #57924
2024-09-23 17:20:53 +02:00
Matthieu Riegler
49f7179ded
docs(docs-infra): Add dedicated support for decorators. ( #57595 )
...
PR Close #57595
2024-09-19 14:16:31 -07:00
Matthieu Riegler
dbdd7875dd
docs: Enable direct links to class/interface methods for @link ( #57615 )
...
PR Close #57615
2024-09-06 16:03:36 +00:00
Matthieu Riegler
9624ab03c9
docs(docs-infra): fix extraction tests ( #57694 )
...
PR Close #57694
2024-09-06 15:07:47 +00:00
Matthieu Riegler
1698bd3ed8
refactor(compiler-cli): Do extract symbols from private modules. ( #57611 )
...
Modules like `core/primitives` are considered private and their symbols shouldn't be exposed nor linked in the docs.
PR Close #57611
2024-09-06 14:15:18 +00:00
Matthieu Riegler
e3919e7b9d
docs: display property details ( #57622 )
...
In case there are no signatures (like in an bare interface method), we display the implementation information.
PR Close #57622
2024-09-05 17:22:32 +00:00
Matthieu Riegler
1b7571f404
docs(docs-infra): enable tests for api-gen ( #57618 )
...
PR Close #57618
2024-09-05 14:05:04 +00:00