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: remove public-api files to reduce import possibilities #412

Conversation

davidlj95
Copy link
Owner

Proposed changes

Removes a chance from importing from public-api.ts whilst we solve Typescript definitions rollup (see #411)

Uses index.ts as ng-packagr entry point instead, which will be used for Typescript path mappings too. A file less to maintain indeed.

And given we were not separating from public / internal APIs in there, it wasn't really used. So was there to follow the convention mostly

Quick reminders

  • 🤝 I will follow Code of Conduct
  • No existing pull request already does almost same changes
  • 👁️ Contributing docs are something I've taken a look at
  • 📝 Commit messages convention has been followed
  • 💬 TSDoc comments have been added or updated indicating API visibility if API surface has changed.
  • 🧪 Tests have been added if needed. For instance, if adding new features or fixing a bug. Or removed if removing features.
  • ⚙️ API Report has been updated if API surface is altered.

Copy link
Owner Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @davidlj95 and the rest of your teammates on Graphite Graphite

@@ -2,7 +2,6 @@
"$schema": "../../../node_modules/ng-packagr/ng-package.schema.json",
"dest": "../dist",
"lib": {
"entryFile": "public-api.ts"
},
"assets": ["tsdoc-metadata.json"]
Copy link
Owner Author

Choose a reason for hiding this comment

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

whooops, this was a leftover from when trying to publish that file

@davidlj95 davidlj95 enabled auto-merge (squash) March 8, 2024 19:10
@davidlj95 davidlj95 merged commit cb11fc7 into main Mar 8, 2024
11 checks passed
@davidlj95 davidlj95 deleted the stacked/fix-remove-public-api-files-to-reduce-import-possibilities branch March 8, 2024 19:11
Copy link

github-actions bot commented Mar 8, 2024

📦 Bundle size (Angular v16)

Git ref: 137e64c1b3400f4c47493fb3717a95f2e519f298

Module file Size Base size Difference
ngx-meta-core.mjs 3460 bytes (3.4KiB) Not available Not available
ngx-meta-json-ld.mjs 392 bytes (392B) Not available Not available
ngx-meta-open-graph.mjs 1227 bytes (1.2KiB) Not available Not available
ngx-meta-routing.mjs 1015 bytes (1015B) Not available Not available
ngx-meta-standard.mjs 885 bytes (885B) Not available Not available
ngx-meta-twitter-card.mjs 648 bytes (648B) Not available Not available
Total 7627 bytes (7.5KiB) Not available Not available

Base size data is not available yet. Try again when the CI/CD has finished running on main branch

Copy link

github-actions bot commented Mar 8, 2024

📦 Bundle size (Angular v17)

Git ref: 137e64c1b3400f4c47493fb3717a95f2e519f298

Module file Size Base size Difference
ngx-meta-core.mjs 3048 bytes (3.0KiB) Not available Not available
ngx-meta-json-ld.mjs 226 bytes (226B) Not available Not available
ngx-meta-open-graph.mjs 888 bytes (888B) Not available Not available
ngx-meta-routing.mjs 839 bytes (839B) Not available Not available
ngx-meta-standard.mjs 768 bytes (768B) Not available Not available
ngx-meta-twitter-card.mjs 488 bytes (488B) Not available Not available
Total 6257 bytes (6.2KiB) Not available Not available

Base size data is not available yet. Try again when the CI/CD has finished running on main branch

Copy link

github-actions bot commented Mar 8, 2024

📦 Bundle size (Angular v15)

Git ref: 137e64c1b3400f4c47493fb3717a95f2e519f298

Module file Size Base size Difference
ngx-meta-core.mjs 3460 bytes (3.4KiB) Not available Not available
ngx-meta-json-ld.mjs 392 bytes (392B) Not available Not available
ngx-meta-open-graph.mjs 1227 bytes (1.2KiB) Not available Not available
ngx-meta-routing.mjs 1015 bytes (1015B) Not available Not available
ngx-meta-standard.mjs 885 bytes (885B) Not available Not available
ngx-meta-twitter-card.mjs 648 bytes (648B) Not available Not available
Total 7627 bytes (7.5KiB) Not available Not available

Base size data is not available yet. Try again when the CI/CD has finished running on main branch

@davidlj95 davidlj95 linked an issue Mar 8, 2024 that may be closed by this pull request
1 task
Copy link

github-actions bot commented Mar 8, 2024

🎉 This PR is included in version 1.0.0-alpha.46 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Multiple imports are suggested, just one is the recommended
1 participant