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

docs: document exclude_types_from_npm_packages as deprecated #2014

Merged
merged 1 commit into from
Nov 7, 2024

Conversation

jbedard
Copy link
Member

@jbedard jbedard commented Nov 7, 2024

With js_library always being recommended I think npm_package should be used almost exclusively for creating packages ready to be published and not for use as a runtime/type-checking dependency within the workspace.

The only remaining use case I can see for using npm_package instead of js_library would be to properly test a package in the same state it would be published. In that case this flag may still be useful, but is it worth maintaining for that use case?


Changes are visible to end-users: yes

  • Searched for relevant documentation and updated as needed: yes
  • Breaking change (forces users to change their own code or config): no
  • Suggested release notes appear below: yes

Deprecate --@aspect_rules_js//npm:exclude_types_from_npm_packages.

Test plan

  • Covered by existing test cases

Copy link

aspect-workflows bot commented Nov 7, 2024

Test

1 test target passed

Targets
//docs:update_6_test [k8-fastbuild]                 39ms

Total test execution time was 39ms. 202 tests (99.5%) were fully cached saving 35s.


Test

e2e/bzlmod

All tests were cache hits

5 tests (100.0%) were fully cached saving 857ms.


Test

e2e/gyp_no_install_script

All tests were cache hits

2 tests (100.0%) were fully cached saving 503ms.


Test

e2e/js_image_oci

All tests were cache hits

1 test (100.0%) was fully cached saving 7s.


Test

e2e/npm_link_package

All tests were cache hits

3 tests (100.0%) were fully cached saving 820ms.


Test

e2e/npm_link_package-esm

All tests were cache hits

3 tests (100.0%) were fully cached saving 1s.


Test

e2e/npm_translate_lock

All tests were cache hits

1 test (100.0%) was fully cached saving 34ms.


Test

e2e/npm_translate_lock_empty

All tests were cache hits

1 test (100.0%) was fully cached saving 34ms.


Test

e2e/npm_translate_lock_multi

All tests were cache hits

2 tests (100.0%) were fully cached saving 171ms.


Test

e2e/npm_translate_lock_partial_clone

All tests were cache hits

1 test (100.0%) was fully cached saving 129ms.


Test

e2e/npm_translate_lock_replace_packages

All tests were cache hits

3 tests (100.0%) were fully cached saving 503ms.


Test

e2e/npm_translate_lock_subdir_patch

All tests were cache hits

1 test (100.0%) was fully cached saving 222ms.


Test

e2e/npm_translate_package_lock

All tests were cache hits

1 test (100.0%) was fully cached saving 131ms.


Test

e2e/npm_translate_yarn_lock

All tests were cache hits

1 test (100.0%) was fully cached saving 131ms.


Test

e2e/package_json_module

All tests were cache hits

1 test (100.0%) was fully cached saving 590ms.


Test

e2e/pnpm_lockfiles

All tests were cache hits

40 tests (100.0%) were fully cached saving 3s.


Test

e2e/pnpm_workspace

All tests were cache hits

10 tests (100.0%) were fully cached saving 3s.


Test

e2e/pnpm_workspace_rerooted

All tests were cache hits

12 tests (100.0%) were fully cached saving 2s.


Test

e2e/repo_mapping

All tests were cache hits

2 tests (100.0%) were fully cached saving 474ms.


Test

e2e/rules_foo

All tests were cache hits

2 tests (100.0%) were fully cached saving 470ms.


Test

e2e/runfiles

All tests were cache hits

1 test (100.0%) was fully cached saving 443ms.


Test

e2e/vendored_node

All tests were cache hits

1 test (100.0%) was fully cached saving 199ms.


Buildifier      Format

@alexeagle
Copy link
Member

Need a TODO(3.0) so we remember to do the removal

@jbedard
Copy link
Member Author

jbedard commented Nov 7, 2024

I've added the TODO where the flag is defined, it's also listed in #1993

@jbedard jbedard enabled auto-merge (rebase) November 7, 2024 22:04
@jbedard jbedard merged commit a3506e7 into aspect-build:main Nov 7, 2024
90 of 93 checks passed
@jbedard jbedard deleted the dep-rm-exclude-types branch November 9, 2024 04:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants