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.

Sign up for GitHub

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

Jump to bottom

[breaking change]: Deprecation and discontinuation of standalone Dart tools #46100

Closed
mit-mit opened this issue May 21, 2021 · 18 comments
Closed

[breaking change]: Deprecation and discontinuation of standalone Dart tools #46100

mit-mit opened this issue May 21, 2021 · 18 comments
Assignees
@bkonyi
Labels
area-dart-cli Use area-dart-cli for issues related to the 'dart' command like tool. area-meta Cross-cutting, high-level issues (for tracking many other implementation issues, ...). enhancement-breaking-change An enhancement which is breaking.
Milestone
August Release (D...

Comments

@mit-mit
Copy link
Member

mit-mit commented May 21, 2021 •
edited

Background

Historically the Dart team has offered a number of smaller developer tools for things like formatting code (dartfmt), analyzing code (dartanalyzer), etc. In Dart 2.10 (October 2020) we introduced a new unified Dart developer tool, the dart tool.

Intended change

As we discussed at launch in the blog post, we plan to first deprecate and then discontinue the smaller tools in favor of the new combined tool. The this meta-bug presents an overview of the status of this migration. As this is considered breaking, it will happen in a staged fashion over time, when each individual tool first becoming deprecated in one stable release (here it will still exist but print a warning), and then fully discontinued (here it will no longer be in the SDK).

Historical tool dart replacement Deprecation Discontinuation
stagehand dart create 2.14 ✅ 2.14*
dartfmt dart format 2.14 ✅ 2.15
dart2native dart compile exe 2.14 ✅ 2.15
dart2js dart compile js 2.17 ✅ 2.18
dartdevc none 2.17 ✅ 2.18
dartanalyzer & package:analyzer_cli dart analyze 2.16 ✅ 2.18
dartdoc dart doc 2.16 ✅ 2.17
pub dart pub 2.15 ✅ 2.17

Notes:

  • We currently have no plans to deprecate dartaotruntime.
  • stagehand will go directly to discontinuation as it's a pub global tool on pub.dev, and not a SDK distributed tool like the rest. This means it can still be invoked (with dart pub global run stagehand) even after it's been discontinued.
  • dartdevc will be discontinued as a publicly visible tool. The tool was never intended or supported as a stable command line tool for end users. The underlying binary for this compiler will still be shipped with the SDK to be used by build systems tools (such as bazel, webdev, and flutter_tools). However, it will no longer be exposed to be used by developers directly on the command line.

Rationale

With the new unified tool the existing tools are no longer needed. To reduce maintenance, remove confusion for new users, and to ensure we offer a single high-quality toolset the old commands are being removed.

Should you have any issues with missing functionality in the new dart-based tools, please file an issue.

Migration

To migrate, switch to using the dart tool, and the subcommands listed in the above table.
@mit-mit mit-mit added area-meta Cross-cutting, high-level issues (for tracking many other implementation issues, ...). enhancement-breaking-change An enhancement which is breaking. labels May 21, 2021
@devoncarew devoncarew added the area-dart-cli Use area-dart-cli for issues related to the 'dart' command like tool. label May 21, 2021
@lrhn lrhn mentioned this issue May 22, 2021
Closed
@cpswan cpswan mentioned this issue May 24, 2021
Closed
dart-bot pushed a commit that referenced this issue May 25, 2021
@mit-mit
Add deprecations notices to dart2native
cac00e9 
Related to: #46100

Change-Id: I2bcd4aadfbc96fa6ba265aec04cd60e3e81eef41
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/199429
Commit-Queue: Michael Thomsen <mit@google.com>
Reviewed-by: Martin Kustermann <kustermann@google.com>
Reviewed-by: Ben Konyi <bkonyi@google.com>
Reviewed-by: Devon Carew <devoncarew@google.com>
@mit-mit mit-mit changed the title Deprecation and discontinuation of standalone Dart tools Breaking change: Deprecation and discontinuation of standalone Dart tools May 25, 2021
@jonahwilliams
Copy link
Contributor

jonahwilliams commented Jun 2, 2021 •
edited

I can begin switching the flutter usages of the tools with specified deprecation dates. For some of these, it seems like there is still a significant gap in functionality (analysis server usage with dart analyze, or the various compile options for dart2js). Is there a plan to resolve this before announcing deprecation dates?

@jonahwilliams jonahwilliams mentioned this issue Jun 2, 2021
Open
@sigmundch
Copy link
Member

... significant gap in functionality (... various compile options for dart2js)

I can at least speak for the dart2js side, yes. We will ensure there isn't any gap in our case. It's very likely that we'll even preserve all existing flags, but we'll confirm once the plan is finalized.

@mit-mit
Copy link
Member Author

mit-mit commented Jun 3, 2021

The items marked as deprecated in 2.14 in the table are considered "feature complete" and we're not aware of any things missing from them.

For dart analyze it's fairly complete, and we'd like to hear more input on what might be missing. We've migrated a bunch of uses of dartanalyzer in various Dart repos already.

@kleinpetr
Copy link

what is the replacement for the web-angular which is in now in stagehand?

@aadarshadhakalg
Copy link

aadarshadhakalg commented Jun 3, 2021 •
edited

As angular-dart is also being discontinued, most probably dart create will not include web-angular template. But Is the google team planning to release a separate CLI tool for angular-dart or there are other existing alternatives?

Update: I found one https://pub.dev/packages/ngdart

@mit-mit
Copy link
Member Author

mit-mit commented Jun 3, 2021

stagehand will continue to work as today; it just won't see any future work -- so that can still be used to create web-angular projects.

@jonahwilliams
Copy link
Contributor

@mit-mit I'm thinking of functionality like the lsp mode that the analysis server supports, unless that snapshot won't be removed.

@bkonyi
Copy link
Contributor

bkonyi commented Jun 3, 2021

The analysis server snapshot won't be going anywhere any time soon since we don't have a replacement for it in the CLI.

@jonahwilliams
Copy link
Contributor

ack, I actually forgot about dartanalyzer, but that one makes more sense 😅

@munificent
Copy link
Member

As of this CL, dartfmt is now printing a deprecation notice.

@mit-mit mit-mit mentioned this issue Jun 9, 2021
Closed
This was referenced Jul 25, 2021
Closed
Merged
@mit-mit mit-mit mentioned this issue Aug 5, 2021
Closed
@DanTup DanTup mentioned this issue Aug 30, 2021
Closed
@sensuikan1973 sensuikan1973 mentioned this issue Sep 16, 2021
Merged
This was referenced Nov 20, 2021
Merged
Closed
@mit-mit mit-mit mentioned this issue Nov 24, 2021
Merged
This was referenced Jan 17, 2022
Closed
Closed
@JamesMcIntosh JamesMcIntosh mentioned this issue Jan 22, 2022
Closed
This was referenced Apr 23, 2022
Merged
Merged
Merged
Merged
This was referenced May 10, 2022
Merged
Merged
Closed
Merged
Merged
Closed
Merged
@simolus3
Copy link
Contributor

I'm currently using the options --rel-canonical-prefix and --link-to-source-revision when invoking dartdoc. dart doc doesn't appear to accept those options, what's the replacement for them?

To anyone else also stumbling across this, my solution was to add a dev_dependency on dartdoc and then use dart run dartdoc instead of the more limited dart doc command.

@cpswan cpswan mentioned this issue May 23, 2022
Closed
@devoncarew
Copy link
Member

@simolus3 - can you open an issue against https://github.com/dart-lang/dartdoc for the dartdoc CLI flags you're missing? And, have you tried configuring dartdoc via the dartdoc_options.yaml file (https://github.com/dart-lang/dartdoc#dartdoc_optionsyaml)? That allows you to tweak more parameters than are available through dart doc.

copybara-service bot pushed a commit that referenced this issue Jun 14, 2022
@sigmundch
[web] remove top-level scripts for dartdevc and dart2js.
69249df 
This completes the breaking change that was previously announced in
#46100

Change-Id: Ie81665e7932fe00a8c1fee9f67ee8294cd4c89e9
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/248342
Reviewed-by: Joshua Litt <joshualitt@google.com>
Commit-Queue: Sigmund Cherem <sigmund@google.com>
Reviewed-by: Nicholas Shahan <nshahan@google.com>
@mit-mit mit-mit changed the title Breaking change: Deprecation and discontinuation of standalone Dart tools [breaking change]: Deprecation and discontinuation of standalone Dart tools Jun 20, 2022
@jakemac53
Copy link
Contributor

jakemac53 commented Jul 15, 2022 •
edited

We recently had dart-lang/build#3337 filed on package:build, I was wondering if I can get some clarification here, as currently package:build_web_compilers uses both dart2js and dartdevc, although it runs them by using their snapshot directly.

Will it be safe to continue using these snapshots in perpetuity, or is there a plan to delete them? If we do delete them, how should we invoke DDC?

It does look like for dart2js I can run dart compile js directly, so I will try to make that change and see if anything fails (biggest risk is probably command line options being the same, we allow users to pass arbitrary dart2js options).

@sigmundch
Copy link
Member

@jakemac53 - yes, the goal is still to support their use from build_web_compilers. For now we intend to keep the snapshots, but there have been discussions about combining the snapshots into the CLI snapshot sometime in the future (but that's not a short term goal).

To avoid the warning, using dart compile js will work (that will also be safe in the future if dart2js gets merged into the Dart CLI). Alternatively, we can also pass a special flag to the dart2js snapshot to indicate that you are one of the use cases we support (that was our intended design at first).

As for DDC, the snapshot will remain available for foreseeable future. Note that DDC should not give you a warning if you are using the snapshot (only the shell script does today).

@jakemac53 jakemac53 mentioned this issue Jul 15, 2022
Merged
@jakemac53
Copy link
Contributor

Thanks, I will go ahead and land the change to use dart compile js and leave the rest as is for now. So you should be unblocked soon to merge the snapshot with the CLI snapshot when you are able, that should probably help sdk size a fair bit :).

@mit-mit
Copy link
Member Author

mit-mit commented Jul 18, 2022

These discontinuations are now complete, and the current dev channel build (2.18.0-271.0.dev) and upcoming stable build (2.18.0) have just the following in bin:

-rwxr-xr-x@  1 mit  primarygroup  38802064 Jul 12 13:28 dart
-rwxr-xr-x@  1 mit  primarygroup   4050496 Jul 12 13:28 dartaotruntime
drwxr-xr-x@  4 mit  primarygroup       128 Jul 12 13:28 resources
drwxr-xr-x@ 12 mit  primarygroup       384 Jul 12 13:28 snapshots
drwxr-xr-x@  3 mit  primarygroup        96 Jul 12 13:28 utils

@mit-mit mit-mit closed this as completed Jul 18, 2022
Cir0X added a commit to Cir0X/nix-dart that referenced this issue Jul 26, 2022
@Cir0X
use dart pub instead of standalone pub executable
044ad62 
dart-lang/sdk#46100
@mit-mit mit-mit added this to the August Release (Dart 2.18) milestone Sep 7, 2022
pbo-linaro pushed a commit to pbo-linaro/flutter-recipes that referenced this issue Nov 24, 2022
@sigurdm
Use dart pub instead of pub in scripts
081df10 
Context: The pub top-level command is going away.
dart-lang/sdk#46100

https://dart-review.googlesource.com/c/sdk/+/232131
flutter/engine#31332

Change-Id: Ib8be79bf6450142d250e74971a17ba6ba1a7313a
Bug: flutter/flutter#98060
Reviewed-on: https://flutter-review.googlesource.com/c/recipes/+/26720
Reviewed-by: Godofredo Contreras <godofredoc@google.com>
Commit-Queue: Sigurd Meldgaard <sigurdm@google.com>
@errnesto errnesto mentioned this issue Dec 9, 2022
Merged
@mit-mit mit-mit mentioned this issue Dec 13, 2022
Closed
16 tasks
This was referenced Mar 9, 2023
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bkonyi bkonyi

Labels
area-dart-cli Use area-dart-cli for issues related to the 'dart' command like tool. area-meta Cross-cutting, high-level issues (for tracking many other implementation issues, ...). enhancement-breaking-change An enhancement which is breaking.
Projects
None yet
Milestone
August Release (Dart 2.18)
Development

No branches or pull requests