Skip to content
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.

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

fix(router-plugin): expose NGXS_ROUTER_PLUGIN_OPTIONS privately #2037

Merged
merged 1 commit into from
Jul 23, 2023

Conversation

arturovt
Copy link
Member

@arturovt arturovt commented Jul 17, 2023

This PR exposes some of the internal tokens used inside the Router Plugin in an internals sub-package and with the barred-oh variable name to indicate its private nature. This approach is used because this API is not part of an "official" API that has been committed to by the library and could be changed (within reason) at some point in the future, without being marked as a "breaking change", although this would most likely still be limited to a minor version change to the library.

These tokens have been exposed in order to resolve the reasonable extensibility needs that were raised in PR #2030.

@arturovt arturovt marked this pull request as ready for review July 17, 2023 19:47
@bundlemon
Copy link

bundlemon bot commented Jul 17, 2023

BundleMon

Unchanged files (3)
Status Path Size Limits
fesm2015/ngxs-store.js
94.47KB 125KB / +0.5%
fesm2015/ngxs-store-operators.js
6.23KB 15KB / +0.5%
fesm2015/ngxs-store-internals.js
3.57KB 20KB / +0.5%

No change in files bundle size

Unchanged groups (3)
Status Path Size Limits
@ngxs/store(esm2015)[gzip]
./esm2015/**/*.js
180.26KB +1%
@ngxs/store(umd)[gzip]
./bundles/*.umd.js
36.55KB +1%
@ngxs/store(fesm2015)[gzip]
./fesm2015/*.js
25.02KB +1%

Final result: ✅

View report in BundleMon website ➡️


Current branch size history | Target branch size history

@bundlemon
Copy link

bundlemon bot commented Jul 17, 2023

BundleMon (NGXS Plugins)

Files added (2)
Status Path Size Limits
Plugins(umd)[gzip]
router-plugin/bundles/ngxs-router-plugin-inte
rnals.umd.js
+654B +1%
Plugins(fesm2015)[gzip]
router-plugin/fesm2015/ngxs-router-plugin-int
ernals.js
+406B +1%
Files updated (2)
Status Path Size Limits
Plugins(umd)[gzip]
router-plugin/bundles/ngxs-router-plugin.umd.
js
7.35KB (-67B -0.88%) +1%
Plugins(fesm2015)[gzip]
router-plugin/fesm2015/ngxs-router-plugin.js
3.01KB (-84B -2.65%) +1%
Unchanged files (12)
Status Path Size Limits
Plugins(umd)[gzip]
storage-plugin/bundles/ngxs-storage-plugin.um
d.js
7.97KB +1%
Plugins(umd)[gzip]
websocket-plugin/bundles/ngxs-websocket-plugi
n.umd.js
6.92KB +1%
Plugins(umd)[gzip]
hmr-plugin/bundles/ngxs-hmr-plugin.umd.js
6.89KB +1%
Plugins(fesm2015)[gzip]
storage-plugin/fesm2015/ngxs-storage-plugin.j
s
3.7KB +1%
Plugins(umd)[gzip]
form-plugin/bundles/ngxs-form-plugin.umd.js
3.44KB +1%
Plugins(umd)[gzip]
devtools-plugin/bundles/ngxs-devtools-plugin.
umd.js
2.75KB +1%
Plugins(fesm2015)[gzip]
form-plugin/fesm2015/ngxs-form-plugin.js
2.67KB +1%
Plugins(fesm2015)[gzip]
hmr-plugin/fesm2015/ngxs-hmr-plugin.js
2.65KB +1%
Plugins(fesm2015)[gzip]
websocket-plugin/fesm2015/ngxs-websocket-plug
in.js
2.59KB +1%
Plugins(umd)[gzip]
logger-plugin/bundles/ngxs-logger-plugin.umd.
js
2.53KB +1%
Plugins(fesm2015)[gzip]
devtools-plugin/fesm2015/ngxs-devtools-plugin
.js
2.17KB +1%
Plugins(fesm2015)[gzip]
logger-plugin/fesm2015/ngxs-logger-plugin.js
2.01KB +1%

Total files change +909B +1.56%

Groups updated (3)
Status Path Size Limits
All Plugins(esm2015)[gzip]
./-plugin/esm2015/**/.js
110.55KB (+1.07KB +0.97%) +1%
All Plugins(umd)[gzip]
./-plugin/bundles/.umd.js
38.49KB (+587B +1.51%) +1%
All Plugins(fesm2015)[gzip]
./-plugin/fesm2015/.js
19.2KB (+322B +1.67%) +1%

Final result: ❌

View report in BundleMon website ➡️


Current branch size history | Target branch size history

@bundlemon
Copy link

bundlemon bot commented Jul 17, 2023

BundleMon (Integration Projects)

Files updated (2)
Status Path Size Limits
Main bundles(Gzip)
hello-world-ng14-ivy/dist-integration/main.(h
ash).js
64.81KB (-13B -0.02%) +1%
Main bundles(Gzip)
hello-world-ng13-ivy/dist-integration/main.(h
ash).js
69.81KB (-28B -0.04%) +1%
Unchanged files (1)
Status Path Size Limits
Main bundles(Gzip)
hello-world-ng12-ivy/dist-integration/main.(h
ash).js
67.96KB +1%

Total files change -51B -0.02%

Final result: ✅

View report in BundleMon website ➡️


Current branch size history | Target branch size history

@nx-cloud
Copy link

nx-cloud bot commented Jul 17, 2023

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 09bd789. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch


✅ Successfully ran 3 targets

Sent with 💌 from NxCloud.

@arturovt arturovt force-pushed the fix/router-expose-options branch 4 times, most recently from bf8cd79 to ba1f8cd Compare July 20, 2023 14:24
@codeclimate
Copy link

codeclimate bot commented Jul 23, 2023

Code Climate has analyzed commit 09bd789 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 96.7% (0.0% change).

View more on Code Climate.

@arturovt arturovt merged commit 22b962e into master Jul 23, 2023
18 checks passed
@arturovt arturovt deleted the fix/router-expose-options branch July 23, 2023 18:57
@markwhitfeld markwhitfeld added this to the v.18.0.0 milestone Jun 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🚀[FEATURE]: [router-plugin] - export symbols for better extendability
2 participants