Skip to content

Update website to include information about the "includeForgottenExports" settings #51

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.

Sign up for GitHub

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

Merged
octogonz merged 2 commits into from
Sep 12, 2022
Merged

Update website to include information about the "includeForgottenExports" settings #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8cbc29e
Update docs
zelliott Sep 8, 2022
defb859
Simplify hyperlink
octogonz Sep 12, 2022
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
30 changes: 30 additions & 0 deletions pages/configs/api-extractor_json.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,6 +299,21 @@ If they are different, a production build will fail.
The path is resolved relative to the folder of the config file that contains the setting; to change this,
prepend a folder token such as `<projectFolder>`.

### apiReport.includeForgottenExports

Example:
```js
"apiReport": {
. . .
"includeForgottenExports": true,
. . .
}
```

**Default value:** `false`

Whether "forgotten exports" should be included in the API report file. Forgotten exports are declarations
flagged with [ae-forgotten-export]({% link pages/messages/ae-forgotten-export.md %}) warnings.


## Doc Model Section
Expand Down Expand Up @@ -339,6 +354,21 @@ The output path for the doc model file. The file extension should be `.api.json
The path is resolved relative to the folder of the config file that contains the setting; to change this,
prepend a folder token such as `<projectFolder>`.

### docModel.includeForgottenExports

Example:
```js
"docModel": {
. . .
"includeForgottenExports": true,
. . .
}
```

**Default value:** `false`

Whether "forgotten exports" should be included in the doc model file. Forgotten exports are declarations
flagged with [ae-forgotten-export]({% link pages/messages/ae-forgotten-export.md %}) warnings.


## .d.ts Rollup Section
Expand Down
10 changes: 5 additions & 5 deletions pages/messages/ae-missing-release-tag.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ title: ae-missing-release-tag
navigation_source: docs_nav
---

*"___ is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)."*
*"___ is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)."*

## Remarks

API Extractor uses release tags to track the maturity of your API. By default, it requires every exported
declaration to have a release tag.
API Extractor uses release tags to track the maturity of your API. By default, it requires every declaration
in your API to have a release tag.

Example:

Expand All @@ -23,7 +23,7 @@ export class Widget { // <-- missing release tag
}
}

// Warning: "Widget" is exported by the package, but it is missing
// Warning: "Widget" is part of the package's API, but it is missing
// a release tag (@alpha, @beta, @public, or @internal)
```

Expand Down Expand Up @@ -51,7 +51,7 @@ has several benefits:
not be able to see the entry point, but the release tag clearly signals that this class should get special
attention. It is part of your API signature.

- When adding a new export, choosing a release tag requires the person to stop and think about visibility: How mature
- When adding a new API, choosing a release tag requires the person to stop and think about visibility: How mature
is this API design? Should it really be `@public`, or should we maybe start with `@alpha` or `@beta`?

- It avoids accidents. For example, it might be embarrassing to be browsing your API web site one day, and
Expand Down