Deprecate & discontinue package

Question

Deprecate & discontinue package

Closed this issue 4 years ago · 18 comments

mit-mit commented 5 years ago

With support for creating projects with dart create, we should deprecate this package:

Prep work:

Update Dart IntelliJ to call dart create
Update VS Code to call dart create
Move the templates from here to https://github.com/dart-lang/sdk/tree/master/pkg/dartdev
Change dart create to use the template directory, and remove dependency on stagehand

Finalization work:

Add deprecation warning to the output of the present command
Mark this package discontinued on pub
Move this repo to the dart archive

Answer 1 · 2021-03-24T18:24:26.000Z

An update - I believe that the dart create functionality has existed since Dart 2.10. We should confirm the version, but in any case IDEs can now move over to using dart create in preference to pub global activate stagehand after they've done an min. SDK version check.

Answer 2 · 2021-03-24T18:25:23.000Z

@jwren - can you create a tracking issue for the Dart IntelliJ plugin?

@DanTup - similarly for VS Code; thanks!

Answer 3 · 2021-03-24T19:03:52.000Z

@devoncarew @mit-mit is there an existing way we can get the template list in a parsable format? Right now we're using pub global run stagehand --machine which gives us JSON and we use to populate the selection of templates.

Answer 4 · 2021-03-24T19:06:20.000Z

dart create --list-templates :)

Answer 5 · 2021-03-29T13:19:29.000Z

I've gated this on SDK version 2.13.0-0. Please let me know if that's not correct and I should change it.

I presume the deprecation notices being printed here won't apply to --machine, so we'll still get clean JSON for people on <= v2.12 SDKs?

Answer 6 · 2021-03-29T15:08:21.000Z

Thanks!

I've gated this on SDK version 2.13.0-0. Please let me know if that's not correct and I should change it.

I think all the support we need in the dart command has existed since 2.10.0.

Answer 7 · 2021-03-29T15:22:38.000Z

I think all the support we need in the dart command has existed since 2.10.0.

Yup, I'm pretty sure too: https://medium.com/dartlang/announcing-dart-2-10-350823952bd5

Answer 8 · 2021-03-29T16:04:56.000Z

Ah, great! I misunderstood from the action about moving templates here and Devon's recent commit that all the templates weren't here, but I see now they were just previously being read out of out the Stagehand project. I'll lower the check to 2.10 and will merge into the upcoming Dart-Code release then. Thanks!

Answer 9 · 2021-03-30T00:12:57.000Z

wrt Add deprecation warning to the output of the present command (from above), we'll want to make sure to not emit that when the --machine flag is passed, as IDE parse the output of that command (or, perhaps do something like emit the deprecation message to stderr - IDEs parse stdout).

@bkonyi - once the IDE work is complete and we've shipped releases that call out to dart create - can you drive the remaining portions of this issue?

Answer 10 · 2021-03-30T18:23:58.000Z

The YouTrack issue is at https://youtrack.jetbrains.com/issue/WEB-45841. Alex or myself will take care of it soon.

Answer 11 · 2021-03-30T18:45:32.000Z

@bkonyi - once the IDE work is complete and we've shipped releases that call out to dart create - can you drive the remaining portions of this issue?

@devoncarew sure, sounds good to me.

Answer 12 · 2021-03-31T12:10:48.000Z

Hi, I'm updating the Dart plugin for IntelliJ IDEA to use dart create instead of stagehand and I have a couple of questions.

Both stagehand and dart create name the project after the folder name. But stagehand normalizes the name to make sure that it's a valid Dart identifier. Do you think dart create should do the same? Example: run stagehand in foo-bar folder, it will write name: foo_bar to the pubspec.
Assume I've created an empty folder, switched to it and run dart create --force .; the tool generates name: . in the pubspec.yaml. Wouldn't it be more intuitive to take the project name from the enclosing folder (normalized as per previous comment)?

Answer 13 · 2021-03-31T12:21:14.000Z

I hit the same issue using --force . in VS Code. I thought I was just doing things strangely (we create the folder up-front because of how we trigger running the command in the new workspace after opening it), so I changed it to execute in the parent folder and then use the foldername instead of ..

I think it'd be good to support ., but even if it's changed now, for compatibility with SDKs v2.10 - v2.12 I think you'd need to avoid the . anyway.

Answer 14 · 2021-04-01T20:29:09.000Z

This CL should address the dart create --force . case and also prevent users from creating projects with invalid package names (also see dart-lang/sdk#43216).

Answer 15 · 2021-04-01T22:15:05.000Z

address the dart create --force . case

Thanks!

prevent users from creating projects with invalid package names

As I understand, it prints an error message and exits. IntelliJ's project wizard doesn't have any restrictions regarding project folder naming, so this will result in an empty project instead of a Dart project template.

Will you consider normalizing project name instead of failing (this was the behavior of stagehand)?

Alternatively, can there be a flag for the project name, so that the folder name doesn't matter at all?

Answer 16 · 2021-04-01T22:50:32.000Z

prevent users from creating projects with invalid package names

As I understand, it prints an error message and exits. IntelliJ's project wizard doesn't have any restrictions regarding project folder naming, so this will result in an empty project instead of a Dart project template.

Will you consider normalizing project name instead of failing (this was the behavior of stagehand)?

Ah sorry, I missed that bit. I've updated the CL to perform the same normalization as stagehand (e.g.,- to _ and foo.dart to foo).

Answer 17 · 2021-04-29T15:43:46.000Z

@bkonyi - the IntelliJ work has now landed. I think we can start on the next stage of deprecation (the other steps above). I'm not sure of the best timing for that; perhaps sometime after we release the next stable (give people and tools time to update to the latest versions)?

Answer 18 · 2021-05-02T22:04:25.000Z

dart create drops some templates like web-angular, which would be really nice if we can still have those options