Skip to content

Commit c12d368

Browse files
committed
docs: Minor fixes
1 parent fc1e659 commit c12d368

3 files changed

Lines changed: 12 additions & 12 deletions

File tree

rfcs/0020-npm-package-integration.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
- Issue: -
44
- Affected components
55
+ [X] [ui5-builder](../packages/builder)
6-
+ [X] [ui5-server](../packages/server)
6+
+ [ ] [ui5-server](../packages/server)
77
+ [ ] [ui5-cli](../packages/cli)
88
+ [ ] [ui5-fs](../packages/fs)
99
+ [X] [ui5-project](../packages/project)
@@ -13,7 +13,7 @@
1313

1414
## 1. Summary
1515

16-
Enable seamless integration of NPM packages (ESM, CJS, and UI5 Web Components) into UI5 applications and libraries by providing a built-in standard task and middleware that automatically transforms packages from their native format to UI5's AMD module format using Rollup.js.
16+
Enable seamless integration of NPM packages (ESM, CJS, and UI5 Web Components) into UI5 applications and libraries by providing a built-in standard build task that automatically transforms packages from their native format to UI5's AMD module format using Rollup.js.
1717

1818
This RFC focuses on the implementation mechanics:
1919

@@ -52,7 +52,7 @@ UI5 applications face significant challenges when consuming NPM packages:
5252

