chore: generate breaking changes docs #21062
Conversation
…ging' to 'augmented-types'
|
Explanation of weird changes: Changed paths in scripts was necessary, as clone.sh generated /src/ folder in root of project instead of tools/breaking-changes Another thing that confused me was the errors thrown due to a missing comma at the end of a property in api-extractor.json, which seems absurd (or a leading space in a comment on the next line). |
| - `/tools/breaking-changes/extract-bundled.ts` - Added normalization, rewrote token generation | ||
| - `/tools/breaking-changes/parse.ts` - Added normalization and validation | ||
| - `/tools/breaking-changes/common.ts` - Updated TypeAlias rendering | ||
| - `/tools/breaking-changes/package.json` - Added `validate` and `test` scripts |
There was a problem hiding this comment.
| - `/tools/breaking-changes/package.json` - Added `validate` and `test` scripts |
|
|
||
| // Skip public_api.d.ts files as they are re-exports | ||
| if (fileName === 'public_api') { | ||
| return '@spartacus/unknown'; |
| previousNode: 'SubscriptionBillingEventModule', | ||
| previousImportPath: '@spartacus/subscription-billing/root', | ||
| newImportPath: '@spartacus/subscription/billing/root', |
There was a problem hiding this comment.
[MAJOR]
There is no such entrypoint like @spartacus/subscription/billing/root in Spartacus libs.
How it's possible such a fake newImportPath is in our scripts' output?
Note: this comment applies to all libs that had - in their pacakge name, .e.g @spartacus/product-configurator is NOT moved now to @spartacus/product/configurator
| { | ||
| node: 'ICON_TYPE', | ||
| importPath: '@spartacus/storefront', | ||
| comment: | ||
| '// TODO:Spartacus - Enum ICON_TYPE has been removed and is no longer part of the public API. ', | ||
| }, |
There was a problem hiding this comment.
[MAJOR]
ICON_TYPE is still part of the @spartacus/storefront api. And there was no intention to remove it.
I guess the generated output in this file might be incorrect also in other places
Closes CXSPA-11884