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

refactor: move metadata into internals #2062

Merged
merged 1 commit into from
Mar 11, 2024
Merged

Conversation

arturovt
Copy link
Member

@arturovt arturovt commented Sep 25, 2023

This commit includes several updates:

  1. Moves metadata interfaces and functions to the
    @ngxs/store/internals subpackage.
  2. Transfers interfaces and objects from plugin_api.ts to the
    @ngxs/store/plugins subpackage.
  3. Adds the @deprecated annotation to functions and types that were
    exported from public_to_deprecate.ts.

@nx-cloud
Copy link

nx-cloud bot commented Sep 25, 2023

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 3222457. 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.

@bundlemon
Copy link

bundlemon bot commented Sep 25, 2023

BundleMon (Integration Projects)

Files updated (2)
Status Path Size Limits
Main bundles(Gzip)
hello-world-ng17/dist-integration/main.(hash)
.js
68.28KB (-90B -0.13%) +1%
Main bundles(Gzip)
hello-world-ng16/dist-integration/main.(hash)
.js
66.75KB (-127B -0.19%) +1%

Total files change -217B -0.16%

Final result: ✅

View report in BundleMon website ➡️


Current branch size history | Target branch size history

@arturovt arturovt force-pushed the refactor/move-metadata branch 7 times, most recently from 7b6aae7 to 3222457 Compare October 1, 2023 19:22
@arturovt arturovt marked this pull request as ready for review October 1, 2023 19:22
@@ -28,7 +28,7 @@ function areArgumentsShallowlyEqual(
*
* @ignore
*/
export function memoize<T extends (...args: any[]) => any>(
export function ɵmemoize<T extends (...args: any[]) => any>(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be aliased with the barred-o in the internals package exports as opposed to internally within the package?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we could make all of the namings without barred-o and re-export them with ɵ, but this package is 'exports-only', which means it only exports the stuff which is used outside. As thus I'm guessing this would've been an extra code.

ɵMETA_OPTIONS_KEY,
ɵSELECTOR_META_KEY
} from './symbols';
export * from './symbols';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are exposing a lot more here than originally intended.
Do we have an option to not expose so much?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything which is exported from there is used outside.

This commit includes several updates:

1) Moves metadata interfaces and functions to the
`@ngxs/store/internals` subpackage.
2) Transfers interfaces and objects from `plugin_api.ts` to the
`@ngxs/store/plugins` subpackage.
3) Adds the `@deprecated` annotation to functions and types that were
exported from `public_to_deprecate.ts`.
@arturovt arturovt force-pushed the refactor/move-metadata branch from 3222457 to 25a5a4d Compare March 11, 2024 20:29
Copy link

nx-cloud bot commented Mar 11, 2024

☁️ Nx Cloud Report

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

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 4 targets

Sent with 💌 from NxCloud.

Copy link

codeclimate bot commented Mar 11, 2024

Code Climate has analyzed commit 25a5a4d and detected 3 issues on this pull request.

Here's the issue category breakdown:

Category Count
Complexity 1
Duplication 2

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

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

View more on Code Climate.

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.

2 participants