5353
- **Out-of-the-Box Integration** — NPM packages work without configuration
5454
- **Build-Time Transformation** — Automatic bundling during `ui5 build`
55-
- **Dev-Time Support** — On-demand bundling during `ui5 serve`
55+
- **Dev-Time Support** — On-demand bundling during `ui5 serve` (deferred to [RFC 0017 Incremental Build](https://github.com/UI5/cli/blob/rfc-incremental-build/rfcs/0017-incremental-build.md))
5656
- **Standard Compliance** — Output follows UI5's AMD module format and naming conventions
5757
- **Web Component Support** — First-class `@ui5/webcomponents` integration with UI5 control wrappers
5858
- **Performance Optimization** — Package independence enables deduplication and browser caching
@@ -299,7 +299,7 @@ The NPM bundling task integrates into the existing build pipeline as a standard
299299

300300
![NPM Build Task Diagram](./resources/0020-npm-integration/build-task-sequence.svg)
301301

302-
**Why after `generateBundle`?** The scanner needs all source resources to be resolved and available. **Why before `generateComponentPreload`?** The generated NPM bundles must be included in the Component-preload.js for production deployment.
302+
**Why after `generateFlexChangesBundle`?** The scanner needs all source resources to be resolved and available. **Why before `generateComponentPreload`?** The generated NPM bundles must be included in the Component-preload.js for production deployment.
303303

304304
#### 3.6.2 Task Interface
305305

@@ -697,7 +697,7 @@ Patches are expected to be **temporary**. The recommended lifecycle:
697697
- Mitigation: Incremental builds (RFC 0017) will avoid rebundling unchanged packages
698698

699699
4. **Complexity** — External dependency management requires understanding
700-
- Mitigation: Auto-detection from `peerDependencies` in most cases; clear error messages
700+
- Mitigation: Auto-detection via transitive dependency consolidation ([Section 3.8.3](#383-externals-discovery-via-transitive-dependency-consolidation)); clear error messages
701701

702702
---
703703

rfcs/resources/0020-npm-integration/build-task-sequence.drawio

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
<mxfile host="65bd71144e">
22
<diagram name="Build Task Sequence" id="build-task-sequence">
3-
<mxGraphModel dx="1400" dy="1000" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="1169" pageHeight="1654" math="0" shadow="0">
3+
<mxGraphModel dx="752" dy="399" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="1169" pageHeight="1654" math="0" shadow="0">
44
<root>
55
<mxCell id="0"/>
66
<mxCell id="1" parent="0"/>
77
<mxCell id="11" value="ui5 build" style="rounded=1;arcSize=10;whiteSpace=wrap;html=1;fillColor=#FFFFFF;strokeColor=#000000;strokeWidth=1.5;" parent="1" vertex="1">
88
<mxGeometry x="80" y="80" width="180" height="40" as="geometry"/>
99
</mxCell>
10-
<mxCell id="12" value="generateBundle" style="rounded=1;arcSize=10;whiteSpace=wrap;html=1;fillColor=#FFFFFF;strokeColor=#000000;strokeWidth=1.5;" parent="1" vertex="1">
10+
<mxCell id="12" value="generateFlexChangesBundle" style="rounded=1;arcSize=10;whiteSpace=wrap;html=1;fillColor=#FFFFFF;strokeColor=#000000;strokeWidth=1.5;" parent="1" vertex="1">
1111
<mxGeometry x="320" y="80" width="180" height="40" as="geometry"/>
1212
</mxCell>
1313
<mxCell id="13" value="bundleNpmPackages (NEW)" style="rounded=1;arcSize=10;whiteSpace=wrap;html=1;fillColor=#FFFFFF;strokeColor=#000000;strokeWidth=1.5;" parent="1" vertex="1">
@@ -105,7 +105,7 @@
105105
<mxCell id="38" value="Write to workspace (resources/thirdparty/*.js)" style="rounded=1;arcSize=10;whiteSpace=wrap;html=1;fillColor=#FFFFFF;strokeColor=#000000;" parent="1" vertex="1">
106106
<mxGeometry x="520.5" y="496" width="300" height="36" as="geometry"/>
107107
</mxCell>
108-
<mxCell id="44" value="For each package/entry" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;endArrow=classic;endFill=1;strokeColor=#000000;align=center;verticalAlign=bottom;entryX=1;entryY=0.5;entryDx=0;entryDy=0;" parent="1" edge="1" target="46" source="48">
108+
<mxCell id="44" value="For each package/entry" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;endArrow=classic;endFill=1;strokeColor=#000000;align=center;verticalAlign=bottom;entryX=1;entryY=0.5;entryDx=0;entryDy=0;" parent="1" source="48" target="46" edge="1">
109109
<mxGeometry x="-0.0509" relative="1" as="geometry">
110110
<mxPoint x="670" y="390" as="targetPoint"/>
111111
<mxPoint x="671" y="540" as="sourcePoint"/>
@@ -116,16 +116,16 @@
116116
<mxPoint as="offset"/>
117117
</mxGeometry>
118118
</mxCell>
119-
<mxCell id="47" value="" style="endArrow=none;dashed=1;strokeWidth=1.5;strokeColor=#000000;" edge="1" parent="1" source="13" target="46">
119+
<mxCell id="47" value="" style="endArrow=none;dashed=1;strokeWidth=1.5;strokeColor=#000000;" parent="1" source="13" target="46" edge="1">
120120
<mxGeometry relative="1" as="geometry">
121121
<mxPoint x="670" y="120" as="sourcePoint"/>
122122
<mxPoint x="670" y="760" as="targetPoint"/>
123123
</mxGeometry>
124124
</mxCell>
125-
<mxCell id="46" value="" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;fillColor=#000000;strokeColor=#000000;" vertex="1" parent="1">
125+
<mxCell id="46" value="" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;fillColor=#000000;strokeColor=#000000;" parent="1" vertex="1">
126126
<mxGeometry x="665.5" y="380" width="10" height="10" as="geometry"/>
127127
</mxCell>
128-
<mxCell id="48" value="" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;fillColor=#000000;strokeColor=#000000;" vertex="1" parent="1">
128+
<mxCell id="48" value="" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;fillColor=#000000;strokeColor=#000000;" parent="1" vertex="1">
129129
<mxGeometry x="665.5" y="540" width="10" height="10" as="geometry"/>
130130
</mxCell>
131131
</root>

0 commit comments

Comments
 (0)